.\" -*- 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 "VariableIndex 3pm"
.TH VariableIndex 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::Config::VariableIndex \- Index of the available variables in a TableInfo
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&  <lrcsml:reference name="name" index="categorical_variables" />
\&  <lrcsml:reference name="name" index="numerical_variables" />
\&  <lrcsml:reference name="name" index="variables" />
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This object make it possible to select a variable defined in a
TableInfo (usually created from a Lire::ReportSpec or coming from a
Lire::Report object).
.ie n .SS "new( $table_info, [ $type ] )"
.el .SS "new( \f(CW$table_info\fP, [ \f(CW$type\fP ] )"
.IX Subsection "new( $table_info, [ $type ] )"
Creates a new VariableIndex which wraps the \f(CW$table_info\fR
Lire::Report::TableInfo object. The \f(CW$type\fR parameter can be either
\&\*(Aqboth\*(Aq, \*(Aqcategorical\*(Aq or \*(Aqnumerical\*(Aq depending on the kind of
variables one wants to select. Default to \*(Aqboth\*(Aq.
.SS \fBtable_info()\fP
.IX Subsection "table_info()"
Returns the Lire::Report::TableInfo object wrapped by this Index.
.SS \fBtype()\fP
.IX Subsection "type()"
Returns the type attribute.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 1
\& Lire::ReportSpec(3pm) Lire::Report::TableInfo(3pm) Lire:Config::Index(3pm)
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\&  Francis J. Lacoste <flacoste@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR VariableIndex.pm,v 1.3 2006/07/23 13:16:31 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 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.