/ 
HH-Unispool-Config-0.3
River stage zero No dependents
/ HH::Unispool::Config::File::Token::Numbered::Device::Group

NAME

HH::Unispool::Config::File::Token::Numbered::Device::Group - group device G token

SYNOPSIS

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

ABSTRACT

group device G token

DESCRIPTION

HH::Unispool::Config::File::Token::Numbered::Device::Group contains information on the group device G token.

CONSTRUCTOR

new( [ OPT_HASH_REF ] )

Creates a new HH::Unispool::Config::File::Token::Numbered::Device::Group 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:

member_device_name

Passed to set_member_device_name(). Must be an ARRAY reference.

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)

Creates a new object from the specified Unispool config file line string.

METHODS

add_member_device_name(ARRAY)

Add additional values on the name of a device that can be accessed through the group device. ARRAY is the list value. The addition may not yield to multiple identical elements in the list. Hence, multiple occurrences of the same element cause the last occurrence to be inserted. On error an exception Error::Simple is thrown.

The values in ARRAY must match regular expression:
^.+$
delete_member_device_name(ARRAY)

Delete elements from the name of a device that can be accessed through the group device. Returns the number of deleted elements. On error an exception Error::Simple is thrown.

exists_member_device_name(ARRAY)

Returns the count of items in ARRAY that are in the name of a device that can be accessed through the group device.

get_input_line_number()

This method is inherited from package HH::Unispool::Config::File::Token. Returns the line number from from which the token is read.

get_number()

This method is inherited from package HH::Unispool::Config::File::Token::Numbered. Returns the number of the entry.

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.

set_input_line_number(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token. Set the line number from from which the token is read. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^\d*$
set_member_device_name(ARRAY)

Set the name of a device that can be accessed through the group device absolutely. ARRAY is the list value. Each element in the list is allowed to occur only once. Multiple occurrences of the same element yield in the last occurring element to be inserted and the rest to be ignored. On error an exception Error::Simple is thrown.

The values in ARRAY must match regular expression:
^.+$
set_number(VALUE)

This method is inherited from package HH::Unispool::Config::File::Token::Numbered. Set the number of the entry. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^\d*$
values_member_device_name()

Returns an ARRAY containing all values of the name of a device that can be accessed through the group device.

write_string()

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

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::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::Numbered::X, 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 Last update: September 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