Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

Ogre::Log Class Reference

#include <OgreLog.h>

List of all members.

Public Member Functions

OGRE_AUTO_MUTEX Log (const String &name, bool debugOutput=true, bool suppressFileOutput=false)
 ~Log ()
const StringgetName () const
 Return the name of the log.
bool isDebugOutputEnabled () const
 Get whether debug output is enabled for this log.
bool isFileOutputSuppressed () const
 Get whether file output is suppressed for this log.
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>"),.
void setLogDetail (LoggingLevel ll)
LoggingLevel getLogDetail () const
 Gets the level of the log detail.
void addListener (LogListener *listener)
void removeListener (LogListener *listener)

Protected Types

typedef std::vector< LogListener * > mtLogListener

Protected Attributes

std::ofstream mfpLog
LoggingLevel mLogLevel
bool mDebugOut
bool mSuppressFile
String mLogName
mtLogListener mListeners


Detailed Description

Remarks:
Log class for writing debug/log data to files.
Note:

Should not be used directly, but trough the LogManager class.

Definition at line 85 of file OgreLog.h.


Member Typedef Documentation

typedef std::vector<LogListener*> Ogre::Log::mtLogListener [protected]
 

Definition at line 94 of file OgreLog.h.


Constructor & Destructor Documentation

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

Remarks:
Usual constructor - called by LogManager.

Ogre::Log::~Log  ) 
 

Remarks:
Default destructor.


Member Function Documentation

void Ogre::Log::addListener LogListener listener  ) 
 

Remarks:
Register a listener to this log
Parameters:
A valid listener derived class

LoggingLevel Ogre::Log::getLogDetail  )  const
 

Gets the level of the log detail.

Definition at line 130 of file OgreLog.h.

const String& Ogre::Log::getName  )  const
 

Return the name of the log.

Definition at line 112 of file OgreLog.h.

bool Ogre::Log::isDebugOutputEnabled  )  const
 

Get whether debug output is enabled for this log.

Definition at line 114 of file OgreLog.h.

bool Ogre::Log::isFileOutputSuppressed  )  const
 

Get whether file output is suppressed for this log.

Definition at line 116 of file OgreLog.h.

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>"),.

void Ogre::Log::removeListener LogListener listener  ) 
 

Remarks:
Unregister a listener from this log
Parameters:
A valid listener derived class

void Ogre::Log::setLogDetail LoggingLevel  ll  ) 
 

Remarks:
Sets the level of the log detail.


Member Data Documentation

bool Ogre::Log::mDebugOut [protected]
 

Definition at line 90 of file OgreLog.h.

std::ofstream Ogre::Log::mfpLog [protected]
 

Definition at line 88 of file OgreLog.h.

mtLogListener Ogre::Log::mListeners [protected]
 

Definition at line 95 of file OgreLog.h.

LoggingLevel Ogre::Log::mLogLevel [protected]
 

Definition at line 89 of file OgreLog.h.

String Ogre::Log::mLogName [protected]
 

Definition at line 92 of file OgreLog.h.

bool Ogre::Log::mSuppressFile [protected]
 

Definition at line 91 of file OgreLog.h.


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

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jul 8 15:21:16 2007