blocxx
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>

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

◆ ScopeLogger() [1/5]

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

Definition at line 40 of file ScopeLogger.cpp.

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

◆ ScopeLogger() [2/5]

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

Definition at line 49 of file ScopeLogger.cpp.

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

◆ ScopeLogger() [3/5]

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

Definition at line 58 of file ScopeLogger.cpp.

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

◆ ScopeLogger() [4/5]

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
entranceThe message to log when created.
exitThe message to log when destroyed.
formatA delayed formatter which will be used in formatting a message directly appended to the enter/exit text.
componentThe component to be used in creating the logger.
appenderThe log appender to pass to a logger.

Definition at line 74 of file ScopeLogger.cpp.

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

◆ ~ScopeLogger()

BLOCXX_NAMESPACE::ScopeLogger::~ScopeLogger ( )
virtual

◆ ScopeLogger() [5/5]

BLOCXX_NAMESPACE::ScopeLogger::ScopeLogger ( const ScopeLogger & )
private

Member Function Documentation

◆ operator=()

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

Member Data Documentation

◆ enterMessage

String BLOCXX_NAMESPACE::ScopeLogger::enterMessage
private

Definition at line 104 of file ScopeLogger.hpp.

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

◆ exitMessage

String BLOCXX_NAMESPACE::ScopeLogger::exitMessage
private

Definition at line 105 of file ScopeLogger.hpp.

Referenced by ~ScopeLogger().

◆ formatter

Reference<DelayedFormat> BLOCXX_NAMESPACE::ScopeLogger::formatter
private

Definition at line 108 of file ScopeLogger.hpp.

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

◆ logger

Logger BLOCXX_NAMESPACE::ScopeLogger::logger
private

Definition at line 106 of file ScopeLogger.hpp.

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


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