* To remove warnings

[gdcm.git] / src / gdcmDict.h

diff --git a/src/gdcmDict.h b/src/gdcmDict.h
index 04975882e38b3356bacc58837bb26e790e3fd48b..cf34024488841ec8ff7bdbebd896281bc2a3bb37 100644 (file)
--- a/src/gdcmDict.h
+++ b/src/gdcmDict.h
@@ -1,36 +1,62 @@
-////////////////////////////////////////////////////////////////////////////
-// A single DICOM dictionary i.e. a container for a collection of dictionary
-// entries. There should be a single public dictionary (THE dictionary of
-// the actual DICOM v3) but as many shadow dictionaries as imagers 
-// combined with all software versions...
-
+// gdcmDict.h
+//-----------------------------------------------------------------------------
 #ifndef GDCMDICT_H
 #define GDCMDICT_H
 
-#include <map>
 #include "gdcmCommon.h"
 #include "gdcmDictEntry.h"
+#include <map>
 
-typedef map<TagKey,  gdcmDictEntry*> TagKeyHT;
-typedef map<TagName, gdcmDictEntry*> TagNameHT;
+//-----------------------------------------------------------------------------
+typedef std::map<TagKey,  gdcmDictEntry*> TagKeyHT;
+typedef std::map<TagName, gdcmDictEntry*> TagNameHT;
 
+//-----------------------------------------------------------------------------
+/*
+ * \defgroup gdcmDict
+ * \brief    gdcmDict acts a memory representation of a dicom dictionary i.e.
+ *           it is a container for a collection of dictionary entries. The
+ *           dictionary is loaded from in an ascii file.
+ *           There should be a single public dictionary (THE dictionary of
+ *           the actual DICOM v3) but as many shadow dictionaries as imagers 
+ *           combined with all software versions...
+ * \see gdcmDictSet
+ */
 class GDCM_EXPORT gdcmDict {
-       string name;
-       string filename;
-       TagKeyHT  KeyHt;                // Both accesses with a TagKey or with a
-       TagNameHT NameHt;               // TagName are required.
 public:
-       gdcmDict(const char* FileName);   // Reads Dict from ascii file
-       int AddNewEntry (gdcmDictEntry* NewEntry);
-       int ReplaceEntry(gdcmDictEntry* NewEntry);
-       int RemoveEntry (TagKey key);
-       int RemoveEntry (guint16 group, guint16 element);
+   gdcmDict(std::string & FileName);
+       ~gdcmDict();
+
+       void Print(std::ostream&);
+       void PrintByKey(std::ostream&);
+       void PrintByName(std::ostream&);        
+
+   bool AddNewEntry (gdcmDictEntry* NewEntry);
+       bool ReplaceEntry(gdcmDictEntry* NewEntry);
+       bool RemoveEntry (TagKey key);
+       bool RemoveEntry (guint16 group, guint16 element);
+
        gdcmDictEntry * GetTagByNumber(guint16 group, guint16 element);
        gdcmDictEntry * GetTagByName(TagName name);
-       void Print(ostream&);
-       void PrintByKey(ostream&);
-       void PrintByName(ostream&);
-       TagKeyHT & GetEntries(void) { return KeyHt; }
+
+   /**
+    * \ingroup gdcmDict
+    * \brief   returns a ref to the Dicom Dictionary H table (map)
+    * return the Dicom Dictionary H table
+    */
+   inline TagKeyHT & gdcmDict::GetEntries(void)  {
+    return KeyHt; 
+   }
+ 
+private:
+   std::string name;
+   std::string filename;
+   /// Access through TagKey (see alternate access with NameHt)
+       TagKeyHT  KeyHt;
+   /// Access through TagName (see alternate access with KeyHt)
+       TagNameHT NameHt;
+
 };
 
+//-----------------------------------------------------------------------------
 #endif