.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" 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 >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 .\" .\" 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 "2018-12-20" "perl v5.28.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 is re-used to generate the documentation of your configuration class. You can use pod markup to format your description. See perlpod for details. \fI Optional. Type string. \fR .SS "license" .IX Subsection "license" \&\fI Optional. Type string. \fR .SS "gist" .IX Subsection "gist" String used to construct a summary of the content of a node. This parameter is used by user interface to show users the gist of the content of this node. This parameter has no other effect. This string may contain element values in the form "\f(CW\*(C`{foo} or {bar}\*(C'\fR". When constructing the gist, \f(CW\*(C`{foo}\*(C'\fR is replaced by the value of element \f(CW\*(C`foo\*(C'\fR. Likewise for \f(CW\*(C`{bar}\*(C'\fR. \fI Optional. Type string. \fR .SS "author" .IX Subsection "author" \&\fI Optional. Type list of uniline. \fR .SS "copyright" .IX Subsection "copyright" \&\fI Optional. Type list of uniline. \fR .SS "class \- Override implementation of configuration node" .IX Subsection "class - Override implementation of configuration node" Perl class name used to override the default implementation of a configuration node. This Perl class must inherit Config::Model::Node. Use with care. \fI Optional. Type uniline. \fR .SS "element" .IX Subsection "element" Specify the elements names of this configuration class. \fI Optional. Type hash of node of class Itself::Element . \fR .SS "include" .IX Subsection "include" Include the element description of another class into this class. \fI Optional. Type list of reference. \fR .SS "include_backend" .IX Subsection "include_backend" Include the read/write specification of another class into this class. \fI Optional. Type list of reference. \fR .SS "include_after" .IX Subsection "include_after" insert the included elements after a specific element. By default, included elements are placed before all other elements. \fI Optional. Type reference. \fR .SS "generated_by" .IX Subsection "generated_by" When set, this class was generated by some program. You should not edit this class as your modifications may be clobbered later on when the class is regenerated. \fI Optional. Type uniline. \fR .SS "rw_config" .IX Subsection "rw_config" Specify the backend used to read and write configuration data. See Config::Model::BackendMgr for details. \fI Optional. Type node of class Itself::ConfigReadWrite . \fR .SS "accept" .IX Subsection "accept" Specifies names of the elements this configuration class accepts as valid. The key of the hash is a regular expression that are 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 name of the potential parameter. I.e. the specified regexp is eval'ed with a leading \f(CW\*(C`^\*(C'\fR and a trailing \f(CW\*(C`$\*(C'\fR. \fI Optional. 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::ConfigReadWrite .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"