FIFE  2008.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
FIFE::LogManager Class Reference

#include <logger.h>

Collaboration diagram for FIFE::LogManager:
Collaboration graph

Public Types

enum  LogLevel

Public Member Functions

 ~LogManager ()
void log (LogLevel level, logmodule_t module, const std::string &msg)
void setLevelFilter (LogLevel level)
LogLevel getLevelFilter ()
void addVisibleModule (logmodule_t module)
void removeVisibleModule (logmodule_t module)
void clearVisibleModules ()
bool isVisible (logmodule_t module)
void setLogToPrompt (bool log_to_promt)
bool isLoggingToPrompt ()
void setLogToFile (bool logtofile)
bool isLoggingToFile ()
std::string getModuleName (logmodule_t module)

Static Public Member Functions

static LogManagerinstance ()

Detailed Description

Logmanager takes care of log filtering and output direction

Definition at line 99 of file logger.h.

Member Enumeration Documentation

Loglevel is used to set a treshold for output messages + related filter E.g. in case log message has LEVEL_WARN, but the filter treshold is LEVEL_ERROR, log message is not outputted

Definition at line 105 of file logger.h.

Constructor & Destructor Documentation

FIFE::LogManager::~LogManager ( )

Destructor

Definition at line 72 of file logger.cpp.

Member Function Documentation

void FIFE::LogManager::addVisibleModule ( logmodule_t  module)

Adds visible module into logmanager Module corresponds some module in the engine. Modules may contain other modules. Modules and their structure is defined in file modules.h. In case module is not visible, LogManager filters corresponding log messages from output. In case some lower-level module is set visible, it also sets all upper level modules visible

Parameters
modulemodule to set visible

Definition at line 123 of file logger.cpp.

void FIFE::LogManager::clearVisibleModules ( )

Removes all visible modules,

See Also
addVisibleModule

Definition at line 137 of file logger.cpp.

LogManager::LogLevel FIFE::LogManager::getLevelFilter ( )

Gets currently used level filter.

See Also
LogManager::LogLevel

Definition at line 119 of file logger.cpp.

std::string FIFE::LogManager::getModuleName ( logmodule_t  module)

Gets display name for given module id E.g. LM_AUDIO -> "Audio"

Definition at line 216 of file logger.cpp.

LogManager * FIFE::LogManager::instance ( )
static

Returns instance to log manager. Log manager is a singleton class

Definition at line 65 of file logger.cpp.

Referenced by FIFE::Engine::Engine(), and FIFE::Logger::log().

Here is the caller graph for this function:

bool FIFE::LogManager::isLoggingToFile ( )

Tells if LogManager is set to log to a file

Definition at line 163 of file logger.cpp.

bool FIFE::LogManager::isLoggingToPrompt ( )

Tells if LogManager is set to log to prompt

Definition at line 147 of file logger.cpp.

bool FIFE::LogManager::isVisible ( logmodule_t  module)

Tells if given module is visible

Definition at line 167 of file logger.cpp.

Referenced by log().

Here is the caller graph for this function:

void FIFE::LogManager::log ( LogLevel  level,
logmodule_t  module,
const std::string &  msg 
)

Logs given message

Parameters
levellevel of this log (e.g. warning)
modulemodule where this log message is coming from. Modules are defined in modules.h-file
msgmessage to log
Note
do not use this method directly, instead use FL_WARN (or any other FL_XXX) macro

Definition at line 77 of file logger.cpp.

References isVisible().

Referenced by FIFE::Logger::log().

Here is the caller graph for this function:

void FIFE::LogManager::removeVisibleModule ( logmodule_t  module)

Removes visible module,

See Also
addVisibleModule

Definition at line 132 of file logger.cpp.

void FIFE::LogManager::setLevelFilter ( LogLevel  level)

Sets currently used level filter. For usage,

See Also
LogManager::LogLevel

Definition at line 115 of file logger.cpp.

void FIFE::LogManager::setLogToFile ( bool  logtofile)

Sets LogManager to log to a file

Definition at line 151 of file logger.cpp.

void FIFE::LogManager::setLogToPrompt ( bool  log_to_promt)

Sets LogManager to log to prompt

Definition at line 143 of file logger.cpp.


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