Richard Clamp > Pipeline-3.12 > Pipeline::Base

Download:
Pipeline-3.12.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  5
Open  0
View/Report Bugs
Module Version: 3.12   Source  

NAME ^

Pipeline::Base - base class for all classes in Pipeline distribution

SYNOPSIS ^

  use Pipeline::Base;

  $object = Pipeline::Base->new()
  $object->debug( 10 );
  $object->emit("message");

DESCRIPTION ^

Pipeline::Base is a class that provides a basic level of functionality for all classes in the Pipeline system. Most importantly it provides the construction and initialization of new objects.

METHODS ^

CLASS->new()

The new() method is a constructor that returns an instance of receiving class.

init( LIST );

init() is called by the constructor, new() and is passed all of its arguments in LIST.

debug( [ SCALAR ] )

The debug() method gets and sets the debug state of the OBJECT. Setting it to a true value will cause messages sent to emit() to be printed to the terminal. If debug() is called as a class method it always will return true.

emit( SCALAR )

emit() is a debugging tool. It will cause the the SCALAR to be formatted and sent to the log() method if the current debugging level is set to a true value.

log( SCALAR )

The log() method will send SCALAR to STDERR by default. It performs no processing of SCALAR and merely sends its results to the error handle. To change your logging mechanism simply override this method in the class as you see fit.

AUTHOR ^

James A. Duncan <jduncan@fotango.com>

syntax highlighting: