Main Page   Class Hierarchy   Compound List   Compound Members  

ArLog Class Reference

Logging utility class. More...

#include <ArLog.h>

List of all members.

Public Types

enum  LogType {
  StdOut, StdErr, File, Colbert,
  None
}
enum  LogLevel { Terse, Normal, Verbose }

Static Public Methods

void log (LogLevel level, char *str,...)
 Log a message. More...

bool init (LogType type, LogLevel level, const char *fileName="")
 Initialize the logging utility. More...

void close ()
 Close the logging utility.


Detailed Description

Logging utility class.

ArLog is a utility class to log all messages from Aria to a choosen destintation. Messages can be logged to stdout, stderr, a file, and turned off completely. Logging by default is set to stdout. The level of logging can be changed as well. Allowed levels are Terse, Normal, and Verbose. By default the level is set to Normal.


Member Enumeration Documentation

enum ArLog::LogLevel
 

Enumeration values:
Terse  Use terse logging.
Normal  Use normal logging.
Verbose  Use verbose logging.

enum ArLog::LogType
 

Enumeration values:
StdOut  Use stdout for logging.
StdErr  Use stderr for logging.
File  Use a file for logging.
Colbert  Use a Colbert stream for logging.
None  Disable logging.


Member Function Documentation

bool ArLog::init LogType    type,
LogLevel    level,
const char *    fileName = ""
[static]
 

Initialize the logging utility.

Initialize the logging utility by supplying the type of logging and the level of logging. If the type is File, the fileName needs to be supplied.

Parameters:
type  type of Logging
level  level of logging
fileName  the name of the file for File type of logging

void ArLog::log LogLevel    level,
char *    str,
...   
[static]
 

Log a message.

This function is used like printf(). If the supplied level is less than or equal to the set level, it will be printed.

Parameters:
level  level of logging
str  printf() like formating string


The documentation for this class was generated from the following files:
Generated on Tue Nov 12 17:43:57 2002 for Aria by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001