/export/home/cpanrun/depot/main/contrib-patched/perl/CPAN/src/IPDevice/blib/lib/IPDevice/RouterBase/Module.pm


NAME

IPDevice::RouterBase::Module


SYNOPSIS

 use IPDevice::RouterBase::Module;
 my $module = new IPDevice::RouterBase::Module;
 $module(0)->interface(1)->set_encapsulation('ppp');


DESCRIPTION

This module provides routines for storing informations regarding an IP router module.


CONSTRUCTOR AND METHODS

new([%args])

Object constructor. Valid arguments:

name: Store the module name in the initial object.

set_name($name)

Set the module name.

get_name()

Returns the module name.

set_description($description)

Defines the card description.

get_description()

Returns the card description.

set_number($name)

Defines the module number. When created via any class from the IPDevice::RouterBase namespace, this is automatically set.

get_number()

Returns the module number.

set_serialnumber($serialumber)

Defines the card's memory size.

get_serialnumber()

Returns the card's memory size.

set_type($type)

Defines the card type.

get_type()

Returns the card type.

interface($interfacenumber)

Returns the interface with the given number. If it doesn't exist yet, it will be created.

foreach_interface($func, $data)

Walks through all interfaces calling the function $func. Args passed to $func are:

$interface: The IPDevice::RouterBase::Interface. %data: The given data, just piped through.

If $func returns FALSE, list evaluation will be stopped and the function returns FALSE.

foreach_unit($func, $data)

Walks through all IPDevice::RouterBase::LogicalInterface calling the function $func. Args passed to $func are:

$unit: The IPDevice::RouterBase::LogicalInterface. %data: The given data, just piped through.

If $func returns FALSE, list evaluation will be stopped.

print_data()

Prints all data regarding the module to STDOUT (e.g. for debugging).


COPYRIGHT

Copyright (c) 2004 Samuel Abels. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.


AUTHOR

Samuel Abels <spam debain org>