NAME

topper::output - This class handles output to the user.

SYNOPSIS

  use topper::output;
  my $out = topper::output->new();
  $out->message(1,'some text');
  $out->error(1,'some error');
  $out->writefile('/path/to/some_filename','some text');

DESCRIPTION

This package handles all output (as in STDOUT, STDERR, file output, etc). It allows for verbosity levels and error reporting levels to be defined, and logging.

Methods

new()

Constructor. Initialises class member variables.

Input: n/a. Output: blessed object.

error(int level, string message)

This subroutine outputs an error message with given error level. For example, when verbosity is set to 5, an error with level 6 will not be shown, but any error with level equal or below 5 will be.

Input: Error level as integer, Error message as string. Output: Nothing.

message(int level, string message)

This subroutine outputs a message with given message level. For example, when verbosity is set to 5, a message with level 6 will not be shown, but any message with level equal or below 5 will be.

Input: Message level as integer, Message message as string. Output: Nothing.

get_verbosity

Returns the verbosity level. Input: Nothing. Output: (integer) verbosity level.

set_verbosity

Sets the verbosity level. Input: (integer) verbosity level. Output: Nothing

TODO

sub get_logfile($) { # TODO }

sub set_logfile($$) { # TODO }