.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Required to disable full justification in groff 1.23.0. .if n .ds AD l .\" ======================================================================== .\" .IX Title "Group 3pm" .TH Group 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Lire::Report::Group \- Object that include subgroups and other entries. .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 3 \& foreach my $e ( $group\->entries() ) { \& # Process entries\*(Aq data. \& } .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" The Lire::Report::Group object contains entries grouped together in a subreport. .SH CONSTRUCTOR .IX Header "CONSTRUCTOR" You create new Lire::Report::Group object by calling the \fBcreate_group()\fR method on one Lire::Report::Entry object. .SH "OBJECT METHODS" .IX Header "OBJECT METHODS" .SS \fBparent_entry()\fP .IX Subsection "parent_entry()" Returns the entry in which this goup is contained. This will be undef for the Subreport since it\*(Aqs not contained in any entry. .SS \fBgroup_info()\fP .IX Subsection "group_info()" Returns the Lire::Report::GroupInfo which contains the information describing the entries of this group. .SS \fBsubreport()\fP .IX Subsection "subreport()" Returns the Lire::Report::Subreport object in which this entry is .SS \fBrow_idx()\fP .IX Subsection "row_idx()" Returns the row index in the table body where this group\*(Aqs summary should be displayed. If undef, this group isn\*(Aqt displayed. .SS "show( [$show] )" .IX Subsection "show( [$show] )" Returns the number of entries that should be displayed in the formatted report. There may be more entries than that in the group. When this parameter is zero or undefined, all available entries should be displayed. .PP If the \f(CW$show\fR is parameter is set, the group\*(Aqs show parameter will be set to this new value. .SS "nrecords( [$n] )" .IX Subsection "nrecords( [$n] )" Returns the number of DLF records that were included in this group. .SS "missing_cases( [$n] )" .IX Subsection "missing_cases( [$n] )" Returns the number of DLF records that contained missing cases which prevent them from being unclude in the subreport. .SS \fBsummary_values()\fP .IX Subsection "summary_values()" Returns the summary values of this group. This is an array of hash reference like the ones returnes by the \fBvalues()\fR method described in \&\fBLire::Report::Entry\fR\|(3pm). .ie n .SS "get_summary_value( $name )" .el .SS "get_summary_value( \f(CW$name\fP )" .IX Subsection "get_summary_value( $name )" Returns the summary value of the operator \f(CW$name\fR. This is an hash reference like is returned by the \fBvalues()\fR method described in \&\fBLire::Report::Entry\fR\|(3pm). Returns undef if the summary value wasn\*(Aqt computed for operator \f(CW$name\fR. .ie n .SS "set_summary_value( $name, %value )" .el .SS "set_summary_value( \f(CW$name\fP, \f(CW%value\fP )" .IX Subsection "set_summary_value( $name, %value )" Sets the value of the operator \f(CW$name\fR computed over all the DLF records of the group. Consult the \fBadd_value()\fR method in \&\fBLire::Report::Entry\fR\|(3pm) for information on the parameters. .SS \fBentries()\fP .IX Subsection "entries()" Returns the entries in the group. .SS \fBcreate_entry()\fP .IX Subsection "create_entry()" Adds a data entry to this group. This will create a new Lire::Report::Entry object which can then be filled with data. .ie n .SS "find_entry( $name, $dlf )" .el .SS "find_entry( \f(CW$name\fP, \f(CW$dlf\fP )" .IX Subsection "find_entry( $name, $dlf )" .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBLire::ReportParser::ReportBuilder\fR\|(3pm) \fBLire::Report\fR\|(3pm) \&\fBLire::Report::Subreport\fR\|(3pm) \fBLire::Report::Entry\fR\|(3pm) \&\fBLire::Report::ChartConfig\fR\|(3pm) \fBLire::Report::Section\fR\|(3pm) .SH VERSION .IX Header "VERSION" \&\f(CW$Id:\fR Group.pm,v 1.33 2006/07/23 13:16:31 vanbaal Exp $ .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (C) 2002 Stichting LogReport Foundation LogReport@LogReport.org .PP This file is part of Lire. .PP Lire is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. .PP You should have received a copy of the GNU General Public License along with this program (see COPYING); if not, check with http://www.gnu.org/copyleft/gpl.html. .SH AUTHOR .IX Header "AUTHOR" Francis J. Lacoste