GDCM 3.0.24
Public Member Functions | Static Public Member Functions | List of all members
gdcm::Trace Class Reference

Trace. More...

#include <gdcmTrace.h>

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)
 Explicitly set the stream which receive Debug messages:
 
static void SetError (bool debug)
 Turn error messages on (default: true)
 
static void SetErrorStream (std::ostream &os)
 Explicitly 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)
 Explicitly 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.
Examples
DecompressJPEGFile.cs.

Constructor & Destructor Documentation

◆ Trace()

gdcm::Trace::Trace ( )

◆ ~Trace()

gdcm::Trace::~Trace ( )

Member Function Documentation

◆ DebugOff()

static void gdcm::Trace::DebugOff ( )
static

◆ DebugOn()

static void gdcm::Trace::DebugOn ( )
static

◆ ErrorOff()

static void gdcm::Trace::ErrorOff ( )
static

◆ ErrorOn()

static void gdcm::Trace::ErrorOn ( )
static

◆ GetDebugFlag()

static bool gdcm::Trace::GetDebugFlag ( )
static

◆ GetDebugStream()

static std::ostream & gdcm::Trace::GetDebugStream ( )
static

◆ GetErrorFlag()

static bool gdcm::Trace::GetErrorFlag ( )
static

◆ GetErrorStream()

static std::ostream & gdcm::Trace::GetErrorStream ( )
static

◆ GetStream()

static std::ostream & gdcm::Trace::GetStream ( )
static

◆ GetWarningFlag()

static bool gdcm::Trace::GetWarningFlag ( )
static

◆ GetWarningStream()

static std::ostream & gdcm::Trace::GetWarningStream ( )
static

◆ SetDebug()

static void gdcm::Trace::SetDebug ( bool  debug)
static

Turn debug messages on (default: false)

Examples
DumpToSQLITE3.cxx.

◆ SetDebugStream()

static void gdcm::Trace::SetDebugStream ( std::ostream &  os)
static

Explicitly set the stream which receive Debug messages:

◆ SetError()

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

Turn error messages on (default: true)

◆ SetErrorStream()

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

Explicitly set the stream which receive Error messages:

Examples
CStoreQtProgress.cxx.

◆ SetStream()

static void gdcm::Trace::SetStream ( std::ostream &  os)
static

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

◆ SetStreamToFile()

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

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

◆ SetWarning()

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

Turn warning messages on (default: true)

Examples
DumpToSQLITE3.cxx.

◆ SetWarningStream()

static void gdcm::Trace::SetWarningStream ( std::ostream &  os)
static

Explicitly set the stream which receive Warning messages:

◆ WarningOff()

static void gdcm::Trace::WarningOff ( )
static

◆ WarningOn()

static void gdcm::Trace::WarningOn ( )
static

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