Public Member Functions | Static Public Member Functions

gdcm::Trace Class Reference

Trace. More...

#include <gdcmTrace.h>

List of all members.

Public Member Functions

 Trace ()
 ~Trace ()

Static Public Member Functions

static void DebugOff ()
static void DebugOn ()
static void ErrorOff ()
static void ErrorOn ()
static bool GetDebugFlag ()
static std::ostream & GetDebugStream ()
static bool GetErrorFlag ()
static std::ostream & GetErrorStream ()
static std::ostream & GetStream ()
static bool GetWarningFlag ()
static std::ostream & GetWarningStream ()
static void SetDebug (bool debug)
 Turn debug messages on (default: false).
static void SetDebugStream (std::ostream &os)
 Explicitely set the stream which receive Debug messages:
static void SetError (bool debug)
 Turn error messages on (default: true).
static void SetErrorStream (std::ostream &os)
 Explicitely set the stream which receive Error messages:
static void SetStream (std::ostream &os)
static void SetStreamToFile (const char *filename)
static void SetWarning (bool debug)
 Turn warning messages on (default: true).
static void SetWarningStream (std::ostream &os)
 Explicitely set the stream which receive Warning messages:
static void WarningOff ()
static void WarningOn ()

Detailed Description

Trace.

Debug / Warning and Error are encapsulated in this class by default the Trace class will redirect any debug/warning/error to std::cerr. Unless SetStream was specified with another (open) stream or SetStreamToFile was specified to a writable file on the system.

Warning:
All string messages are removed during compilation time when compiled with CMAKE_BUILD_TYPE being set to either:
  • Release
  • MinSizeRel It is recommended to compile with RelWithDebInfo and/or Debug during prototyping of applications.

Constructor & Destructor Documentation

gdcm::Trace::Trace (  ) 
gdcm::Trace::~Trace (  ) 

Member Function Documentation

static void gdcm::Trace::DebugOff (  )  [static]
Examples:
TestReader.cxx.
static void gdcm::Trace::DebugOn (  )  [static]
static void gdcm::Trace::ErrorOff (  )  [static]
static void gdcm::Trace::ErrorOn (  )  [static]
static bool gdcm::Trace::GetDebugFlag (  )  [static]
static std::ostream& gdcm::Trace::GetDebugStream (  )  [static]
static bool gdcm::Trace::GetErrorFlag (  )  [static]
static std::ostream& gdcm::Trace::GetErrorStream (  )  [static]
static std::ostream& gdcm::Trace::GetStream (  )  [static]
static bool gdcm::Trace::GetWarningFlag (  )  [static]
static std::ostream& gdcm::Trace::GetWarningStream (  )  [static]
static void gdcm::Trace::SetDebug ( bool  debug  )  [static]

Turn debug messages on (default: false).

Examples:
DumpToSQLITE3.cxx.
static void gdcm::Trace::SetDebugStream ( std::ostream &  os  )  [static]

Explicitely set the stream which receive Debug messages:

static void gdcm::Trace::SetError ( bool  debug  )  [static]

Turn error messages on (default: true).

static void gdcm::Trace::SetErrorStream ( std::ostream &  os  )  [static]

Explicitely set the stream which receive Error messages:

Examples:
CStoreQtProgress.cxx.
static void gdcm::Trace::SetStream ( std::ostream &  os  )  [static]

Explicitely set the ostream for gdcm::Trace to report to This will set the DebugStream, WarningStream and ErrorStream at once:

static void gdcm::Trace::SetStreamToFile ( const char *  filename  )  [static]

Explicitely set the filename for gdcm::Trace to report to The file will be created (it will not append to existing file)

static void gdcm::Trace::SetWarning ( bool  debug  )  [static]

Turn warning messages on (default: true).

Examples:
DumpToSQLITE3.cxx.
static void gdcm::Trace::SetWarningStream ( std::ostream &  os  )  [static]

Explicitely set the stream which receive Warning messages:

static void gdcm::Trace::WarningOff (  )  [static]
Examples:
TestReader.cxx.
static void gdcm::Trace::WarningOn (  )  [static]

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

Generated on Mon Jul 29 2013 11:24:37 for GDCM by doxygen 1.7.1
SourceForge.net Logo