HH::Unispool::Config::Entry::Device::1 - UNISPOOL type 1 device

NAME
SYNOPSIS
ABSTRACT
DESCRIPTION
CONSTRUCTOR
METHODS
SEE ALSO
BUGS
HISTORY
AUTHOR
COPYRIGHT
LICENSE

NAME

SYNOPSIS

 use strict;
 
 use HH::Unispool::Config;
 use HH::Unispool::Config::OS;
 use HH::Unispool::Config::Scope;
 use HH::Unispool::Config::Entry::System;
 use HH::Unispool::Config::Entry::Device::1;
 
 # Create a config from scratch with a _Local_ scope
 my $conf = HH::Unispool::Config->new( {
     scope => HH::Unispool::Config::Scope->new ( {
         scope => [ qw( _Local_) ],
     } ),
 } );
 
 # Create the _Local_ system and add it to the configuration
 my $sysn = HH::Unispool::Config::Entry::System->new( {
     name => '_Local_',
     local_system_name => 'foo',
     network_name => 'foo.bar.org',
     os => HH::Unispool::Config::OS->new( {
         os => 'Solaris',
     } ),
 } );
 $conf->add_system($sysn);
 
 # Add a type 1 device to _Local_
 my $dev = HH::Unispool::Config::Entry::Device::1->new( {
     name => 'lp',
     filter_name => 'cat',
 } );
 $sysn->add_device($dev);
 
 # Write the configuration
 $conf->write('t/config.sample.d1.out');

ABSTRACT

UNISPOOL type 1 device

DESCRIPTION

Class HH::Unispool::Config::Entry::Device::1 holds information for UNISPOOL type 1 device

CONSTRUCTOR

new(OPT_HASH_REF): Creates a new HH::Unispool::Config::Entry::Device::1 object. OPT_HASH_REF is a hash reference used to pass initialization options. OPT_HASH_REF is mandatory. On error an exception Error::Simple is thrown.; Options for OPT_HASH_REF may include:
new_from_tokenizer(TOKENIZER): This method is an implementation from package HH::Unispool::Config::Entry::Device. Constructs a new HH::Unispool::Config::Entry object using tokens. TOKENIZER is an HH::Unispool::Config::File::Tokenizer reference. On error an exception Error::Simple is thrown.

METHODS

diff(TO [, DIFF_NUMBER]): This method is an implementation from package HH::Unispool::Config::Entry::Device. Finds differences between two objects. In diff terms, the object is the from object and the specified TO parameter the to object. TO is a reference to an identical object class. Returns an empty string if no difference found and a difference descritpion string otherwise. On error an exception Error::Simple is thrown. Paremeter DIFF_NUMBER if specified, overrules the value of get_diff_number.
get_buffer_size(): Returns the number of bytes sent to the printer in one write operation.
get_description(): This method is inherited from package HH::Unispool::Config::Entry::Device. Returns the description for the device.
get_device_password(): Returns the password required to access the device.
get_execution_priority(): Returns the execution priority of the driver process on MPE hosts.
get_filter_name(): This method is inherited from package HH::Unispool::Config::Entry::Device. Returns the name of the filter file to be used when printfiles for this device are generated.
get_header_name(): Returns the control procedure to be executed before printing the printfile.
get_name(): This method is inherited from package HH::Unispool::Config::Entry. Returns the entry name.
get_number(): This method is inherited from package HH::Unispool::Config::Entry::Numbered. Returns the entry number.
get_page_length(): Returns the page length (lines) for determining the size of UNISPOOL banners.
get_page_width(): Returns the page width (bytes) for determining the size of UNISPOOL banners.
get_profile_name(): Returns the name of the profile containing the device initialisation and status checking specification.
get_trailer_name(): Returns the control procedure to be executed after printing the printfile.
is_diff_number(): This method is inherited from package HH::Unispool::Config::Entry::Numbered. Returns whether diff() should consider the number attribtutes or not.
is_networkwide(): Returns whether the device must be made available from each node in the configuration cluster or not.
is_save_printfile(): Returns whether printfiles printed on this device should be saved or not.
is_unispool_header(): Returns whether standard UNISPOOL banners pages are printed initially or not.
set_buffer_size(VALUE): Set the number of bytes sent to the printer in one write operation. VALUE is the value. Default value at initialization is 2048. On error an exception Error::Simple is thrown.
set_description(VALUE): This method is inherited from package HH::Unispool::Config::Entry::Device. Set the description for the device. VALUE is the value. On error an exception Error::Simple is thrown.
set_device_password(VALUE): Set the password required to access the device. VALUE is the value. On error an exception Error::Simple is thrown.
set_diff_number(VALUE): This method is inherited from package HH::Unispool::Config::Entry::Numbered. State that diff() should consider the number attribtutes. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.
set_execution_priority(VALUE): Set the execution priority of the driver process on MPE hosts. VALUE is the value. Default value at initialization is HH::Unispool::Config::ExecPri->new( { execution_priority = '' } )>. On error an exception Error::Simple is thrown.
set_filter_name(VALUE): This method is inherited from package HH::Unispool::Config::Entry::Device. 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.
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.
set_name(VALUE): This method is inherited from package HH::Unispool::Config::Entry. Set the entry name. VALUE is the value. VALUE may not be undef. On error an exception Error::Simple is thrown.
set_networkwide(VALUE): State that the device must be made available from each node in the configuration cluster. VALUE is the value. Default value at initialization is 1. On error an exception Error::Simple is thrown.
set_number(VALUE): This method is inherited from package HH::Unispool::Config::Entry::Numbered. Set the entry number. VALUE is the value. On error an exception Error::Simple is thrown.
set_page_length(VALUE): Set the page length (lines) for determining the size of UNISPOOL banners. VALUE is the value. Default value at initialization is 66. On error an exception Error::Simple is thrown.
set_page_width(VALUE): Set the page width (bytes) for determining the size of UNISPOOL banners. VALUE is the value. Default value at initialization is 132. On error an exception Error::Simple is thrown.
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.
set_save_printfile(VALUE): State that printfiles printed on this device should be saved. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.
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.
set_unispool_header(VALUE): State that standard UNISPOOL banners pages are printed initially. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.
write(FILE_HANDLE): This method is an implementation from package HH::Unispool::Config::Entry::Device. Writes the entry to the specified file handle. FILE_HANDLE is an IO::Handle reference. On error an exception Error::Simple is thrown.

BUGS

None known (yet.)

HISTORY

First development: February 2003 Last update: September 2003

AUTHOR

Vincenzo Zocca

COPYRIGHT

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