X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDict.h;h=cf34024488841ec8ff7bdbebd896281bc2a3bb37;hb=aba8714645174c0c7d3c7aadf6af1832743e2971;hp=5e56f3356eacb26d85376f0cecc2c939cb9b4920;hpb=0457e1e8fc68df6d9e2d1a0fcd0053ecee3c5ad7;p=gdcm.git

diff --git a/src/gdcmDict.h b/src/gdcmDict.h
index 5e56f335..cf340244 100644
--- a/src/gdcmDict.h
+++ b/src/gdcmDict.h
@@ -1,41 +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;
 
-/// Build a memory representation of a dicom dictionary by parsing
-/// an ascii file
+//-----------------------------------------------------------------------------
+/*
+ * \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;
-   /// Access through TagKey (see alternate access with NameHt)
-	TagKeyHT  KeyHt;
-   /// Access through TagName (see alternate access with KeyHt)
-	TagNameHT NameHt;
 public:
-	gdcmDict(string & FileName);
+   gdcmDict(std::string & FileName);
 	~gdcmDict();
-	int AddNewEntry (gdcmDictEntry* NewEntry);
-	int ReplaceEntry(gdcmDictEntry* NewEntry);
-	int RemoveEntry (TagKey key);
-	int RemoveEntry (guint16 group, guint16 element);
+
+	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