log4cplus::spi::InternalLoggingEvent Class Reference

The internal representation of logging events. More...

List of all members.

Public Member Functions

 InternalLoggingEvent (const log4cplus::tstring &logger, LogLevel ll_, const log4cplus::tstring &message_, const char *filename, int line_, const char *function_)
 Instantiate a LoggingEvent from the supplied parameters.
 InternalLoggingEvent (const log4cplus::tstring &logger, LogLevel ll_, const log4cplus::tstring &ndc_, const log4cplus::tstring &message_, const log4cplus::tstring &thread_, log4cplus::helpers::Time time, const log4cplus::tstring &file_, int line_, const log4cplus::tstring &function_)
 InternalLoggingEvent (const log4cplus::spi::InternalLoggingEvent &rhs)
virtual const log4cplus::tstringgetMessage () const
 The application supplied message of logging event.
virtual unsigned int getType () const
 Returns the 'type' of InternalLoggingEvent.
virtual OFauto_ptr< InternalLoggingEventclone () const
 Returns a copy of this object.
const log4cplus::tstringgetLoggerName () const
 The logger of the logging event.
LogLevel getLogLevel () const
 LogLevel of logging event.
const log4cplus::tstringgetNDC () const
 The nested diagnostic context (NDC) of logging event.
const log4cplus::tstringgetThread () const
 The name of thread in which this logging event was generated.
const log4cplus::helpers::TimegetTimestamp () const
 The number of milliseconds elapsed from 1/1/1970 until logging event was created.
const log4cplus::tstringgetFile () const
 The is the file where this log statement was written.
int getLine () const
 The is the line where this log statement was written.
const log4cplus::tstringgetFunction () const
 The is the function where this log statement was written.
log4cplus::spi::InternalLoggingEventoperator= (const log4cplus::spi::InternalLoggingEvent &rhs)

Static Public Member Functions

static unsigned int getDefaultType ()

Protected Attributes

log4cplus::tstring message

Private Attributes

log4cplus::tstring loggerName
LogLevel ll
log4cplus::tstring ndc
log4cplus::tstring thread
log4cplus::helpers::Time timestamp
log4cplus::tstring file
int line
log4cplus::tstring function
bool threadCached
 Indicates whether or not the Threadname has been retrieved.
bool ndcCached
 Indicates whether or not the NDC has been retrieved.


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.

Definition at line 45 of file logevent.h.


Constructor & Destructor Documentation

log4cplus::spi::InternalLoggingEvent::InternalLoggingEvent ( const log4cplus::tstring logger,
LogLevel  ll_,
const log4cplus::tstring message_,
const char *  filename,
int  line_,
const char *  function_ 
) [inline]

Instantiate a LoggingEvent from the supplied parameters.

Parameters:
logger The logger of this event.
ll_ 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.
function_ Function where this event has occurred

Definition at line 60 of file logevent.h.


Member Function Documentation

virtual unsigned int 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.)

virtual OFauto_ptr<InternalLoggingEvent> log4cplus::spi::InternalLoggingEvent::clone (  )  const [virtual]

Returns a copy of this object.

Derived classes should override this method.

const log4cplus::tstring& log4cplus::spi::InternalLoggingEvent::getLoggerName (  )  const [inline]

The logger of the logging event.

It is set by the LoggingEvent constructor.

Definition at line 146 of file logevent.h.


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


Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1