X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDict.h;h=b901f57a9b78daef8f7e495fab0055c05570a3c2;hb=41cc62fb86c116bd195581980c27480c213c958b;hp=04975882e38b3356bacc58837bb26e790e3fd48b;hpb=4a0c2407ec81e041c2e43781acec4c78c83fc487;p=gdcm.git

diff --git a/src/gdcmDict.h b/src/gdcmDict.h
index 04975882..b901f57a 100644
--- a/src/gdcmDict.h
+++ b/src/gdcmDict.h
@@ -1,36 +1,69 @@
-////////////////////////////////////////////////////////////////////////////
-// 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"
 
-typedef map<TagKey,  gdcmDictEntry*> TagKeyHT;
-typedef map<TagName, gdcmDictEntry*> TagNameHT;
+#include <iostream>
+#include <list>
+#include <map>
 
+//-----------------------------------------------------------------------------
+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);
-	gdcmDictEntry * GetTagByNumber(guint16 group, guint16 element);
-	gdcmDictEntry * GetTagByName(TagName name);
-	void Print(ostream&);
-	void PrintByKey(ostream&);
-	void PrintByName(ostream&);
-	TagKeyHT & GetEntries(void) { return KeyHt; }
+   gdcmDict(std::string & FileName);
+	~gdcmDict();
+
+// Print
+	void Print(std::ostream &os = std::cout);
+	void PrintByKey(std::ostream &os = std::cout);
+	void PrintByName(std::ostream &os = std::cout);	
+
+// Entries
+   bool AddNewEntry (gdcmDictEntry *NewEntry);
+	bool ReplaceEntry(gdcmDictEntry *NewEntry);
+	bool RemoveEntry (TagKey key);
+	bool RemoveEntry (guint16 group, guint16 element);
+
+// Tag
+	gdcmDictEntry *GetDictEntryByName(TagName name);
+	gdcmDictEntry *GetDictEntryByNumber(guint16 group, guint16 element);
+
+   std::list<std::string> *GetDictEntryNames(void);
+   std::map<std::string, std::list<std::string> > *
+        GetDictEntryNamesByCategory(void);
+
+   /**
+    * \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 filename;
+
+   /// Access through TagKey (see alternate access with NameHt)
+	TagKeyHT  KeyHt;
+   /// Access through TagName (see alternate access with KeyHt)
+	TagNameHT NameHt;
 };
 
+//-----------------------------------------------------------------------------
 #endif