faudes::ConsoleOut Class Reference

Console Out. More...

#include <cfl_helper.h>

List of all members.

Public Member Functions

virtual void Write (const std::string &message, long int cntnow=0, long int cntdone=0)
 Write a std::string message (optional progress report).
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.
bool Mute ()

Static Public Member Functions

static ConsoleOutG (void)
 Acess static instance.

Protected Member Functions

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

Private Attributes

std::ofstream * pStream
 Private output stream.
std::string mFilename
 Private record file name.
bool mMute
 Mute flag.
ConsoleOutpInstance
 Redirect.

Static Private Attributes

static ConsoleOutsmpInstance = 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, presumably using the convenience macro FAUDES_WRITE_CONSOLE(). The default ConsoleOut::G() provides optional redirection to a named file by G()->ConsoleOut.ToFile("filename").

libFAUDES applications can use this construct to grab all console output by 1) deriving a specialised class from ConsoleOut and 2) redirection by ConsoleOut::G()->Redirect(derived_class_instance).

Definition at line 323 of file cfl_helper.h.


Constructor & Destructor Documentation

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

Constructor.

Definition at line 341 of file cfl_helper.cpp.

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

Destructor.

Definition at line 344 of file cfl_helper.cpp.


Member Function Documentation

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

Writing hook.

Re-implement this function in order to grab all output

Definition at line 371 of file cfl_helper.cpp.

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

Query filename.

Definition at line 332 of file cfl_helper.h.

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

Acess static instance.

Definition at line 348 of file cfl_helper.cpp.

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

Definition at line 337 of file cfl_helper.h.

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

Mute.

Definition at line 336 of file cfl_helper.h.

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

Redirect.

Definition at line 352 of file cfl_helper.cpp.

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

Redirect to file.

Definition at line 359 of file cfl_helper.cpp.

void faudes::ConsoleOut::Write ( const std::string &  message,
long int  cntnow = 0,
long int  cntdone = 0 
) [virtual]

Write a std::string message (optional progress report).

Definition at line 367 of file cfl_helper.cpp.


Member Data Documentation

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

Private record file name.

Definition at line 349 of file cfl_helper.h.

bool faudes::ConsoleOut::mMute [private]

Mute flag.

Definition at line 351 of file cfl_helper.h.

Redirect.

Definition at line 353 of file cfl_helper.h.

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

Private output stream.

Definition at line 347 of file cfl_helper.h.

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

Private static instance.

Definition at line 355 of file cfl_helper.h.


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

libFAUDES 2.23h --- 2014.04.03 --- c++ api documentaion by doxygen