debian man page for verilog::netlist::logger

Netlist::Logger(3pm)					User Contributed Perl Documentation				      Netlist::Logger(3pm)

NAME
       Verilog::Netlist::Logger - Error collection and reporting

SYNOPSIS
	 use Verilog::Netlist::Logger;

	 ...

	 my $self = Verilog::Netlist::Logger->new();
	 $self->info("We're here
");
	 $self->warn("Things look bad
");
	 $self->error("Things are even worse
");
	 $self->exit_if_error();

DESCRIPTION
       The Verilog::Netlist::Logger is used to report all errors detected by Verilog::Netlist::* structures.  By default, Verilog::Netlist creates
       a new Logger object, and passes it down to all contained objects.  Users may create their own logger objects to catch or otherwise handle
       error messages.

MEMBER FUNCTIONS
       $self->error (object, Text...)
	   Print an error about the object in a standard format.  The object must have a fileline method.

       $self->exit_if_error([allow=>'warning'])
	   Exits the program if any errors were detected.  Optionally specify allow=>'warning' to ignore warnings.

       $self->info (Text...)
	   Print an informational about the object in a standard format.  The object must have a fileline method.

       $self->lineno()
	   The line number the entity was created on.

       $self->unlink_if_error (filename)
	   Requests the given file be deleted if any errors are detected when the Logger object is destroyed.  Used for temporary files.

       $self->warn (Text...)
	   Print a warning about the object in a standard format.  The object must have a fileline method.

DISTRIBUTION
       Verilog-Perl is part of the <http://www.veripool.org/> free Verilog EDA software tool suite.  The latest version is available from CPAN and
       from http://www.veripool.org/verilog-perl <http://www.veripool.org/verilog-perl>.

       Copyright 2000-2012 by Wilson Snyder.  This package is free software; you can redistribute it and/or modify it under the terms of either
       the GNU Lesser General Public License Version 3 or the Perl Artistic License Version 2.0.

AUTHORS
       Wilson Snyder <wsnyder@wsnyder.org>

SEE ALSO
       Verilog-Perl, Verilog::Netlist, Verilog::Netlist::Subclass

perl v5.14.2							    2012-05-04						      Netlist::Logger(3pm)