package HH::Unispool::Config::File::Token::Numbered::Device::P;
use 5.006;
use base qw( HH::Unispool::Config::File::Token::Numbered );
use strict;
use warnings;
use AutoLoader qw(AUTOLOAD);
use Error qw(:try);
use HH::Unispool::Config::File::Token qw( :rx :frm );
# Used by _value_is_allowed
our %ALLOW_ISA = (
);
# Used by _value_is_allowed
our %ALLOW_REF = (
);
# Used by _value_is_allowed
our %ALLOW_RX = (
'device_file' => [ '^.*$' ],
);
# Used by _value_is_allowed
our %ALLOW_VALUE = (
);
# Package version
our ($VERSION) = '$Revision: 0.3 $' =~ /\$Revision:\s+([^\s]+)/;
1;
__END__
=head1 NAME
HH::Unispool::Config::File::Token::Numbered::Device::P - device I token
=head1 SYNOPSIS
Application programmers don't need to use this class and API programmers read code.
=head1 ABSTRACT
device I
token
=head1 DESCRIPTION
C contans device I token information.
=head1 CONSTRUCTOR
=over
=item new( [ OPT_HASH_REF ] )
Creates a new C object. C is a hash reference used to pass initialization options. On error an exception C is thrown.
Options for C may include:
=over
=item B>
Passed to L.
=back
Options for C inherited through package B> may include:
=over
=item B>
Passed to L.
=back
Options for C inherited through package B> may include:
=over
=item B>
Passed to L.
=back
=item new_from_string(LINE)
Creates a new object from the specified Unispool config file line string.
=back
=head1 METHODS
=over
=item get_device_file()
Returns the device file to which the device is connected.
=item get_input_line_number()
This method is inherited from package C. Returns the line number from from which the token is read.
=item get_number()
This method is inherited from package C. Returns the number of the entry.
=item read_string(LINE)
This method is overloaded from package C. Reads the Unispool config file token from a line string. C is a plain line string. On error an exception C is thrown.
=item set_device_file(VALUE)
Set the device file to which the device is connected. C is the value. On error an exception C is thrown.
=over
=item VALUE must match regular expression:
=over
=item ^.*$
=back
=back
=item set_input_line_number(VALUE)
This method is inherited from package C. Set the line number from from which the token is read. C is the value. On error an exception C is thrown.
=over
=item VALUE must match regular expression:
=over
=item ^\d*$
=back
=back
=item set_number(VALUE)
This method is inherited from package C. Set the number of the entry. C is the value. On error an exception C is thrown.
=over
=item VALUE must match regular expression:
=over
=item ^\d*$
=back
=back
=item write_string()
This method is overloaded from package C. Returns a Unispool config file token line string.
=back
=head1 SEE ALSO
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L,
L
=head1 BUGS
None known (yet.)
=head1 HISTORY
First development: February 2003
Last update: September 2003
=head1 AUTHOR
Vincenzo Zocca
=head1 COPYRIGHT
Copyright 2003 by Vincenzo Zocca
=head1 LICENSE
This file is part of the C 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
=cut
sub _initialize {
my $self = shift;
my $opt = defined($_[0]) ? shift : {};
# Check $opt
ref($opt) eq 'HASH' || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::P::_initialize, first argument must be 'HASH' reference.");
# device_file, SINGLE
exists( $opt->{device_file} ) && $self->set_device_file( $opt->{device_file} );
# Call the superclass' _initialize
$self->SUPER::_initialize($opt);
# Return $self
return($self);
}
sub _value_is_allowed {
my $name = shift;
# Value is allowed if no ALLOW clauses exist for the named attribute
if ( ! exists( $ALLOW_ISA{$name} ) && ! exists( $ALLOW_REF{$name} ) && ! exists( $ALLOW_RX{$name} ) && ! exists( $ALLOW_VALUE{$name} ) ) {
return(1);
}
# At this point, all values in @_ must to be allowed
CHECK_VALUES:
foreach my $val (@_) {
# Check ALLOW_ISA
if ( ref($val) && exists( $ALLOW_ISA{$name} ) ) {
foreach my $class ( @{ $ALLOW_ISA{$name} } ) {
&UNIVERSAL::isa( $val, $class ) && next CHECK_VALUES;
}
}
# Check ALLOW_REF
if ( ref($val) && exists( $ALLOW_REF{$name} ) ) {
exists( $ALLOW_REF{$name}{ ref($val) } ) && next CHECK_VALUES;
}
# Check ALLOW_RX
if ( defined($val) && ! ref($val) && exists( $ALLOW_RX{$name} ) ) {
foreach my $rx ( @{ $ALLOW_RX{$name} } ) {
$val =~ /$rx/ && next CHECK_VALUES;
}
}
# Check ALLOW_VALUE
if ( ! ref($val) && exists( $ALLOW_VALUE{$name} ) ) {
exists( $ALLOW_VALUE{$name}{$val} ) && next CHECK_VALUES;
}
# We caught a not allowed value
return(0);
}
# OK, all values are allowed
return(1);
}
sub get_device_file {
my $self = shift;
return( $self->{HH_Unispool_Config_File_Token_Numbered_Device_P}{device_file} );
}
sub read_string {
my $self = shift;
my $line = shift;
# Parse line for name
my ($number, $tail) = $line =~ /$USP_PD_RX/;
defined($number) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::P::read_string, parameter 'LINE' does not match the regular expression for this token's line string.");
my @tail = $self->_split_tail($tail);
my $device_file = $tail[0];
# Set attributes
$self->set_number($number);
defined($device_file) && $self->set_device_file($device_file);
}
sub set_device_file {
my $self = shift;
my $val = shift;
# Check if isa/ref/rx/value is allowed
&_value_is_allowed( 'device_file', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::P::set_device_file, the specified value '$val' is not allowed.");
# Assignment
$self->{HH_Unispool_Config_File_Token_Numbered_Device_P}{device_file} = $val;
}
sub write_string {
my $self = shift;
# Make string and return it
return(
sprintf(
$USP_PD_FRM,
$self->get_number() || 0,
$self->get_device_file() || '',
)
);
}