IrrIMGUI  0.3.1
Private Attributes | List of all members
IrrIMGUI::Debug::CChannel Class Reference

Puts on every new line that is written to this channel a prefix. More...

#include <IrrIMGUIDebug.h>

Inheritance diagram for IrrIMGUI::Debug::CChannel:
Inheritance graph
[legend]
Collaboration diagram for IrrIMGUI::Debug::CChannel:
Collaboration graph
[legend]

Public Member Functions

Constructor and destructor
 CChannel (std::ostream &rStream, char const *const pPrefix)
 Constructor. More...
 
 CChannel (CChannel const &rCopyChannel)=delete
 Copy Constructor does not exist. More...
 
void setupStream (std::ostream &rStream, bool NextSymbolOnNewLine=true)
 Setups a new stream for output. More...
 
void setupPrefix (char const *const pPrefix)
 Setups a new prefix. More...
 
void disable (void)
 Disables this stream. To enable again call setup. More...
 

Private Attributes

CChannelBuffer mBuffer
 The buffer object where input data are written to. More...
 

Detailed Description

Puts on every new line that is written to this channel a prefix.

Definition at line 108 of file IrrIMGUIDebug.h.

Constructor & Destructor Documentation

IrrIMGUI::Debug::CChannel::CChannel ( std::ostream &  rStream,
char const *const  pPrefix 
)
inline

Constructor.

Parameters
rStreamis the output stream to use.
pPrefixis the prefix to put at the beginning of every new line.

Definition at line 119 of file IrrIMGUIDebug.h.

IrrIMGUI::Debug::CChannel::CChannel ( CChannel const &  rCopyChannel)
delete

Copy Constructor does not exist.

Member Function Documentation

void IrrIMGUI::Debug::CChannel::disable ( void  )
inline

Disables this stream. To enable again call setup.

Definition at line 137 of file IrrIMGUIDebug.h.

void IrrIMGUI::Debug::CChannel::setupPrefix ( char const *const  pPrefix)
inline

Setups a new prefix.

Parameters
pPrefixIs a prefix string that should be added before each new line.

Definition at line 134 of file IrrIMGUIDebug.h.

void IrrIMGUI::Debug::CChannel::setupStream ( std::ostream &  rStream,
bool  NextSymbolOnNewLine = true 
)
inline

Setups a new stream for output.

Parameters
rStreamIs a reference to a output stream.
NextSymbolOnNewLineMust be true, when the next symbol should start at a new line.

Definition at line 130 of file IrrIMGUIDebug.h.

Member Data Documentation

CChannelBuffer IrrIMGUI::Debug::CChannel::mBuffer
private

The buffer object where input data are written to.

Definition at line 143 of file IrrIMGUIDebug.h.


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