Arena  1.0
A content management system
 All Classes Files Functions Variables Pages
Library.IO.Logging.Logs.AMessageLog Class Reference

A message log that outputs messages to a given stream or file. More...

+ Inheritance diagram for Library.IO.Logging.Logs.AMessageLog:

Public Member Functions

def __init__
 Construct a new message log that will output messages to the specified stream or file name. More...
 
def init
 Initializer.
 
def __del__
 Destructor.
 
def addCounterNamed
 Add the named counter to the list of counters managed by the log. More...
 
def log
 Log the specified item to the log. More...
 
def toString
 Return a string representation of the message log. More...
 
def printTo
 Print a string representation of the message log and its counters to the specified stream. More...
 
def Counter
 Retrieve the named counter. More...
 
def Counters
 Retrieve the list of counters managed by the message log. More...
 
def Output
 Retrieve a reference to the output stream used by the message log. More...
 
- Public Member Functions inherited from Library.Base.Classwork.AnObject
def init
 Initialize a new object instance. More...
 
def __init__
 Construct and initialize a new instance of AnObject. More...
 
def __del__
 Destroy the object instance. More...
 
def displayName
 Construct a "pretty" display name for the class instance, based on the name of its class. More...
 
def implements
 Determine whether the class instance is related to the specified class. More...
 
def toString
 Return a string representation of the class, suitable for output to a console or text-based device. More...
 
def __str__
 Return a string representation of the class. More...
 
def classname
 Return the name of the class from which the instance was created. More...
 
def name
 Return the name of the class. More...
 
- Public Member Functions inherited from Library.String.Utilities.IsPrintable
def toString
 Return a string representation of the class conveniently. More...
 
def __str__
 Return a string representation of the class. More...
 
def printTo
 Print a string representation of the class to the specified stream. More...
 

Detailed Description

A message log that outputs messages to a given stream or file.

Constructor & Destructor Documentation

def Library.IO.Logging.Logs.AMessageLog.__init__ (   Self,
  ThisStream 
)

Construct a new message log that will output messages to the specified stream or file name.

Member Function Documentation

def Library.IO.Logging.Logs.AMessageLog.addCounterNamed (   Self,
  thisName 
)

Add the named counter to the list of counters managed by the log.

def Library.IO.Logging.Logs.AMessageLog.Counter (   Self,
  counterName 
)

Retrieve the named counter.

def Library.IO.Logging.Logs.AMessageLog.Counters (   Self)

Retrieve the list of counters managed by the message log.

def Library.IO.Logging.Logs.AMessageLog.log (   Self,
  ThisItem,
  freeItem = True 
)

Log the specified item to the log.

If freeItem is false, the routine will return ThisItem. This behavior allows a call to this routine to be embedded into a raise statement, so that an exception can be raised immediately after logging the specified item. Otherwise, this routine returns None and deletes the reference to ThisItem, which may or may not result in ThisItem being freed, depending on how many references it holds.

def Library.IO.Logging.Logs.AMessageLog.Output (   Self)

Retrieve a reference to the output stream used by the message log.

def Library.IO.Logging.Logs.AMessageLog.printTo (   Self,
  Dest 
)

Print a string representation of the message log and its counters to the specified stream.

def Library.IO.Logging.Logs.AMessageLog.toString (   Self)

Return a string representation of the message log.

This representation is simply a header line that is meant to be used with the string representation of each counter managed by the log.


The documentation for this class was generated from the following file: