All the 'accesors with euristics' move to the end of the file

[gdcm.git] / src / gdcmDict.h

diff --git a/src/gdcmDict.h b/src/gdcmDict.h
index 7fd1b18631d8d6fd2e52b93c7e18e33756cdac05..37d0076e3caf192b0b103df295dafc79f6f53c06 100644 (file)
--- a/src/gdcmDict.h
+++ b/src/gdcmDict.h
@@ -1,8 +1,4 @@
-////////////////////////////////////////////////////////////////////////////
-// 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
@@ -11,25 +7,38 @@
 #include "gdcmCommon.h"
 #include "gdcmDictEntry.h"
 
-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.
+   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;
 public:
-       gdcmDict(const char* FileName);   // Reads Dict from ascii file
+       gdcmDict(std::string & FileName);
+       ~gdcmDict();
        int AddNewEntry (gdcmDictEntry* NewEntry);
        int ReplaceEntry(gdcmDictEntry* NewEntry);
        int RemoveEntry (TagKey key);
        int RemoveEntry (guint16 group, guint16 element);
-       gdcmDictEntry * GetTagByKey(guint16 group, guint16 element);
+       gdcmDictEntry * GetTagByNumber(guint16 group, guint16 element);
        gdcmDictEntry * GetTagByName(TagName name);
-       void Print(ostream&);
-       void PrintByKey(ostream&);
-       void PrintByName(ostream&);
+       void Print(std::ostream&);
+       void PrintByKey(std::ostream&);
+       void PrintByName(std::ostream&);
        TagKeyHT & GetEntries(void) { return KeyHt; }
 };