src/gdcmDict.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDict.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/14 11:28:30 $
   7   Version:   $Revision: 1.31 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 #ifndef GDCMDICT_H
  20 #define GDCMDICT_H
  21
  22 #include "gdcmBase.h"
  23 #include "gdcmDictEntry.h"
  24
  25 #include <iostream>
  26 #include <list>
  27 #include <map>
  28
  29 namespace gdcm
  30 {
  31
  32 //-----------------------------------------------------------------------------
  33 typedef std::string DictKey;
  34 typedef std::map<TagKey, DictEntry>  TagKeyHT;
  35 typedef std::list<std::string>       EntryNamesList;
  36 typedef std::map<std::string,
  37             std::list<std::string> > EntryNamesByCatMap;
  38 //-----------------------------------------------------------------------------
  39 /**
  40  * \ingroup Dict
  41  * \brief    Dict acts a memory representation of a dicom dictionary i.e.
  42  *           it is a container for a collection of dictionary entries.
  43  *           The dictionary is loaded from in an ascii file.
  44  *           There should be a single public dictionary (THE dictionary of
  45  *           the actual DICOM v3) but as many shadow dictionaries as imagers
  46  *           combined with all software versions...
  47  * \see DictSet
  48  */
  49 class GDCM_EXPORT Dict : public Base
  50 {
  51 public:
  52    Dict(void);
  53    Dict(std::string const & filename);
  54    ~Dict();
  55
  56 // Print
  57    void Print(std::ostream &os = std::cout);
  58
  59 // Entries
  60    void ClearEntry  ();
  61    bool AddNewEntry (DictEntry const &newEntry);
  62    bool ReplaceEntry(DictEntry const &newEntry);
  63    bool RemoveEntry (TagKey const &key);
  64    bool RemoveEntry (uint16_t group, uint16_t element);
  65
  66 // Tag
  67    DictEntry *GetDictEntry(uint16_t group, uint16_t element);
  68
  69   // EntryNamesList *GetDictEntryNames();
  70   // EntryNamesByCatMap *GetDictEntryNamesByCategory();
  71
  72    /// \brief  Returns a ref to the Dicom Dictionary H table (map)
  73    /// @return the Dicom Dictionary H table
  74    //const TagKeyHT & GetEntries() const { return KeyHt; }
  75
  76    void InitTraversal();
  77    DictEntry *GetNextEntry();
  78
  79 private:
  80    /// ASCII file holding the Dictionnary
  81    std::string Filename;
  82
  83    /// Access through TagKey
  84    TagKeyHT KeyHt;
  85    TagKeyHT::iterator ItKeyHt;
  86 };
  87 } // end namespace gdcm
  88
  89 //-----------------------------------------------------------------------------
  90 #endif