gdcmSequence renamed to gdcmSerie, to comply with Dicom documentation.

[gdcm.git] / src / gdcmUtil.h

diff --git a/src/gdcmUtil.h b/src/gdcmUtil.h
index 2566e82fbd1a15e6f06898e556ee2b7bdd8db81b..7b35b952b6eb373fcfcc2944059f3cc54bb7ea97 100644 (file)
--- a/src/gdcmUtil.h
+++ b/src/gdcmUtil.h
@@ -1,5 +1,5 @@
-// $Header: /cvs/public/gdcm/src/gdcmUtil.h,v 1.16 2003/10/02 11:26:16 malaterre Exp $
-
+// gdcmUtil.h
+//-----------------------------------------------------------------------------
 #ifndef GDCMUTIL_H
 #define GDCMUTIL_H
 
@@ -10,33 +10,54 @@
 #include <vector>
 #include <string>
 
+//-----------------------------------------------------------------------------
+/*
+ * gdcmDebug is an object for debugging in program.
+ * It has 2 debugging modes :
+ *  - error : for bad library use
+ *  - debug : for debugging messages
+ * 
+ * A debugging message has a level of priority and is 
+ * Shown only when the debug level is higher than the 
+ * message level.
+ */
 class gdcmDebug {
-private:
-       int DebugLevel;
 public:
        gdcmDebug(int  = 0);
-       void Verbose(int, const char*, const char* ="");
-//     void Verbose(int, char*, char*);
+       void SetDebug (int i) {DebugLevel = i;}
+
+   void Verbose(int, const char*, const char* ="");
        void Error(bool, const char*,  const char* ="");
        void Error(const char*, const char* ="", const char* ="");
+
        void Assert(int, bool, const char*, const char*);
        void Exit(int);
-       void SetDebug (int i) {DebugLevel = i;}
+
+private:
+       int DebugLevel;
 };
 
+//-----------------------------------------------------------------------------
+/*
+ * This class contains all globals elements that might be
+ * instanciated only one time
+ */
 class gdcmGlobal {
-private:
-   static gdcmVR *VR;
-   static gdcmTS *TS; 
-   static gdcmDictSet *Dicts; 
 public:
    gdcmGlobal(void);
    ~gdcmGlobal();
+
    static gdcmVR * GetVR(void);
    static gdcmTS * GetTS(void);
    static gdcmDictSet * GetDicts(void);
+
+private:
+   static gdcmVR *VR;
+   static gdcmTS *TS; 
+   static gdcmDictSet *Dicts; 
 };
 
+//-----------------------------------------------------------------------------
 std::istream & eatwhite(std::istream & is);
 
 void Tokenize (const std::string& str,
@@ -48,7 +69,6 @@ extern gdcmDebug dbg;
 char * _cleanString(char *v);
 std::string _CreateCleanString(std::string s);
 
-std::string TranslateToKey(guint16 group, guint16 element);
-
+//-----------------------------------------------------------------------------
 #endif