OGRE  13.6
Object-Oriented Graphics Rendering Engine
Ogre::Log Class Reference

Log class for writing debug/log data to files. More...

#include <OgreLog.h>

+ Inheritance diagram for Ogre::Log:

Classes

class  Stream
 Stream object which targets a log. More...
 

Public Member Functions

 Log (const String &name, bool debugOutput=true, bool suppressFileOutput=false)
 Usual constructor - called by LogManager. More...
 
 ~Log ()
 Default destructor. More...
 
void addListener (LogListener *listener)
 Register a listener to this log. More...
 
LogMessageLevel getMinLogLevel () const
 Gets the level of the log detail. More...
 
const StringgetName () const
 Return the name of the log. More...
 
bool isDebugOutputEnabled () const
 Get whether debug output is enabled for this log. More...
 
bool isFileOutputSuppressed () const
 Get whether file output is suppressed for this log. More...
 
bool isTimeStampEnabled () const
 Get whether time stamps are printed for this log. More...
 
void logMessage (const String &message, LogMessageLevel lml=LML_NORMAL, bool maskDebug=false)
 Log a message to the debugger and to log file (the default is "<code>OGRE.log</code>"),. More...
 
void removeListener (LogListener *listener)
 Unregister a listener from this log. More...
 
void setDebugOutputEnabled (bool debugOutput)
 Enable or disable outputting log messages to the debugger. More...
 
void setLogDetail (LoggingLevel ll)
 
void setMinLogLevel (LogMessageLevel lml)
 set the minimal LogMessageLevel for a message to be logged More...
 
void setTimeStampEnabled (bool timeStamp)
 Enable or disable time stamps. More...
 
Stream stream (LogMessageLevel lml=LML_NORMAL, bool maskDebug=false)
 Get a stream object targeting this log. More...
 

Detailed Description

Log class for writing debug/log data to files.

You can control the default log level through the OGRE_MIN_LOGLEVEL environment variable. Here, the value 1 corresponds to LML_TRIVIAL etc.

Note
Should not be used directly, but through the LogManager class.

Constructor & Destructor Documentation

◆ Log()

Ogre::Log::Log ( const String name,
bool  debugOutput = true,
bool  suppressFileOutput = false 
)

Usual constructor - called by LogManager.

◆ ~Log()

Ogre::Log::~Log ( )

Default destructor.

Member Function Documentation

◆ getName()

const String& Ogre::Log::getName ( void  ) const
inline

Return the name of the log.

◆ isDebugOutputEnabled()

bool Ogre::Log::isDebugOutputEnabled ( ) const
inline

Get whether debug output is enabled for this log.

◆ isFileOutputSuppressed()

bool Ogre::Log::isFileOutputSuppressed ( ) const
inline

Get whether file output is suppressed for this log.

◆ isTimeStampEnabled()

bool Ogre::Log::isTimeStampEnabled ( ) const
inline

Get whether time stamps are printed for this log.

◆ logMessage()

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

Log a message to the debugger and to log file (the default is "<code>OGRE.log</code>"),.

Referenced by Ogre::Log::Stream::~Stream(), and Ogre::Log::Stream::operator<<().

◆ stream()

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

Get a stream object targeting this log.

◆ setDebugOutputEnabled()

void Ogre::Log::setDebugOutputEnabled ( bool  debugOutput)

Enable or disable outputting log messages to the debugger.

◆ setLogDetail()

void Ogre::Log::setLogDetail ( LoggingLevel  ll)

◆ setMinLogLevel()

void Ogre::Log::setMinLogLevel ( LogMessageLevel  lml)

set the minimal LogMessageLevel for a message to be logged

◆ setTimeStampEnabled()

void Ogre::Log::setTimeStampEnabled ( bool  timeStamp)

Enable or disable time stamps.

◆ getMinLogLevel()

LogMessageLevel Ogre::Log::getMinLogLevel ( ) const
inline

Gets the level of the log detail.

◆ addListener()

void Ogre::Log::addListener ( LogListener listener)

Register a listener to this log.

Parameters
listenerA valid listener derived class

◆ removeListener()

void Ogre::Log::removeListener ( LogListener listener)

Unregister a listener from this log.

Parameters
listenerA valid listener derived class

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