DCMTK  Version 3.6.1 20121102
OFFIS DICOM Toolkit
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions | Protected Attributes | Private Attributes | List of all members
dcmtk::log4cplus::spi::InternalLoggingEvent Class Reference

The internal representation of logging events. More...

+ Collaboration diagram for dcmtk::log4cplus::spi::InternalLoggingEvent:

Public Member Functions

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

Static Public Member Functions

static unsigned int getDefaultType ()
 

Protected Attributes

tstring message
 

Private Attributes

tstring loggerName
 
LogLevel ll
 
tstring ndc
 
tstring thread
 
helpers::Time timestamp
 
tstring file
 
int line
 
tstring function
 
bool threadCached
 Indicates whether or not the Threadname has been retrieved. More...
 
bool ndcCached
 Indicates whether or not the NDC 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

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

Instantiate a LoggingEvent from the supplied parameters.

Parameters
loggerThe logger of this event.
ll_The LogLevel of this event.
message_The message of this event.
filenameName 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

Member Function Documentation

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

Returns a copy of this object.

Derived classes should override this method.

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

The logger of the logging event.

It is set by the LoggingEvent constructor.

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

LogLevel of logging event.

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

The application supplied message of logging event.

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

The nested diagnostic context (NDC) of logging event.

References dcmtk::log4cplus::NDC::get().

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

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

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

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

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

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

Indicates whether or not the NDC has been retrieved.

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

Indicates whether or not the Threadname has been retrieved.


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


Generated on Wed Sep 4 2013 for DCMTK Version 3.6.1 20121102 by Doxygen 1.8.4