Program: gdcm
Module: $RCSfile: gdcmDebug.h,v $
Language: C++
- Date: $Date: 2005/02/01 10:29:54 $
- Version: $Revision: 1.27 $
+ Date: $Date: 2005/06/14 19:22:13 $
+ Version: $Revision: 1.34 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
//-----------------------------------------------------------------------------
/**
- * \ingroup Debug
* \brief Debug is an object for debugging in program.
* It has 2 debugging modes :
* - error : for bad library use, seriously wrong DICOM
* - debug : for information/debug messages
* - warning : for warning about DICOM quality (kosher)
+ * - assert : design by contract implementation. A function should have
+ * proper input and proper output.
+ * (should not happen, not user controlled)
*
* A debugging message is only show if the flag is on (DebugFlag)
* This is static var and can be set at beginning of code:
Debug();
~Debug();
- /// This is a global flag that controls whether any debug, warning
- /// messages are displayed.
+ /// \brief This is a global flag that controls whether any debug, warning
+ /// messages are displayed.
static void SetDebugFlag (bool flag);
static bool GetDebugFlag ();
+ /// \brief Sets the Debug Flag to true
static void DebugOn () { SetDebugFlag(true); };
+ /// \brief Sets the Debug Flag to false
static void DebugOff () { SetDebugFlag(false); };
- /// This is a global flag that controls if debug are redirected
- /// to a file or not
+ /// \brief This is a global flag that controls if debug are redirected
+ /// to a file or not
static void SetDebugToFile (bool flag);
static bool GetDebugToFile ();
+ /// \brief Next debug messages will be sent in the debug file
static void DebugToFileOn () { SetDebugToFile(true); };
+ /// \brief Next debug messages will be sent in the standard output
static void DebugToFileOff () { SetDebugToFile(false); };
- /// Set the filename the debug stream should be redirect to
- /// Settting a filename also set DebugToFile to true
- static void SetDebugFilename (std::string const& filename);
+ static void SetDebugFilename (std::string const &filename);
- /// Internal use only. Allow us to retrieve the static from anywhere
- /// in gdcm code
static std::ofstream &GetDebugFile ();
};
#endif //NDEBUG
/**
- * \brief Verbose
+ * \brief Warning
* @param msg message part
*/
#ifdef NDEBUG
-#define gdcmVerboseMacro(msg) \
-{ \
-}
+#define gdcmWarningMacro(msg)
#else
-#define gdcmVerboseMacro(msg) \
+#define gdcmWarningMacro(msg) \
{ \
if( Debug::GetDebugFlag() ) \
{ \
std::ostringstream osmacro; \
- osmacro << "Verbose: In " __FILE__ ", line " << __LINE__ \
+ osmacro << "Warning: In " __FILE__ ", line " << __LINE__ \
<< ", function " << GDCM_FUNCTION << "\n" \
<< msg << "\n\n"; \
if( Debug::GetDebugToFile() ) \