* src/*.h : add comments

[gdcm.git] / src / gdcmUtil.h

diff --git a/src/gdcmUtil.h b/src/gdcmUtil.h
index e00e8934f71e24994abad4fb2ac3d6931d974c33..2e4696258e524baddc8fd267ea68a42a12279ad5 100644 (file)
--- a/src/gdcmUtil.h
+++ b/src/gdcmUtil.h
@@ -1,14 +1,25 @@
-// $Header: /cvs/public/gdcm/src/gdcmUtil.h,v 1.9 2003/05/21 14:42:46 frog Exp $
+// $Header: /cvs/public/gdcm/src/gdcmUtil.h,v 1.17 2004/01/12 13:12:28 regrain Exp $
 
 #ifndef GDCMUTIL_H
 #define GDCMUTIL_H
 
+#include "gdcmVR.h"
+#include "gdcmTS.h"
+#include "gdcmDictSet.h"
 #include <iostream>
 #include <vector>
 #include <string>
-#include "gdcmVR.h"
-#include "gdcmDictSet.h"
 
+/*
+ * 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;
@@ -19,20 +30,27 @@ public:
        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;}
 };
 
+/*
+ * This class contains all globals elements that might be
+ * instanciated only one time
+ */
 class gdcmGlobal {
 private:
-   static gdcmVR *VR; 
+   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);
 };
 
-istream & eatwhite(istream & is);
+std::istream & eatwhite(std::istream & is);
 
 void Tokenize (const std::string& str,
                std::vector<std::string>& tokens,
@@ -40,4 +58,10 @@ void Tokenize (const std::string& str,
 
 extern gdcmDebug dbg;
 
+char * _cleanString(char *v);
+std::string _CreateCleanString(std::string s);
+
+std::string TranslateToKey(guint16 group, guint16 element);
+
 #endif
+