-////////////////////////////////////////////////////////////////////////////
-// 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
typedef map<TagKey, gdcmDictEntry*> TagKeyHT;
typedef 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.
+ /// 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(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&);