engine::LogManager Class Reference

The log manager handles the creation and retrieval of logs for the application. More...

#include <LogManager.h>

Inheritance diagram for engine::LogManager:

List of all members.

Public Member Functions
Log *	createLog (const std::string &fileName, bool defaultLog=false)
	Creates a log to be managed by log manager.
Log *	createLog (const std::string &name, const std::string &fileName, bool defaultLog=false)
Log *	getDefaultLog ()
	Gets the default log.
Log *	getLog (const u32 &id)
	Retrieves a pointer to a log by id.
LogLevel	getLogLevel ()
	Gets the log level.
u32	getNumberOfLogs () const
	Retrieves the total number of created logs.
	LogManager ()
void	logMessage (const std::string &source, const std::string &text, LogLevel ll=LL_INFORMATION)
void	popLog ()
	Pop a log from the logs stack.
void	pushLog (const u32 &id)
	Push a log in the logs stack.
void	pushLog (Log *log)
	Push a log in the logs stack.
void	removeAllLogs ()
void	removeLog (Log *log)
	Removes a log.
void	removeLog (const u32 &id)
	Removes a log.
void	setDefaultLog (Log *log)
	Sets the default log.
void	setLogLevel (LogLevel ll)
	~LogManager ()
Static Public Member Functions
static LogManager *	getInstance ()
	Get instance.
Protected Attributes
Log *	mDefaultLog
	Default log.
LogLevel	mLogLevel
	Current log level.
std::map< u32, Log * >	mLogs
	Central list of Logs - for easy memory management.
std::list< Log * >	mLogsList
	List for push and pop logs.

---

Detailed Description

The log manager handles the creation and retrieval of logs for the application.

---

Constructor & Destructor Documentation

engine::LogManager::LogManager

(

)

References engine::LL_INFORMATION, mDefaultLog, mLogLevel, engine::Object::mObjectType, and engine::OT_LOG_MANAGER.

engine::LogManager::~LogManager

(

)

---

Member Function Documentation

Log * engine::LogManager::createLog	(	const std::string &	fileName,
		bool	defaultLog = false
	)

Creates a log to be managed by log manager.

References engine::Object::getID().

Referenced by engine::EngineManager::EngineManager().

Log * engine::LogManager::createLog	(	const std::string &	name,
		const std::string &	fileName,
		bool	defaultLog = false
	)

References engine::Object::getID().

Log * engine::LogManager::getDefaultLog

(

)

Gets the default log.

LogManager * engine::LogManager::getInstance

(

)

[static]

Get instance.

Reimplemented from core::Singleton< LogManager >.

Referenced by resource::FileDataStream::FileDataStream(), engine::Plugin::load(), resource::Serializer::readFileHeader(), render::Shader::setAutoParamerter(), engine::Plugin::unload(), and render::VertexBufferBinding::unsetBinding().

Log * engine::LogManager::getLog

(

const u32 &

id

)

Retrieves a pointer to a log by id.

LogLevel engine::LogManager::getLogLevel

(

)

Gets the log level.

u32 engine::LogManager::getNumberOfLogs

(

)

const

Retrieves the total number of created logs.

void engine::LogManager::logMessage	(	const std::string &	source,
		const std::string &	text,
		LogLevel	ll = LL_INFORMATION
	)

Log a message a text into the log

Parameters:

source,:	The source form were this log is sent.
text,:	Text to print out.
ll,:	Log level of the text.

Referenced by engine::EngineManager::EngineManager(), engine::EngineManager::initializeImpl(), engine::Plugin::load(), engine::EngineManager::start(), engine::EngineManager::stop(), engine::EngineManager::uninitializeImpl(), engine::Plugin::unload(), and engine::EngineManager::~EngineManager().

void engine::LogManager::popLog

(

)

Pop a log from the logs stack.

void engine::LogManager::pushLog

(

const u32 &

id

)

Push a log in the logs stack.

References core::log().

void engine::LogManager::pushLog

(

Log *

log

)

Push a log in the logs stack.

References engine::Object::getID(), and core::log().

void engine::LogManager::removeAllLogs

(

)

void engine::LogManager::removeLog

(

Log *

log

)

Removes a log.

References engine::Object::getID().

void engine::LogManager::removeLog

(

const u32 &

id

)

Removes a log.

void engine::LogManager::setDefaultLog

(

Log *

log

)

Sets the default log.

void engine::LogManager::setLogLevel

(

LogLevel

ll

)

Sets a new log level. With this value, texts which are sent to the logger are filtered out.

---

Member Data Documentation

Log* engine::LogManager::mDefaultLog [protected]

Default log.

Referenced by LogManager().

LogLevel engine::LogManager::mLogLevel [protected]

Current log level.

Referenced by LogManager().

std::map<u32, Log*> engine::LogManager::mLogs [protected]

Central list of Logs - for easy memory management.

std::list<Log*> engine::LogManager::mLogsList [protected]

List for push and pop logs.

---

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

• E:/Programming/MyProject/K_Game_hg/GameEngine/include/engine/LogManager.h
• E:/Programming/MyProject/K_Game_hg/GameEngine/src/engine/LogManager.cpp