/ 
HH-Unispool-Config-0.2
River stage zero No dependents
/ HH::Unispool::Config::File::Token::Numbered::X

NAME

HH::Unispool::Config::File::Token::Numbered::X - X token

SYNOPSIS

Application programmers don't need to use this class and API programmers read code.

ABSTRACT

X token

DESCRIPTION

HH::Unispool::Config::File::Token::Numbered::X contans X token information.

CONSTRUCTOR

new( [ OPT_HASH_REF ] )

Creates a new HH::Unispool::Config::File::Token::Numbered::X object. OPT_HASH_REF is a hash reference used to pass initialization options. On error an exception Error::Simple is thrown.

Options for OPT_HASH_REF may include:

filter_name

Passed to set_filter_name().

header_name

Passed to set_header_name().

profile_name

Passed to set_profile_name().

trailer_name

Passed to set_trailer_name().

Options for OPT_HASH_REF inherited through package HH::Unispool::Config::File::Token may include:

input_line_number

Passed to set_input_line_number().

Options for OPT_HASH_REF inherited through package HH::Unispool::Config::File::Token::Numbered may include:

number

Passed to set_number().

new_from_string(LINE)

This method is inherited from package 'HH::Unispool::Config::File::Token'. Creates a new object from the specified Unispool config file line string.

METHODS

read_string(LINE)

This method is overloaded from package 'HH::Unispool::Config::File::Token::Numbered'. Reads the Unispool config file token from a line string. LINE is a plain line string. On error an exception Error::Simple is thrown.

write_string()

This method is overloaded from package 'HH::Unispool::Config::File::Token::Numbered'. Returns a Unispool config file token line string.

set_filter_name(VALUE)

Set the name of the filter file to be used when printfiles for this device are generated. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^.*$
get_filter_name()

Returns the name of the filter file to be used when printfiles for this device are generated.

set_header_name(VALUE)

Set the control procedure to be executed before printing the printfile. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^.*$
get_header_name()

Returns the control procedure to be executed before printing the printfile.

set_profile_name(VALUE)

Set the name of the profile containing the device initialisation and status checking specification. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^.*$
get_profile_name()

Returns the name of the profile containing the device initialisation and status checking specification.

set_trailer_name(VALUE)

Set the control procedure to be executed after printing the printfile. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^.*$
get_trailer_name()

Returns the control procedure to be executed after printing the printfile.

INHERITED METHODS FROM HH::Unispool::Config::File::Token

To access attribute named input_line_number:

set_input_line_number(), get_input_line_number()

INHERITED METHODS FROM HH::Unispool::Config::File::Token::Numbered

To access attribute named number:

set_number(), get_number()

SEE ALSO

HH::Unispool::Config, HH::Unispool::Config::DateFormat, HH::Unispool::Config::Entry, HH::Unispool::Config::Entry::Device, HH::Unispool::Config::Entry::Device::0, HH::Unispool::Config::Entry::Device::1, HH::Unispool::Config::Entry::Device::2, HH::Unispool::Config::Entry::Device::3, HH::Unispool::Config::Entry::Device::4, HH::Unispool::Config::Entry::Device::5, HH::Unispool::Config::Entry::Device::6, HH::Unispool::Config::Entry::Device::7, HH::Unispool::Config::Entry::Filter, HH::Unispool::Config::Entry::Numbered, HH::Unispool::Config::Entry::RemoteSystem, HH::Unispool::Config::Entry::RemoteSystem::3, HH::Unispool::Config::Entry::RemoteSystem::6, HH::Unispool::Config::Entry::RemoteSystem::7, HH::Unispool::Config::Entry::RemoteSystem::8, HH::Unispool::Config::Entry::System, HH::Unispool::Config::ExecPri, HH::Unispool::Config::File::Token, HH::Unispool::Config::File::Token::Comment, HH::Unispool::Config::File::Token::Comment::Cs, HH::Unispool::Config::File::Token::Comment::Date, HH::Unispool::Config::File::Token::Comment::Device, HH::Unispool::Config::File::Token::Comment::Filter, HH::Unispool::Config::File::Token::Comment::Group, HH::Unispool::Config::File::Token::Comment::Head, HH::Unispool::Config::File::Token::Comment::Misc, HH::Unispool::Config::File::Token::Comment::NetDesc, HH::Unispool::Config::File::Token::Comment::RSys, HH::Unispool::Config::File::Token::Comment::Scope, HH::Unispool::Config::File::Token::Comment::Tail, HH::Unispool::Config::File::Token::Factory, HH::Unispool::Config::File::Token::Numbered, HH::Unispool::Config::File::Token::Numbered::Device, HH::Unispool::Config::File::Token::Numbered::Device::0, HH::Unispool::Config::File::Token::Numbered::Device::1, HH::Unispool::Config::File::Token::Numbered::Device::2, HH::Unispool::Config::File::Token::Numbered::Device::3, HH::Unispool::Config::File::Token::Numbered::Device::4, HH::Unispool::Config::File::Token::Numbered::Device::5, HH::Unispool::Config::File::Token::Numbered::Device::6, HH::Unispool::Config::File::Token::Numbered::Device::7, HH::Unispool::Config::File::Token::Numbered::Device::Group, HH::Unispool::Config::File::Token::Numbered::Device::Info, HH::Unispool::Config::File::Token::Numbered::Device::P, HH::Unispool::Config::File::Token::Numbered::Network, HH::Unispool::Config::File::Token::Numbered::System, HH::Unispool::Config::File::Token::Numbered::System::3, HH::Unispool::Config::File::Token::Numbered::System::6, HH::Unispool::Config::File::Token::Numbered::System::7, HH::Unispool::Config::File::Token::Numbered::System::8, HH::Unispool::Config::File::Token::Numbered::System::Info, HH::Unispool::Config::File::Token::Unnumbered, HH::Unispool::Config::File::Token::Unnumbered::Bcs, HH::Unispool::Config::File::Token::Unnumbered::CSN, HH::Unispool::Config::File::Token::Unnumbered::Cs, HH::Unispool::Config::File::Token::Unnumbered::CsBcs, HH::Unispool::Config::File::Token::Unnumbered::Filter, HH::Unispool::Config::File::Token::Unnumbered::Host, HH::Unispool::Config::File::Token::Unnumbered::Misc, HH::Unispool::Config::File::Tokenizer, HH::Unispool::Config::FilterType, HH::Unispool::Config::OS, HH::Unispool::Config::Scope

BUGS

None known (yet.)

HISTORY

First development: February 2003

AUTHOR

Vincenzo Zocca

COPYRIGHT

Copyright 2003 by Vincenzo Zocca

LICENSE

This file is part of the HH::Unispool::Config module hierarchy for Perl by Vincenzo Zocca.

The HH::Unispool::Config module hierarchy 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.

The HH::Unispool::Config module hierarchy 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.

You should have received a copy of the GNU General Public License along with the HH::Unispool::Config module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA