Vincenzo Zocca > HH-Unispool-Config-0.3 > HH::Unispool::Config::Entry::Device::1

Download:
HH-Unispool-Config-0.3.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.3   Source  

NAME ^

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

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:

buffer_size

Passed to set_buffer_size(). Defaults to 2048.

device_password

Passed to set_device_password().

execution_priority

Passed to set_execution_priority(). Defaults to HH::Unispool::Config::ExecPri->new( { execution_priority = '' } )>.

header_name

Passed to set_header_name().

networkwide

Passed to set_networkwide(). Defaults to 1.

page_length

Passed to set_page_length(). Defaults to 66.

page_width

Passed to set_page_width(). Defaults to 132.

profile_name

Passed to set_profile_name().

save_printfile

Passed to set_save_printfile(). Defaults to 0.

trailer_name

Passed to set_trailer_name().

unispool_header

Passed to set_unispool_header(). Defaults to 0.

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

name

Passed to set_name(). Mandatory option.

Options for OPT_HASH_REF inherited through package HH::Unispool::Config::Entry::Device may include:

description

Passed to set_description().

filter_name

Passed to set_filter_name(). Mandatory option.

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

diff_number

Passed to set_diff_number(). Defaults to 0.

number

Passed to set_number().

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.

VALUE must match regular expression:
^\d+$
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.

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

Set the password required to access the device. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^.*$
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.

VALUE must be a (sub)class of:
HH::Unispool::Config::ExecPri
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.

VALUE must match regular expression:
^.*$
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:
^.*$
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.

VALUE must match regular expression:
^.+$
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.

VALUE must match regular expression:
^\d*$
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.

VALUE must match regular expression:
^\d+$
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.

VALUE must match regular expression:
^\d+$
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:
^.*$
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.

VALUE must match regular expression:
^.*$
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.

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::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::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

syntax highlighting: