ArLog Class Reference

Logging utility class. More...

#include <ArLog.h>

List of all members.

Public Types

enum LogLevel { Terse, Normal, Verbose }

enum LogType {
StdOut, StdErr, File, Colbert,
None
}

Static Public Member Functions

static void addToConfig (ArConfig *config)

Class to add this to an ArConfig (ie Aria::getConfig()).

static void close ()

Close the logging utility.

static bool init (LogType type, LogLevel level, const char *fileName="", bool logTime=false, bool alsoPrint=false, bool printThisCall=true)

Initialize the logging utility.

static void log (LogLevel level, const char *str,...)

Log a message.

static void logNoLock (LogLevel level, const char *str,...)

static void logPlain (LogLevel level, const char *str)

Static Public Attributes

static void(* colbertPrint )(int i, const char *str)

Static Protected Member Functions

static bool processFile (void)

Static Protected Attributes

static bool ourAlsoPrint = false

static int ourColbertStream = -1

static bool ourConfigAlsoPrint = false

static char ourConfigFileName [1024] = "log.txt"

static LogLevel ourConfigLogLevel = ArLog::Normal

static bool ourConfigLogTime = false

static LogType ourConfigLogType = ArLog::StdOut

static ArGlobalRetFunctor<
bool > ourConfigProcessFileCB

static std::string ourFileName

static FILE * ourFP = 0

static LogLevel ourLevel = ArLog::Normal

static ArLog * ourLog

static bool ourLoggingTime = false

static ArMutex ourMutex

static LogType ourType = StdOut

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.

Definition at line 48 of file ArLog.h.

Member Enumeration Documentation

enum ArLog::LogLevel

Enumeration values:

Terse Use terse logging.

Normal Use normal logging.

Verbose Use verbose logging.

Definition at line 59 of file ArLog.h.

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.

Definition at line 52 of file ArLog.h.

Member Function Documentation

bool ArLog::init ( LogType type,

LogLevel level,

const char * fileName = "",

bool logTime = false,

bool alsoPrint = false,

bool printThisCall = true

) [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

logTime if this is true then the time a message is given will be logged

alsoPrint if this is true then in addition to whatever other logging (to a file for instance) the results will also be printed

printThisCall if this is true the new settings will be printed otherwise they won't

Definition at line 125 of file ArLog.cpp.
References close(), Colbert, File, ArMutex::lock(), None, Normal, StdErr, StdOut, Terse, ArMutex::unlock(), and Verbose.

void ArLog::logPlain ( LogLevel level,

const char * str

) [static]

Log a message without varargs (wrapper for java) Log a message
Definition at line 52 of file ArLog.cpp.
References log().

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

Generated on Wed Oct 19 12:56:49 2005 for Aria by

1.4.0


Public Types
enum	LogLevel { Terse, Normal, Verbose }
enum	LogType { StdOut, StdErr, File, Colbert, None }
Static Public Member Functions
static void	addToConfig (ArConfig *config)
	Class to add this to an ArConfig (ie Aria::getConfig()).
static void	close ()
	Close the logging utility.
static bool	init (LogType type, LogLevel level, const char *fileName="", bool logTime=false, bool alsoPrint=false, bool printThisCall=true)
	Initialize the logging utility.
static void	log (LogLevel level, const char *str,...)
	Log a message.
static void	logNoLock (LogLevel level, const char *str,...)
static void	logPlain (LogLevel level, const char *str)
Static Public Attributes
static void(*	colbertPrint )(int i, const char *str)
Static Protected Member Functions
static bool	processFile (void)
Static Protected Attributes
static bool	ourAlsoPrint = false
static int	ourColbertStream = -1
static bool	ourConfigAlsoPrint = false
static char	ourConfigFileName [1024] = "log.txt"
static LogLevel	ourConfigLogLevel = ArLog::Normal
static bool	ourConfigLogTime = false
static LogType	ourConfigLogType = ArLog::StdOut
static ArGlobalRetFunctor< bool >	ourConfigProcessFileCB
static std::string	ourFileName
static FILE *	ourFP = 0
static LogLevel	ourLevel = ArLog::Normal
static ArLog *	ourLog
static bool	ourLoggingTime = false
static ArMutex	ourMutex
static LogType	ourType = StdOut