About
User Reference
C++ API
luafaudes
Developer
Links
libFAUDES online
libFAUDES

Sections

Index

faudes::ConsoleOut Class Reference

Console Out. More...

#include <cfl_helper.h>

List of all members.

Public Member Functions

void Write (const std::string &message)
 Write a std::string message.
std::ostream & Buffer (void)
 Retrieve buffer to write on.
void Flush (long int cntnow=0, long int cntdone=0)
 Flush buffer to output, optional progress estimate.
void ToFile (const std::string &filename)
 Redirect to file.
const std::string & Filename (void)
 Query filename.
void Redirect (ConsoleOut *out)
 Redirect.
void Mute (bool on)
 Mute.

Static Public Member Functions

static ConsoleOutG (void)
 acess static instance

Protected Member Functions

 ConsoleOut (void)
 Constructor.
virtual ~ConsoleOut (void)
 Destructor.
virtual void DoWrite (long int cntnow, long int cntdone, const std::string &message)
 Writing hook.

Private Attributes

std::ostringstream mLineBuffer
 Private line buffer.
std::ofstream * pStream
 Private output stream.
std::string mFilename
 Private record file name.
bool mMute
 Mute flag.

Static Private Attributes

static ConsoleOutspInstance = NULL
 Private static instance.

Detailed Description

Console Out.

All console out messages (errors, progress report etc) are meant to use the global ConsoleOut instance gConsoleOut, preumably using the convenience macro FAUDES_WRITE_CONSOLE(). The default gConsoleOut provides redirection to a named file by gConsoleOut.ToFile("filename"). libFAUDES Applications can use this construct in deriving a specialised class from ConsoleOut to grab and inspect all console output.

Definition at line 298 of file cfl_helper.h.


Constructor & Destructor Documentation

faudes::ConsoleOut::ConsoleOut ( void   )  [protected]

Constructor.

Definition at line 323 of file cfl_helper.cpp.

faudes::ConsoleOut::~ConsoleOut ( void   )  [protected, virtual]

Destructor.

Definition at line 325 of file cfl_helper.cpp.


Member Function Documentation

std::ostream & faudes::ConsoleOut::Buffer ( void   ) 

Retrieve buffer to write on.

Definition at line 356 of file cfl_helper.cpp.

void faudes::ConsoleOut::DoWrite ( long int  cntnow,
long int  cntdone,
const std::string &  message 
) [protected, virtual]

Writing hook.

Re-implement this function in order to grab all output

Definition at line 363 of file cfl_helper.cpp.

const std::string& faudes::ConsoleOut::Filename ( void   )  [inline]

Query filename.

Definition at line 309 of file cfl_helper.h.

void faudes::ConsoleOut::Flush ( long int  cntnow = 0,
long int  cntdone = 0 
)

Flush buffer to output, optional progress estimate.

Definition at line 359 of file cfl_helper.cpp.

ConsoleOut * faudes::ConsoleOut::G ( void   )  [static]

acess static instance

Definition at line 329 of file cfl_helper.cpp.

void faudes::ConsoleOut::Mute ( bool  on  )  [inline]

Mute.

Definition at line 315 of file cfl_helper.h.

void faudes::ConsoleOut::Redirect ( ConsoleOut out  ) 

Redirect.

Definition at line 333 of file cfl_helper.cpp.

void faudes::ConsoleOut::ToFile ( const std::string &  filename  ) 

Redirect to file.

Definition at line 343 of file cfl_helper.cpp.

void faudes::ConsoleOut::Write ( const std::string &  message  ) 

Write a std::string message.

Definition at line 351 of file cfl_helper.cpp.


Member Data Documentation

std::string faudes::ConsoleOut::mFilename [private]

Private record file name.

Definition at line 329 of file cfl_helper.h.

std::ostringstream faudes::ConsoleOut::mLineBuffer [private]

Private line buffer.

Definition at line 325 of file cfl_helper.h.

bool faudes::ConsoleOut::mMute [private]

Mute flag.

Definition at line 331 of file cfl_helper.h.

std::ofstream* faudes::ConsoleOut::pStream [private]

Private output stream.

Definition at line 327 of file cfl_helper.h.

ConsoleOut * faudes::ConsoleOut::spInstance = NULL [static, private]

Private static instance.

Definition at line 333 of file cfl_helper.h.


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

libFAUDES 2.20d --- 2011.04.26 --- c++ source docu by doxygen