Now, gdcmObject::SetEntryByNumber *adds* a new gdcmHeaderEntry to the cuurent

[gdcm.git] / src / gdcmDict.h

diff --git a/src/gdcmDict.h b/src/gdcmDict.h
index 5e56f3356eacb26d85376f0cecc2c939cb9b4920..10a585693b1a93de7b15dd2a687219730c313f42 100644 (file)
--- a/src/gdcmDict.h
+++ b/src/gdcmDict.h
@@ -1,41 +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;
 
-/// 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;
+public:
+   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:
+   /// ASCII file holding the Dictionnary
+   std::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();
-       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; }
 };
 
+//-----------------------------------------------------------------------------
 #endif