.\" -*- 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 "Param 3pm"
.TH Param 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::Param \- Object which represents a parameter in a XML specification.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Lire::Param are objects which represent parameters in an XML
specification. The object is used to represent the parameter\*(Aqs
specification as well as its current value.
.ie n .SS "new( \*(Aqname\*(Aq => $name, \*(Aqtype\*(Aq => $type, [ \*(Aqdefault\*(Aq => $default ] )"
.el .SS "new( \*(Aqname\*(Aq => \f(CW$name\fP, \*(Aqtype\*(Aq => \f(CW$type\fP, [ \*(Aqdefault\*(Aq => \f(CW$default\fP ] )"
.IX Subsection "new( 'name' => $name, 'type' => $type, [ 'default' => $default ] )"
Creates a new Lire::Param object.
.SS \fBname()\fP
.IX Subsection "name()"
Returns the name of this parameter.
.SS \fBtype()\fP
.IX Subsection "type()"
Returns this parameter\*(Aqs type.
.ie n .SS "value( [ $new_value ] )"
.el .SS "value( [ \f(CW$new_value\fP ] )"
.IX Subsection "value( [ $new_value ] )"
Returns (and optionnally modifies) the current value for this
parameter. If no value was set, but a default is available, the
default value will be returned.
.ie n .SS "default( [ $new_default ] )"
.el .SS "default( [ \f(CW$new_default\fP ] )"
.IX Subsection "default( [ $new_default ] )"
Returns (and optionnally changes) the parameter\*(Aqs default value.
.ie n .SS "description( [ $new_description ] )"
.el .SS "description( [ \f(CW$new_description\fP ] )"
.IX Subsection "description( [ $new_description ] )"
Returns (and optionnally changes) the current parameter\*(Aqs description.
.SS \fBas_type_spec()\fP
.IX Subsection "as_type_spec()"
Returns a Lire::Config::TypeSpec object which adequately represents the
current parameter.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 1
\&  Lire::Config::TypeSpec(3pm), Lire::XMLSpecContainer(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 Param.pm,v 1.13 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.