Ogre::LogManager Class Reference

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

#include <OgreLogManager.h>

Inheritance diagram for Ogre::LogManager:

Public Member Functions
	LogManager ()
	~LogManager ()
Log *	createLog (const String &name, bool defaultLog=false, bool debuggerOutput=true, bool suppressFileOutput=false)
	Creates a new log with the given name. More...
void	destroyLog (const String &name)
	Closes and removes a named log. More...
void	destroyLog (Log *log)
	Closes and removes a log. More...
Log *	getDefaultLog ()
	Returns a pointer to the default log. More...
Log *	getLog (const String &name)
	Retrieves a log managed by this class. More...
void	logMessage (const String &message, LogMessageLevel lml=LML_NORMAL, bool maskDebug=false)
	Log a message to the default log. More...
void	logMessage (LogMessageLevel lml, const String &message, bool maskDebug=false)
	Log a message to the default log (signature for backward compatibility). More...
Log *	setDefaultLog (Log *newLog)
	Sets the passed in log as the default log. More...
void	setLogDetail (LoggingLevel ll)
	Sets the level of detail of the default log. More...
Log::Stream	stream (LogMessageLevel lml=LML_NORMAL, bool maskDebug=false)
	Get a stream on the default log. More...
Public Member Functions inherited from Ogre::Singleton< LogManager >
	Singleton ()
	~Singleton ()

Static Public Member Functions
static LogManager &	getSingleton ()
	Override standard Singleton retrieval. More...
static LogManager *	getSingletonPtr ()
	Override standard Singleton retrieval. More...
Static Public Member Functions inherited from Ogre::Singleton< LogManager >
static LogManager &	getSingleton ()
static LogManager *	getSingletonPtr ()

Public Attributes
	OGRE_AUTO_MUTEX

Detailed Description

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

Remarks

This class will create new log files and will retrieve instances of existing ones. Other classes wishing to log output can either create a fresh log or retrieve an existing one to output to. One log is the default log, and is the one written to when the logging methods of this class are called.

By default, Root will instantiate a LogManager (which becomes the Singleton instance) on construction, and will create a default log based on the Root construction parameters. If you want more control, for example redirecting log output right from the start or suppressing debug output, you need to create a LogManager yourself before creating a Root instance, then create a default log. Root will detect that you've created one yourself and won't create one of its own, thus using all your logging preferences from the first instance.

Constructor & Destructor Documentation

LogManager()

Ogre::LogManager::LogManager

(

)

~LogManager()

Ogre::LogManager::~LogManager

(

)

Member Function Documentation

createLog()

Log* Ogre::LogManager::createLog	(	const String &	name,
		bool	defaultLog = false,
		bool	debuggerOutput = true,
		bool	suppressFileOutput = false
	)

Creates a new log with the given name.

Parameters

name	The name to give the log e.g. 'Ogre.log'
defaultLog	If true, this is the default log output will be sent to if the generic logging methods on this class are used. The first log created is always the default log unless this parameter is set.
debuggerOutput	If true, output to this log will also be routed to the debugger's output window.
suppressFileOutput	If true, this is a logical rather than a physical log and no file output will be written. If you do this you should register a LogListener so log output is not lost.

destroyLog() [1/2]

void Ogre::LogManager::destroyLog

(

const String &

name

)

Closes and removes a named log.

destroyLog() [2/2]

void Ogre::LogManager::destroyLog

(

Log *

log

)

Closes and removes a log.

getDefaultLog()

Log* Ogre::LogManager::getDefaultLog

(

)

Returns a pointer to the default log.

getLog()

Log* Ogre::LogManager::getLog

(

const String &

name

)

Retrieves a log managed by this class.

getSingleton()

static LogManager& Ogre::LogManager::getSingleton ( )

static

Override standard Singleton retrieval.

Remarks

Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

getSingletonPtr()

static LogManager* Ogre::LogManager::getSingletonPtr ( )

static

Override standard Singleton retrieval.

Remarks

Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

logMessage() [1/2]

void Ogre::LogManager::logMessage	(	const String &	message,
		LogMessageLevel	lml = LML_NORMAL,
		bool	maskDebug = false
	)

Log a message to the default log.

logMessage() [2/2]

void Ogre::LogManager::logMessage ( LogMessageLevel  lml, const String &  message, bool  maskDebug = false  )

inline

Log a message to the default log (signature for backward compatibility).

setDefaultLog()

Log* Ogre::LogManager::setDefaultLog

(

Log *

newLog

)

Sets the passed in log as the default log.

Returns

The previous default log.

setLogDetail()

void Ogre::LogManager::setLogDetail

(

LoggingLevel

ll

)

Sets the level of detail of the default log.

stream()

Log::Stream Ogre::LogManager::stream	(	LogMessageLevel	lml = LML_NORMAL,
		bool	maskDebug = false
	)

Get a stream on the default log.

Member Data Documentation

OGRE_AUTO_MUTEX

Ogre::LogManager::OGRE_AUTO_MUTEX

---

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

• OgreLogManager.h