dcmtk::log4cplus::spi::InternalLoggingEvent Class Reference

The internal representation of logging events. More...

Public Member Functions
	InternalLoggingEvent (const log4cplus::tstring &logger, LogLevel loglevel, const log4cplus::tstring &message, const char *filename, int line)
	Instantiate a LoggingEvent from the supplied parameters. More...
virtual const log4cplus::tstring &	getMessage () const
	The application supplied message of logging event. More...
virtual unsigned int	getType () const
	Returns the 'type' of InternalLoggingEvent. More...
virtual OFrvalue< OFunique_ptr< InternalLoggingEvent > >	clone () const
	Returns a copy of this object. More...
const log4cplus::tstring &	getLoggerName () const
	The logger of the logging event. More...
LogLevel	getLogLevel () const
	LogLevel of logging event. More...
const log4cplus::tstring &	getNDC () const
	The nested diagnostic context (NDC) of logging event. More...
const log4cplus::tstring &	getThread () const
	The name of thread in which this logging event was generated. More...
const log4cplus::tstring &	getThread2 () const
	The alternative name of thread in which this logging event was generated. More...
const log4cplus::helpers::Time &	getTimestamp () const
	The number of milliseconds elapsed from 1/1/1970 until logging event was created. More...
const log4cplus::tstring &	getFile () const
	The is the file where this log statement was written.
int	getLine () const
	The is the line where this log statement was written.

Protected Attributes
bool	threadCached
	Indicates whether or not the Threadname has been retrieved. More...
bool	ndcCached
	Indicates whether or not the NDC has been retrieved. More...
bool	mdcCached
	Indicates whether or not the MDC has been retrieved. More...

Detailed Description

The internal representation of logging events.

When an affirmative decision is made to log then a InternalLoggingEvent instance is created. This instance is passed around to the different log4cplus components.

This class is of concern to those wishing to extend log4cplus.

Constructor & Destructor Documentation

InternalLoggingEvent()

dcmtk::log4cplus::spi::InternalLoggingEvent::InternalLoggingEvent	(	const log4cplus::tstring &	logger,
		LogLevel	loglevel,
		const log4cplus::tstring &	message,
		const char *	filename,
		int	line
	)

Instantiate a LoggingEvent from the supplied parameters.

Parameters

logger	The logger of this event.
loglevel	The LogLevel of this event.
message	The message of this event.
filename	Name of file where this event has occurred, can be NULL.
line	Line number in file specified by the filename parameter.

Member Function Documentation

clone()

virtual OFrvalue<OFunique_ptr<InternalLoggingEvent> > dcmtk::log4cplus::spi::InternalLoggingEvent::clone ( ) const

virtual

Returns a copy of this object.

Derived classes should override this method.

getLoggerName()

const log4cplus::tstring& dcmtk::log4cplus::spi::InternalLoggingEvent::getLoggerName ( ) const

inline

The logger of the logging event.

It is set by the LoggingEvent constructor.

getLogLevel()

LogLevel dcmtk::log4cplus::spi::InternalLoggingEvent::getLogLevel ( ) const

inline

LogLevel of logging event.

getMessage()

virtual const log4cplus::tstring& dcmtk::log4cplus::spi::InternalLoggingEvent::getMessage ( ) const

virtual

The application supplied message of logging event.

getNDC()

const log4cplus::tstring& dcmtk::log4cplus::spi::InternalLoggingEvent::getNDC ( ) const

inline

The nested diagnostic context (NDC) of logging event.

getThread()

const log4cplus::tstring& dcmtk::log4cplus::spi::InternalLoggingEvent::getThread ( ) const

inline

The name of thread in which this logging event was generated.

getThread2()

const log4cplus::tstring& dcmtk::log4cplus::spi::InternalLoggingEvent::getThread2 ( ) const

inline

The alternative name of thread in which this logging event was generated.

getTimestamp()

const log4cplus::helpers::Time& dcmtk::log4cplus::spi::InternalLoggingEvent::getTimestamp ( ) const

inline

The number of milliseconds elapsed from 1/1/1970 until logging event was created.

getType()

virtual unsigned int dcmtk::log4cplus::spi::InternalLoggingEvent::getType ( ) const

virtual

Returns the 'type' of InternalLoggingEvent.

Derived classes should override this method. (NOTE: Values <= 1000 are reserved for log4cplus and should not be used.)

Member Data Documentation

mdcCached

bool dcmtk::log4cplus::spi::InternalLoggingEvent::mdcCached

mutableprotected

Indicates whether or not the MDC has been retrieved.

ndcCached

bool dcmtk::log4cplus::spi::InternalLoggingEvent::ndcCached

mutableprotected

Indicates whether or not the NDC has been retrieved.

threadCached

bool dcmtk::log4cplus::spi::InternalLoggingEvent::threadCached

mutableprotected

Indicates whether or not the Threadname has been retrieved.

---

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

• oflog/include/dcmtk/oflog/spi/logevent.h