Public Member Functions

xl7::logging::Logger Class Reference

#include <Logger.h>

Inheritance diagram for xl7::logging::Logger:
cl7::logging::Logger pl7::console::Logger

List of all members.

Public Member Functions

 Logger (void)
virtual ~Logger (void)
LogIterator LogEngineResult (errorcodes::ErrorCode error_code, const LogEntry::Type type, const cl7::char_type *const file_name=NULL, const unsigned line_number=0)
LogIterator LogEngineResult (errorcodes::ErrorCode error_code, const cl7::string_type &ref_obj, const LogEntry::Type type, const cl7::char_type *const file_name=NULL, const unsigned line_number=0)
LogIterator LogDirectXResult (HRESULT error_code, const LogEntry::Type type, const cl7::char_type *const file_name=NULL, const unsigned line_number=0)
LogIterator LogDirectXResult (HRESULT error_code, const cl7::string_type &ref_obj, const LogEntry::Type type, const cl7::char_type *const file_name=NULL, const unsigned line_number=0)
LogIterator LogWindowsResult (DWORD error_code, const LogEntry::Type type=LogEntry::Error, const cl7::char_type *const file_name=NULL, const unsigned line_number=0)
LogIterator LogWindowsResult (DWORD error_code, const cl7::string_type &ref_obj, const LogEntry::Type type, const cl7::char_type *const file_name=NULL, const unsigned line_number=0)

Detailed Description

The standard logger class. Holds a list of log entries which hold the log message itself and the log type (warning, error, etc.). If the number of log entries exceeds the log limit (default 1000) the oldest log entries are removed. The class provides a virtual function OnLog which is called after adding another log entry and derived classes may override.


Constructor & Destructor Documentation

xl7::logging::Logger::Logger ( void   ) 

Default constructor.

Reimplemented from cl7::logging::Logger.

Reimplemented in pl7::console::Logger.

xl7::logging::Logger::~Logger ( void   )  [virtual]

Destructor.

Reimplemented from cl7::logging::Logger.

Reimplemented in pl7::console::Logger.


Member Function Documentation

LogIterator xl7::logging::Logger::LogDirectXResult ( HRESULT  error_code,
const LogEntry::Type  type,
const cl7::char_type *const   file_name = NULL,
const unsigned  line_number = 0 
)

Creates a new log entry generated from the given DirectX error code and the given type (if specified, default type is Error). Oldest log entries are removed if necessary to satisfy the log limit.

LogIterator xl7::logging::Logger::LogDirectXResult ( HRESULT  error_code,
const cl7::string_type ref_obj,
const LogEntry::Type  type,
const cl7::char_type *const   file_name = NULL,
const unsigned  line_number = 0 
)

Creates a new log entry generated from the given DirectX error code, the given reference object (e.g., the function caused the error or the file of a failed I/O operation), and the given type (if specified, default type is Error). Oldest log entries are removed if necessary to satisfy the log limit.

LogIterator xl7::logging::Logger::LogEngineResult ( errorcodes::ErrorCode  error_code,
const cl7::string_type ref_obj,
const LogEntry::Type  type,
const cl7::char_type *const   file_name = NULL,
const unsigned  line_number = 0 
)

Creates a new log entry generated from the given engine error code, the given reference object (e.g., the function caused the error or the file of a failed I/O operation), and the given type (if specified, default type is Error). Oldest log entries are removed if necessary to satisfy the log limit.

LogIterator xl7::logging::Logger::LogEngineResult ( errorcodes::ErrorCode  error_code,
const LogEntry::Type  type,
const cl7::char_type *const   file_name = NULL,
const unsigned  line_number = 0 
)

Creates a new log entry generated from the given engine error code and the given type (if specified, default type is Error). Oldest log entries are removed if necessary to satisfy the log limit.

LogIterator xl7::logging::Logger::LogWindowsResult ( DWORD  error_code,
const cl7::string_type ref_obj,
const LogEntry::Type  type,
const cl7::char_type *const   file_name = NULL,
const unsigned  line_number = 0 
)

Creates a new log entry generated from the given Windows error code, the given reference object (e.g., the function caused the error or the file of a failed I/O operation), and the given type (if specified, default type is Error). Oldest log entries are removed if necessary to satisfy the log limit.

LogIterator xl7::logging::Logger::LogWindowsResult ( DWORD  error_code,
const LogEntry::Type  type = LogEntry::Error,
const cl7::char_type *const   file_name = NULL,
const unsigned  line_number = 0 
)

Creates a new log entry generated from the given Windows error code and the given type (if specified, default type is Error). Oldest log entries are removed if necessary to satisfy the log limit.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines