Logging and debugguing

Classes and functions that are used for textual output. More...

Data Structures

class  CFixedWidthOutput
 This class provides formatted writing to a text console. More...
 
class  CThreadMsgStream
 This class is used to handle syncronizized output of logging output in a multi-threaded environment. More...
 
class  streamredir
 base class to redirect output streams More...
 
class  vstream
 A output stream to enable certain levels of verbosity. More...
 

Macros

#define cverb   ::mia::vstream::instance()
 define a shortcut to the raw output stream More...
 

Enumerations

enum  vstream::Level {
  vstream::ml_trace, vstream::ml_debug, vstream::ml_info, vstream::ml_message,
  vstream::ml_warning, vstream::ml_fail, vstream::ml_error, vstream::ml_fatal,
  vstream::ml_undefined
}
 

Functions

vstream & cverr ()
 send errors to this stream adapter More...
 
vstream & cvfail ()
 direct output to this stream adapter to print out failtures in tests beyond BOOST_FAIL More...
 
vstream & cvfatal ()
 direct output to this stream adapter to print out fatalities in the code More...
 
vstream & cvinfo ()
 informal output that may be of interest to understand problems with a program and are of higher priority then debugging output. More...
 
vstream & cvmsg ()
 send messages to this stream adapter More...
 
vstream & cvwarn ()
 send warnings to this stream adapter More...
 
template<typename T >
vstream & operator<< (vstream &os, const std::vector< T > &v)
 implements the direct streaming of std::vectors. More...
 
void set_verbose (bool verbose)
 

Variables

EXPORT_CORE const TDictMap< vstream::Level > g_verbose_dict
 Dictonary for the verbosity of the logging as used by –verbose comand line option. More...
 

Detailed Description

Classes and functions that are used for textual output.

Macro Definition Documentation

#define cverb   ::mia::vstream::instance()

define a shortcut to the raw output stream

Definition at line 331 of file msgstream.hh.

Referenced by create_plugin< Handler, Chained, chainable >::apply(), create_plugin< Handler, ProductChained, true >::apply(), and kmeans_step().

Enumeration Type Documentation

Output verbosity level threshhold, ml_trace is the lowest threshhold and ml_fatal the highest. Output is written, when the output threshold is above or equal to the one set within the output stream.

Enumerator
ml_trace 

write trace of function calls and higher, disabled with -DNDEBUG

ml_debug 

write debugging information and higher, disabled with -DNDEBUG

ml_info 

write additional info about the data processed and higher

ml_message 

write process status messages and higher

ml_warning 

write warnings and higher

ml_fail 

write failture messages (for tests) and higher

ml_error 

write non-fatal error messages and higher

ml_fatal 

write only fatal error messages

ml_undefined 

stopper

Definition at line 62 of file msgstream.hh.

Function Documentation

vstream& cverr ( )
inline

send errors to this stream adapter

Definition at line 301 of file msgstream.hh.

References vstream::instance(), vstream::ml_error, and VSTREAM_DOMAIN.

Referenced by TFactory< P >::create().

vstream& cvfail ( )
inline

direct output to this stream adapter to print out failtures in tests beyond BOOST_FAIL

Definition at line 291 of file msgstream.hh.

References vstream::instance(), vstream::ml_fail, and VSTREAM_DOMAIN.

Referenced by TFiltertestFixture< Image >::run().

vstream& cvfatal ( )
inline

direct output to this stream adapter to print out fatalities in the code

Definition at line 281 of file msgstream.hh.

References vstream::instance(), vstream::ml_fatal, and VSTREAM_DOMAIN.

vstream& cvinfo ( )
inline

informal output that may be of interest to understand problems with a program and are of higher priority then debugging output.

Definition at line 252 of file msgstream.hh.

References vstream::instance(), vstream::ml_info, and VSTREAM_DOMAIN.

Referenced by T3DVectorfield< C3DFVector >::get_voxel_size(), and kmeans_step().

vstream& cvwarn ( )
inline

send warnings to this stream adapter

Definition at line 311 of file msgstream.hh.

References vstream::instance(), vstream::ml_warning, and VSTREAM_DOMAIN.

Referenced by CAttributedData::get_attribute_as().

template<typename T >
vstream& operator<< ( vstream &  os,
const std::vector< T > &  v 
)

implements the direct streaming of std::vectors.

Definition at line 338 of file msgstream.hh.

void set_verbose ( bool  verbose)
Parameters
verboseverbose state

Set the cverb ostream in a verbose/non verbose mode depending on the verbose parameter. Currently set_verbose() can be called only one time. If this function is never called the default state of cverb is non-verbose mode

Variable Documentation

EXPORT_CORE const TDictMap<vstream::Level> g_verbose_dict

Dictonary for the verbosity of the logging as used by –verbose comand line option.