src/gdcmDict.h

   1 // gdcmDict.h
   2 //-----------------------------------------------------------------------------
   3 #ifndef GDCMDICT_H
   4 #define GDCMDICT_H
   5
   6 #include "gdcmCommon.h"
   7 #include "gdcmDictEntry.h"
   8
   9 #include <iostream>
  10 #include <list>
  11 #include <map>
  12
  13 //-----------------------------------------------------------------------------
  14 typedef std::map<TagKey,  gdcmDictEntry*> TagKeyHT;
  15 typedef std::map<TagName, gdcmDictEntry*> TagNameHT;
  16
  17 //-----------------------------------------------------------------------------
  18 /*
  19  * \defgroup gdcmDict
  20  * \brief    gdcmDict acts a memory representation of a dicom dictionary i.e.
  21  *           it is a container for a collection of dictionary entries. The
  22  *           dictionary is loaded from in an ascii file.
  23  *           There should be a single public dictionary (THE dictionary of
  24  *           the actual DICOM v3) but as many shadow dictionaries as imagers
  25  *           combined with all software versions...
  26  * \see gdcmDictSet
  27  */
  28 class GDCM_EXPORT gdcmDict {
  29 public:
  30    gdcmDict(std::string & FileName);
  31         ~gdcmDict();
  32
  33 // Print
  34         void Print(std::ostream &os = std::cout);
  35         void PrintByKey(std::ostream &os = std::cout);
  36         void PrintByName(std::ostream &os = std::cout);
  37
  38 // Entries
  39    bool AddNewEntry (gdcmDictEntry *NewEntry);
  40         bool ReplaceEntry(gdcmDictEntry *NewEntry);
  41         bool RemoveEntry (TagKey key);
  42         bool RemoveEntry (guint16 group, guint16 element);
  43
  44 // Tag
  45         gdcmDictEntry *GetDictEntryByName(TagName name);
  46         gdcmDictEntry *GetDictEntryByNumber(guint16 group, guint16 element);
  47
  48    std::list<std::string> *GetDictEntryNames(void);
  49    std::map<std::string, std::list<std::string> > *
  50         GetDictEntryNamesByCategory(void);
  51
  52    /**
  53     * \ingroup gdcmDict
  54     * \brief   returns a ref to the Dicom Dictionary H table (map)
  55     * return the Dicom Dictionary H table
  56     */
  57    inline TagKeyHT & GetEntriesByKey(void)  { return KeyHt; }
  58
  59    /**
  60     * \ingroup gdcmDict
  61     * \brief   returns a ref to the Dicom Dictionary H table (map)
  62     * return the Dicom Dictionary H table
  63     */
  64    inline TagNameHT & GetEntriesByName(void)  { return NameHt; }
  65
  66 private:
  67    /// ASCII file holding the Dictionnary
  68    std::string filename;
  69    /// Access through TagKey (see alternate access with NameHt)
  70         TagKeyHT  KeyHt;
  71    /// Access through TagName (see alternate access with KeyHt)
  72         TagNameHT NameHt;
  73 };
  74
  75 //-----------------------------------------------------------------------------
  76 #endif