LoggerPtr< T > Struct Template Reference

#include <evo/logger.h>

Detailed Description

template<class T = LoggerBase>
struct evo::LoggerPtr< T >

Wraps a logger pointer that can reference a logger to use or be disabled.

• This is useful for making logging optional in certain classes or functions – leaving or setting the pointer as NULL disables logging
• This provides the same logging methods as LoggerBase: check(), log_direct() and log()
• Caution: This is not thread safe
• See: Logger, LoggerConsole

Template Parameters

T	Logger to use – use LoggerBase (the default) for any logger

Public Types
typedef T	LoggerType
	Logger type used from template. More...

Public Member Functions
	LoggerPtr ()
	Constructor sets as null. More...
	LoggerPtr (LoggerType *newptr)
	Constructor to set pointer. More...
	LoggerPtr (const LoggerPtr &src)
	Copy constructor copies logger pointer. More...
bool	check (LogLevel level) const
	Check whether a message with given level will actually be logged. More...
bool	log (LogLevel level, const SubString &msg)
	Log a message with given severity level. More...
void	log_direct (LogLevel level, const SubString &msg)
	Log a message with given log level directly without checking the current log level. More...
LoggerPtr &	operator= (const LoggerPtr &src)
	Assignment operator copies logger pointer. More...
void	set ()
	Set as null. More...
void	set (LoggerType *newptr)
	Set to new pointer. More...

Public Attributes
LoggerType *	ptr
	Logger pointer, NULL to disable logging with this More...

Member Typedef Documentation

LoggerType

typedef T LoggerType

Logger type used from template.

Constructor & Destructor Documentation

LoggerPtr() [1/3]

LoggerPtr ( )

inline

Constructor sets as null.

LoggerPtr() [2/3]

LoggerPtr ( LoggerType *  newptr )

inline

Constructor to set pointer.

LoggerPtr() [3/3]

LoggerPtr ( const LoggerPtr< T > &  src )

inline

Copy constructor copies logger pointer.

Parameters

src	Source to copy

Member Function Documentation

check()

bool check ( LogLevel  level ) const

inline

Check whether a message with given level will actually be logged.

• This is used before calling log_direct() with the message
• Consider using helper macros:
  • EVO_LOG_ALERT()
  • EVO_LOG_ERROR()
  • EVO_LOG_WARN()
  • EVO_LOG_INFO()
  • EVO_LOG_DEBUG()
  • EVO_LOG_DEBUG_LOW()

Parameters

level

Message severity level to check

Returns

Whether given severity level passes current level check, false if a message at this level will be ignored

log()

bool log ( LogLevel  level, const SubString &  msg  )

inline

Log a message with given severity level.

• This calls check() to check whether this message will be logged
• For best performance use check() and log_direct() instead to avoid formatting messages that will not be logged
• Consider using helper macros:
  • EVO_LOG_ALERT()
  • EVO_LOG_ERROR()
  • EVO_LOG_WARN()
  • EVO_LOG_INFO()
  • EVO_LOG_DEBUG()
  • EVO_LOG_DEBUG_LOW()

Parameters

level	Message severity level to use
msg	Message to log

Returns

Whether message was logged, false if message will be ignored due to current log level

log_direct()

void log_direct ( LogLevel  level, const SubString &  msg  )

inline

Log a message with given log level directly without checking the current log level.

• This assumes check() was called first to check whether message will be logged
• Consider using helper macros:
  • EVO_LOG_ALERT()
  • EVO_LOG_ERROR()
  • EVO_LOG_WARN()
  • EVO_LOG_INFO()
  • EVO_LOG_DEBUG()
  • EVO_LOG_DEBUG_LOW()

Parameters

level	Message severity level to use
msg	Message to log

operator=()

LoggerPtr& operator= ( const LoggerPtr< T > &  src )

inline

Assignment operator copies logger pointer.

Parameters

src	Source to copy

Returns

This

set() [1/2]

void set ( )

inline

Set as null.

set() [2/2]

void set ( LoggerType *  newptr )

inline

Set to new pointer.

Parameters

newptr

New pointer to set

Member Data Documentation

ptr

LoggerType* ptr

Logger pointer, NULL to disable logging with this

---

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

• evo/logger.h