.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.14) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Group 3pm" .TH Group 3pm "2006-07-23" "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 \fIcreate_group()\fR method on one Lire::Report::Entry object. .SH "OBJECT METHODS" .IX Header "OBJECT METHODS" .SS "\fIparent_entry()\fP" .IX Subsection "parent_entry()" Returns the entry in which this goup is contained. This will be undef for the Subreport since it's not contained in any entry. .SS "\fIgroup_info()\fP" .IX Subsection "group_info()" Returns the Lire::Report::GroupInfo which contains the information describing the entries of this group. .SS "\fIsubreport()\fP" .IX Subsection "subreport()" Returns the Lire::Report::Subreport object in which this entry is .SS "\fIrow_idx()\fP" .IX Subsection "row_idx()" Returns the row index in the table body where this group's summary should be displayed. If undef, this group isn't 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's show parameter will be set to this new value. .SS "nrecords( [$n] )" .IX Subsection "nrecords( [$n] )" Returns the number of \s-1DLF\s0 records that were included in this group. .SS "missing_cases( [$n] )" .IX Subsection "missing_cases( [$n] )" Returns the number of \s-1DLF\s0 records that contained missing cases which prevent them from being unclude in the subreport. .SS "\fIsummary_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 \fIvalues()\fR method described in \&\fILire::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 \fIvalues()\fR method described in \&\fILire::Report::Entry\fR\|(3pm). Returns undef if the summary value wasn't 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 \s-1DLF\s0 records of the group. Consult the \fIadd_value()\fR method in \&\fILire::Report::Entry\fR\|(3pm) for information on the parameters. .SS "\fIentries()\fP" .IX Subsection "entries()" Returns the entries in the group. .SS "\fIcreate_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" \&\fILire::ReportParser::ReportBuilder\fR\|(3pm) \fILire::Report\fR\|(3pm) \&\fILire::Report::Subreport\fR\|(3pm) \fILire::Report::Entry\fR\|(3pm) \&\fILire::Report::ChartConfig\fR\|(3pm) \fILire::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 \s-1GNU\s0 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 \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the \&\s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with this program (see \s-1COPYING\s0); if not, check with http://www.gnu.org/copyleft/gpl.html. .SH "AUTHOR" .IX Header "AUTHOR" Francis J. Lacoste