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

Stream object which targets a log. More...

#include <OgreLog.h>

+ Collaboration diagram for Ogre::Log::Stream:

Classes

struct  Flush
 Simple type to indicate a flush of the stream to the log. More...
 

Public Member Functions

 Stream (Log *target, LogMessageLevel lml, bool maskDebug)
 
 Stream (const Stream &rhs)
 
 ~Stream ()
 
template<typename T >
Streamoperator<< (const T &v)
 
Streamoperator<< (const Flush &v)
 

Protected Types

typedef StringStream BaseStream
 

Protected Attributes

BaseStream mCache
 
LogMessageLevel mLevel
 
bool mMaskDebug
 
LogmTarget
 

Detailed Description

Stream object which targets a log.

Remarks
A stream logger object makes it simpler to send various things to a log. You can just use the operator<< implementation to stream anything to the log, which is cached until a Stream::Flush is encountered, or the stream itself is destroyed, at which point the cached contents are sent to the underlying log. You can use Log::stream() directly without assigning it to a local variable and as soon as the streaming is finished, the object will be destroyed and the message logged.
You can stream control operations to this object too, such as std::setw() and std::setfill() to control formatting.
Note
Each Stream object is not thread safe, so do not pass it between threads. Multiple threads can hold their own Stream instances pointing at the same Log though and that is threadsafe.

Definition at line 201 of file OgreLog.h.

Member Typedef Documentation

Definition at line 207 of file OgreLog.h.

Constructor & Destructor Documentation

Ogre::Log::Stream::Stream ( Log target,
LogMessageLevel  lml,
bool  maskDebug 
)
inline

Definition at line 215 of file OgreLog.h.

Ogre::Log::Stream::Stream ( const Stream rhs)
inline

Definition at line 221 of file OgreLog.h.

References mCache.

Ogre::Log::Stream::~Stream ( )
inline

Definition at line 227 of file OgreLog.h.

Member Function Documentation

template<typename T >
Stream& Ogre::Log::Stream::operator<< ( const T &  v)
inline

Definition at line 237 of file OgreLog.h.

Stream& Ogre::Log::Stream::operator<< ( const Flush v)
inline

Definition at line 243 of file OgreLog.h.

References Ogre::BLANKSTRING.

Member Data Documentation

BaseStream Ogre::Log::Stream::mCache
protected

Definition at line 208 of file OgreLog.h.

Referenced by Stream().

LogMessageLevel Ogre::Log::Stream::mLevel
protected

Definition at line 205 of file OgreLog.h.

bool Ogre::Log::Stream::mMaskDebug
protected

Definition at line 206 of file OgreLog.h.

Log* Ogre::Log::Stream::mTarget
protected

Definition at line 204 of file OgreLog.h.


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