.\" -*- 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 "GroupField 3pm"
.TH GroupField 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::GroupField \- Class that implements the field element in report specifications.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Lire::GroupField;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module is used to represent the field elements that appears in
the group aggregator element in report specifications.
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
.ie n .SS "new( %params )"
.el .SS "new( \f(CW%params\fP )"
.IX Subsection "new( %params )"
Creates a new Lire::GroupField object. It takes several parameters
similar to Lire::ReportOperator.
.IP name 4
.IX Item "name"
The DLF field\*(Aqs name that this GroupField represents. This shouldn\*(Aqt
be quantity or time field (other aggregators should be used for
these).
.IP report_spec 4
.IX Item "report_spec"
The report specification in which this the group field is added.
.IP label 4
.IX Item "label"
The column\*(Aqs label that should be used for this field.
.SS \fBname()\fP
.IX Subsection "name()"
Returns the DLF field name which we represent.
.SS "label( [$new_label] )"
.IX Subsection "label( [$new_label] )"
Returns the label that should be used for the column we generate in
the report. Default is to use the DLF field\*(Aqs label.
.PP
It can be changed by passing a \f(CW$new_label\fR parameter.
.SS \fBfield()\fP
.IX Subsection "field()"
Returns the DLF field which we represents as Lire::Field object.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::Group\fR\|(3pm)
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 2
\&  Francis J. Lacoste <flacoste@logreport.org>
\&  Wolfgang Sourdeau <wolfgang@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR GroupField.pm,v 1.19 2006/07/23 13:16:29 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2001\-2004 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.