.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" 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" '' . 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 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. .\" .\" 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 .\" .\" 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 "Config::Model::models::Itself::Class 3pm" .TH Config::Model::models::Itself::Class 3pm "2014-10-23" "perl v5.20.1" "User Contributed Perl 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" Config::Model::models::Itself::Class \- Configuration class Itself::Class .SH "DESCRIPTION" .IX Header "DESCRIPTION" Configuration classes used by Config::Model .PP Configuration class. This class represents a node of a configuration tree. .SH "Elements" .IX Header "Elements" .SS "class_description" .IX Subsection "class_description" Explain the purpose of this configuration class. This description will be re-used to generate the documentation of your configuration class. You can use pod markup to format your description. See perlpod for details.\fIOptional. Type string.\fR .SS "license" .IX Subsection "license" \&\fIOptional. Type string.\fR .SS "author" .IX Subsection "author" \&\fIOptional. Type list of uniline.\fR .SS "copyright" .IX Subsection "copyright" \&\fIOptional. Type list of uniline.\fR .SS "element" .IX Subsection "element" Specify the elements names of this configuration class.\fIOptional. Type hash of node of class Itself::Element .\fR .SS "include" .IX Subsection "include" Include the specification of another class into this class.\fIOptional. Type list of reference.\fR .SS "include_after" .IX Subsection "include_after" insert the included elements after a specific element. \fIOptional. Type reference.\fR .SS "generated_by" .IX Subsection "generated_by" When set, this class was generated by some program. You should not edit it as your modification may be clobbered later on. \fIOptional. Type uniline.\fR .SS "read_config" .IX Subsection "read_config" Specify the Perl class(es) and function(s) used to read configuration data. The specified function will be tried in sequence to get configuration data. \fIOptional. Type list of node of class Itself::ConfigRead .\fR .SS "write_config" .IX Subsection "write_config" Specify the Perl class and function used to write configuration data.\fIOptional. Type list of node of class Itself::ConfigWrite .\fR .SS "accept" .IX Subsection "accept" Specifies names of the elements this configuration class will accept as valid. The key of the hash is a regular expression that will be tested against candidate parameters. When the parameter matches the regular expression, a new parameter is created in the model using the description provided in the value of this hash key. Note that the regexp must match the whole candidate parameter name. I.e. the specified regexp will be eval'ed with a leading ^ and a trailing $.\fIOptional. Type hash of node of class Itself::ConfigAccept .\fR .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "\(bu" 4 cme .IP "\(bu" 4 Config::Model::models::Itself::ConfigAccept .IP "\(bu" 4 Config::Model::models::Itself::ConfigRead .IP "\(bu" 4 Config::Model::models::Itself::ConfigWrite .IP "\(bu" 4 Config::Model::models::Itself::Element .SH "AUTHOR" .IX Header "AUTHOR" .IP "Dominique Dumont" 4 .IX Item "Dominique Dumont" .SH "COPYRIGHT" .IX Header "COPYRIGHT" .PD 0 .IP "2007\-2011 Dominique Dumont." 4 .IX Item "2007-2011 Dominique Dumont." .PD .SH "LICENSE" .IX Header "LICENSE" .IP "\s-1LGPL\-2\s0" 4 .IX Item "LGPL-2"