OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::Log Class Reference

#include <OgreLog.h>

+ Inheritance diagram for Ogre::Log:
+ Collaboration 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)
 
 ~Log ()
 
void addListener (LogListener *listener)
 
LoggingLevel getLogDetail () 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 operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
void removeListener (LogListener *listener)
 
void setDebugOutputEnabled (bool debugOutput)
 
void setLogDetail (LoggingLevel ll)
 
void setTimeStampEnabled (bool timeStamp)
 
Stream stream (LogMessageLevel lml=LML_NORMAL, bool maskDebug=false)
 Get a stream object targeting this log. More...
 

Public Attributes

 OGRE_AUTO_MUTEX
 

Protected Types

typedef vector< LogListener * >
::type 
mtLogListener
 

Protected Attributes

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

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 103 of file OgreLog.h.

Member Typedef Documentation

typedef vector<LogListener*>::type Ogre::Log::mtLogListener
protected

Definition at line 113 of file OgreLog.h.

Constructor & Destructor Documentation

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
listenerA valid listener derived class
LoggingLevel Ogre::Log::getLogDetail ( ) const
inline

Gets the level of the log detail.

Definition at line 166 of file OgreLog.h.

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

Return the name of the log.

Definition at line 133 of file OgreLog.h.

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

Get whether debug output is enabled for this log.

Definition at line 135 of file OgreLog.h.

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

Get whether file output is suppressed for this log.

Definition at line 137 of file OgreLog.h.

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

Get whether time stamps are printed for this log.

Definition at line 139 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>"),.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

void Ogre::Log::removeListener ( LogListener listener)
Remarks
Unregister a listener from this log
Parameters
listenerA valid listener derived class
void Ogre::Log::setDebugOutputEnabled ( bool  debugOutput)
Remarks
Enable or disable outputting log messages to the debugger.
void Ogre::Log::setLogDetail ( LoggingLevel  ll)
Remarks
Sets the level of the log detail.
void Ogre::Log::setTimeStampEnabled ( bool  timeStamp)
Remarks
Enable or disable time stamps.
Stream Ogre::Log::stream ( LogMessageLevel  lml = LML_NORMAL,
bool  maskDebug = false 
)

Get a stream object targeting this log.

Member Data Documentation

bool Ogre::Log::mDebugOut
protected

Definition at line 108 of file OgreLog.h.

mtLogListener Ogre::Log::mListeners
protected

Definition at line 114 of file OgreLog.h.

std::ofstream Ogre::Log::mLog
protected

Definition at line 106 of file OgreLog.h.

LoggingLevel Ogre::Log::mLogLevel
protected

Definition at line 107 of file OgreLog.h.

String Ogre::Log::mLogName
protected

Definition at line 111 of file OgreLog.h.

bool Ogre::Log::mSuppressFile
protected

Definition at line 109 of file OgreLog.h.

bool Ogre::Log::mTimeStamp
protected

Definition at line 110 of file OgreLog.h.

Ogre::Log::OGRE_AUTO_MUTEX

Definition at line 117 of file OgreLog.h.


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