Logger Class Reference

A class for managing all BTK-related logging and error output. More...

#include <logger.hpp>

List of all members.

Public Types
typedef boost::shared_ptr< LoggerInterface >	logger_ptr
Public Member Functions
virtual	~Logger ()
Static Public Member Functions
static LoggerInterface const &	instance ()
	Get the current Logger object.
static void	push_logger (logger_ptr p)
	Push a new Logger object onto the stack.
static void	pop_logger ()
	Pop the topmost Logger object from the stack.
Protected Member Functions
	Logger ()

---

Detailed Description

A class for managing all BTK-related logging and error output.

The Logger is actually an aggregate class, containing a stack of Logger objects, each exposing a log() and error() method. This class makes it possible to control all non-essential library output centrally, and thus allows library users to quickly and easily change the default logging/error-handling behaviour of the library.

To override default logging behaviour, push a new Logger object onto the stack, using the push_logger() method. Likewise, use the pop_logger() method to revert to an older logging behaviour.

---

Member Typedef Documentation

typedef boost::shared_ptr<LoggerInterface> logger_ptr

---

Constructor & Destructor Documentation

virtual ~Logger

(

)

[virtual]

Logger

(

)

[protected]

---

Member Function Documentation

LOGGING::LoggerInterface const & instance

(

)

[static]

Get the current Logger object.

static void push_logger

(

logger_ptr

p

)

[static]

Push a new Logger object onto the stack.

The pushed Logger object will become the new default Logger.

static void pop_logger

(

)

[static]

Pop the topmost Logger object from the stack.

After this call, the logging behaviour will be the behaviour of the next Logger object in the stack, if any (and default behaviour, otherwise).

---

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

• logger.hpp
• logger.cpp

---