cmnLogger Class Reference
[Common Tools]

#include <cmnLogger.h>

Collaboration diagram for cmnLogger:

Detailed Description

Class to glue the class register, the output multiplexer and the message level of detail to form the logging entity of cisst.

cmnLogger is defined as a singleton, i.e. there is only one instance of cmnLogger. This unique object maintains the data required for the cisst logging system. The desing of the logging system relies on:

Human readable messages are associated to a Level of Detail.

The messages are sent and filtered based on their level of detail. The macros used to send the messages actually check if the message is to be sent or not before creating them in order to improve performances (see CMN_LOG_CLASS and CMN_LOG).

The messages are sent to a multiplexer owned by cmnLogger. This multiplexer allows to send the message (along with their level of detail) to multiple output streams.

To filter the messages, the user can use:

The global level of detail defined in cmnLogger. Any message with a level of detail greater than the global level of detail will be ignored (at minimal execution time cost). This level of detail is used by CMN_LOG_CLASS and CMN_LOG. To modify the global level of detail, use cmnLogger::SetLoD(newLoD).

Each class defines a level of detail. This allows to tune the log based on the user's needs. One can for example allow all the messages (from errors to warnings) from a given class and block all the messages from every other class. As for the global level of detail, if a message's level of detail is greater than the class level of detail, it will be ignored (at minimal execution time cost). This level of detail is used only be CMN_LOG_CLASS. To modify a class level of detail, use either the class register with cmnClassRegister::SetLoD("className", newLoD) or the class services with object.Services()->SetLoD(newLoD).

The output streams level of details. Each output stream has its own level of detail and will stream only the messages with a level of details lesser or equal to his. This allows for example to log everything to a file while printing only the high priority ones to std::cout. To set the level of detail of an output stream, use cmnLogger::GetMultiplexer()->AddChannel(newStream, newLoD).

See also:: cmnClassRegister cmnClassServicesBase cmnLODOutputMultiplexer

Definition at line 225 of file cmnLogger.h.

Public Types

typedef cmnLODMultiplexerStreambuf<
char > StreamBufType
typedef cmnLogLoD LogLoDType

Static Public Member Functions

static cmnLogger * Instance (void)
static void SetLoD (LogLoDType lod)
static LogLoDType GetLoD (void)
static StreamBufType * GetMultiplexer (void)
static void HaltDefaultLog (void)
static void ResumeDefaultLog (LogLoDType newLoD=CMN_LOG_LOD_RUN_ERROR)
static void AddChannel (std::ostream &outputStream, LogLoDType lod=CMN_LOG_LOD_VERY_VERBOSE)

Protected Member Functions

cmnLogger (const std::string &defaultLogFileName="cisstLog.txt")

Member Typedef Documentation

typedef cmnLODMultiplexerStreambuf<char> cmnLogger::StreamBufType

Type used to define the logging level of detail.

Definition at line 229 of file cmnLogger.h.

Constructor & Destructor Documentation

cmnLogger::cmnLogger ( const std::string & defaultLogFileName = "cisstLog.txt" ) [protected]

Constructor. The only constructor must be private in order to ensure that the class register is a singleton.

Member Function Documentation

static cmnLogger* cmnLogger::Instance ( void ) [static]

The log is instantiated as a singleton. To access the unique instantiation, one needs to use this static method. The instantiated log is created at the first call of this method since it is a static variable declared in this method's scope.

Returns:: A pointer to the log.

static void cmnLogger::SetLoD ( LogLoDType lod ) [inline, static]

Set the global Level of Detail to filter the log messages.

Parameters:

lod

The global level of detail used to filter the log.

See also:: SetLoDInstance

Definition at line 310 of file cmnLogger.h.

static LogLoDType cmnLogger::GetLoD ( void ) [inline, static]

Get the global Level of Detail used to filter the log messages.

Returns:: The global level of detail used to filter the log.

See also:: GetLoDInstance

Definition at line 320 of file cmnLogger.h.

static StreamBufType* cmnLogger::GetMultiplexer ( void ) [inline, static]

Returns the cmnLODMultiplexerStreambuf directly. This allows manipulation of the streambuffer for operations such as adding or deleting channels for the stream..

Returns:: cmnLODMultiplexerStreambuf<char>* The Streambuffer.

See also:: GetMultiplexerInstance

Definition at line 332 of file cmnLogger.h.

Referenced by cmnNamedMap< _elementType >::GetLogMultiplexer().

static void cmnLogger::HaltDefaultLog ( void ) [inline, static]

Disable the default log file "cisstLog.txt". This method removes the default log from the output list of the multiplexer but doesn't close the default log file.

Definition at line 340 of file cmnLogger.h.

static void cmnLogger::ResumeDefaultLog ( LogLoDType newLoD = CMN_LOG_LOD_RUN_ERROR ) [inline, static]

Resume the default log file. By default, the log is enabled (this is the default behavior of the cmnLogger constructor) but this can be halted by using HaltDefaultLog(). Using ResumeDefaultLog() allows to resume the log to "cisstLog.txt" without losing previous logs.

Definition at line 350 of file cmnLogger.h.

static void cmnLogger::AddChannel	(	std::ostream &	outputStream,
		LogLoDType	lod = `CMN_LOG_LOD_VERY_VERBOSE`
	)			`[inline, static]`

Add an output stream to the logger. The level of detail provided is used to filter the messages, i.e. any message with a level of detail higher than the level associated to the output stream will not be streamed.

Definition at line 358 of file cmnLogger.h.

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

cmnLogger.h

erc-cisst-devel<at>lists.johnshopkins.edu

cmnLogger Class Reference [Common Tools]