DataDirector API
Public Member Functions | Static Public Member Functions | List of all members
DDD_Log Class Reference

Central logging class. Handles all of the logic for registering/unregistering observers, accepting log entries, and notifying log observers. More...

#include <DDD_Log.h>

Public Member Functions

virtual ~DDD_Log ()
 
void LogDebug (const char *entry)
 
void LogInfo (const char *entry)
 
void LogWarning (const char *entry)
 
void LogError (const char *entry)
 
void LogEntry (const char *entry, DDD_LogEntry::LogLevel level)
 
void AddObserver (DDD_LogObserver *observer)
 
void RemoveObserver (DDD_LogObserver *observer)
 
void Shutdown ()
 

Static Public Member Functions

static DDD_LogInstance ()
 

Detailed Description

Central logging class. Handles all of the logic for registering/unregistering observers, accepting log entries, and notifying log observers.

Constructor & Destructor Documentation

virtual ~DDD_Log ( )
virtual

Destructor.

Member Function Documentation

void AddObserver ( DDD_LogObserver observer)

Add Log Observer

Parameters
observerPointer to a LogObserver (must not be NULL)
static DDD_Log& Instance ( )
static

Singleton interface

Returns
reference to static DDD_LogFacade object
void LogDebug ( const char *  entry)

Convenient LogEntry() wrapper for logging general information.

Parameters
entryThe logged entry string
void LogEntry ( const char *  entry,
DDD_LogEntry::LogLevel  level 
)

Log Entry to log observers. This method notifies every log observer.

Parameters
entryThe logged entry string
levelThe logged entry level
void LogError ( const char *  entry)

Convenient LogEntry() wrapper for logging errors.

Parameters
entryThe logged entry string
void LogInfo ( const char *  entry)

Convenient LogEntry() wrapper for logging general information.

Parameters
entryThe logged entry string
void LogWarning ( const char *  entry)

Convenient LogEntry() wrapper for logging warnings.

Parameters
entryThe logged entry string
void RemoveObserver ( DDD_LogObserver observer)

Remove Log Observer

Parameters
observerPointer to a LogObserver
void Shutdown ( )

Shutdown logger; simply clears observers list


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