NAME

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

SYNOPSIS

use strict;

use HH::Unispool::Config;
use HH::Unispool::Config::OS;
use HH::Unispool::Config::Entry::Filter;
use HH::Unispool::Config::Entry::System;
use HH::Unispool::Config::Entry::Device::5;
use HH::Unispool::Config::Entry::Device::6;
use HH::Unispool::Config::Entry::RemoteSystem::8;

# Create a config from scratch
my $conf3 = HH::Unispool::Config->new();

# Create a filter and add it to the configuration
my $flt = HH::Unispool::Config::Entry::Filter->new( {
    name => 'cat',
    file => '/usr/bin/cat',
} );
$conf3->add_filter($flt);

# Create the _Network_ system and add it to the configuration
my $sysn = HH::Unispool::Config::Entry::System->new( {
    name => '_Network_',
} );
$conf3->add_system($sysn);

# Add a type 8 remote system to _Network_
my $rsys = HH::Unispool::Config::Entry::RemoteSystem::8->new( {
    name => 'foo',
    os => HH::Unispool::Config::OS->new( { os => 'Solaris' } ),
    remote_node_name => 'foo.bar.org',
} );
$sysn->add_remote_system($rsys);

# Add a type 5 device to _Network_
my $dev = HH::Unispool::Config::Entry::Device::5->new( {
    name => 'lp',
    filter_name => 'cat',
    remote_device_name => 'lp',
    remote_system_name => 'foo',
    description => 'lp',
} );
$sysn->add_device($dev);

# Create the foo.bar.org system and add it to the configuration
my $sysf = HH::Unispool::Config::Entry::System->new( {
    name => 'foo.bar.org',
    local_system_name => 'foo',
    network_name => 'foo.bar.org',
    os => HH::Unispool::Config::OS->new( { os => 'Solaris' } ),
    type => 'cs',
} );
$conf3->add_system($sysf);

# Add a type 6 device to foo.bar.org
$dev = HH::Unispool::Config::Entry::Device::6->new( {
    name => 'lp1',
    filter_name => 'cat',
    remote_node_name => 'lp1.foo.bar.org',
    description => 'lp1',
} );
$sysf->add_device($dev);

# Add another type 6 device to foo.bar.org
$dev = HH::Unispool::Config::Entry::Device::6->new( {
    name => 'lp2',
    filter_name => 'cat',
    remote_node_name => 'lp2.foo.bar.org',
    description => 'lp2',
} );
$sysf->add_device($dev);

# Add another type 3 device to foo.bar.org
$dev = HH::Unispool::Config::Entry::Device::3->new( {
    name => 'lp',
    filter_name => 'cat',
    member_device_name => [ qw( lp1 lp2 ) ],
    description => 'lp',
} );
$sysf->add_device($dev);

# Write the configuration
$conf3->write('t/config.sample.d5.out');

ABSTRACT

UNISPOOL type 5 device

DESCRIPTION

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

CONSTRUCTOR

new(OPT_HASH_REF)

Creates a new HH::Unispool::Config::Entry::Device::5 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:

header_name: Passed to set_header_name().
remote_device_name: Passed to set_remote_device_name(). Mandatory option.
remote_system_name: Passed to set_remote_system_name(). Mandatory option.
trailer_name: Passed to set_trailer_name().

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_description()

This method is inherited from package HH::Unispool::Config::Entry::Device. Returns the description for the device.

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_remote_device_name()

Returns the device on the remote system that will receive the output.

get_remote_system_name()

Returns the name of the system to which the output for this device must be routed.

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.

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.