BLOCXX_NAMESPACE::ScopeLogger Class Reference

This is a fairly simple class that will log a message when created and when destroyed. More...

#include <ScopeLogger.hpp>

List of all members.

Public Member Functions

 ScopeLogger (const String &entrance, const String &exit, const Logger &lgr)
 ScopeLogger (const String &entrance, const String &exit, const String &component=Logger::STR_DEFAULT_COMPONENT, const LogAppenderRef &appender=LogAppenderRef())
 ScopeLogger (const String &entrance, const String &exit, const Reference< DelayedFormat > &format, const Logger &lgr)
 ScopeLogger (const String &entrance, const String &exit, const Reference< DelayedFormat > &format, const String &component=Logger::STR_DEFAULT_COMPONENT, const LogAppenderRef &appender=LogAppenderRef())
virtual ~ScopeLogger ()

Private Member Functions

 ScopeLogger (const ScopeLogger &)
ScopeLoggeroperator= (const ScopeLogger &)

Private Attributes

String enterMessage
String exitMessage
Logger logger
Reference< DelayedFormatformatter

Detailed Description

This is a fairly simple class that will log a message when created and when destroyed.

This is intended to be used for logging the start/finish of a scope (eg. function).

Definition at line 61 of file ScopeLogger.hpp.


Constructor & Destructor Documentation

BLOCXX_NAMESPACE::ScopeLogger::ScopeLogger ( const String entrance,
const String exit,
const Logger lgr 
)
Parameters:
entrance The message to log when created.
exit The message to log when destroyed.
lgr The logger to be used.

Definition at line 39 of file ScopeLogger.cpp.

BLOCXX_NAMESPACE::ScopeLogger::ScopeLogger ( const String entrance,
const String exit,
const String component = Logger::STR_DEFAULT_COMPONENT,
const LogAppenderRef appender = LogAppenderRef() 
)
Parameters:
entrance The message to log when created.
exit The message to log when destroyed.
component The component to be used in creating the logger.
appender The log appender to pass to a logger.

Definition at line 48 of file ScopeLogger.cpp.

References enterMessage, BLOCXX_NAMESPACE::Logger::logDebug(), and logger.

BLOCXX_NAMESPACE::ScopeLogger::ScopeLogger ( const String entrance,
const String exit,
const Reference< DelayedFormat > &  format,
const Logger lgr 
)
Parameters:
entrance The message to log when created.
exit The message to log when destroyed.
format A delayed formatter which will be used in formatting a message directly appended to the enter/exit text.
lgr The logger to be used.

Definition at line 57 of file ScopeLogger.cpp.

References enterMessage, formatter, BLOCXX_NAMESPACE::Logger::logDebug(), and logger.

BLOCXX_NAMESPACE::ScopeLogger::ScopeLogger ( const String entrance,
const String exit,
const Reference< DelayedFormat > &  format,
const String component = Logger::STR_DEFAULT_COMPONENT,
const LogAppenderRef appender = LogAppenderRef() 
)
Parameters:
entrance The message to log when created.
exit The message to log when destroyed.
format A delayed formatter which will be used in formatting a message directly appended to the enter/exit text.
component The component to be used in creating the logger.
appender The log appender to pass to a logger.

Definition at line 73 of file ScopeLogger.cpp.

References enterMessage, formatter, BLOCXX_NAMESPACE::Logger::logDebug(), and logger.

BLOCXX_NAMESPACE::ScopeLogger::~ScopeLogger (  )  [virtual]

Definition at line 89 of file ScopeLogger.cpp.

References exitMessage, formatter, BLOCXX_NAMESPACE::Logger::logDebug(), and logger.

BLOCXX_NAMESPACE::ScopeLogger::ScopeLogger ( const ScopeLogger  )  [private]

Member Function Documentation

ScopeLogger& BLOCXX_NAMESPACE::ScopeLogger::operator= ( const ScopeLogger  )  [private]

Member Data Documentation

Definition at line 104 of file ScopeLogger.hpp.

Referenced by ScopeLogger().

Definition at line 105 of file ScopeLogger.hpp.

Referenced by ~ScopeLogger().

Definition at line 108 of file ScopeLogger.hpp.

Referenced by ScopeLogger(), and ~ScopeLogger().

Definition at line 106 of file ScopeLogger.hpp.

Referenced by ScopeLogger(), and ~ScopeLogger().


The documentation for this class was generated from the following files:
Generated on Mon Jul 5 19:59:51 2010 for blocxx by  doxygen 1.6.3