.\" -*- 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 "Timegroup 3pm"
.TH Timegroup 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::Timegroup \- Base class for implementation of the timegroup aggregator
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Lire::Timegroup;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module is the base class for implementation of the timegroup
aggregator. This aggregator will split the DLF records based on a time
period controlled throught the period attribute. For example, using 1d
as the period value, this aggregator will group all records in the
same day period together.
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
.ie n .SS "new( %params )"
.el .SS "new( \f(CW%params\fP )"
.IX Subsection "new( %params )"
Creates a new instance of a timegroup aggregator. In addition to the
normal report operator parameters, the timegroup aggregator can take
several parameters:
.IP field 4
.IX Item "field"
This optional parameter contains the DLF field which contains the time
value used to group the DLF records together. See the \fBfield()\fR method
for more information.
.IP period 4
.IX Item "period"
This mandatory parameter should contains the period\*(Aqs length that will
be used to group the records. See the \fBperiod()\fR method for more
information.
.SH METHODS
.IX Header "METHODS"
.SS "field( [$new_field] )"
.IX Subsection "field( [$new_field] )"
Returns the DLF field\*(Aqs name that is used to group the DLF records.
This should be a valid timestamp DLF field in the current schema. By
default, the default timestamp field of the DLF schema is used.
.PP
You can change the field by passing a \f(CW$new_field\fR parameter.
.SS "period( [$new_period])"
.IX Subsection "period( [$new_period])"
Returns the period\*(Aqs length in which the records are grouped. This can
either be a duration value or the name of a report specification\*(Aqs
parameter containing a duration value.
.PP
The period\*(Aqs length can be changed by using the \f(CW$new_period\fR parameter.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 2
\& Lire::ReportSpec(3pm), Lire::Group(3pm), Lire::ReportOperator(3pm),
\& Lire::Timeslot(3pm)
.Ve
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 2
\&  Francis J. Lacoste <flacoste@logreport.org>
\&  Wolfgang Sourdeau <Wolfgang.Sourdeau@Contre.COM>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR Timegroup.pm,v 1.33 2006/07/23 13:16:30 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.