src/gdcmDict.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDict.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/02/07 09:51:03 $
   7   Version:   $Revision: 1.38 $
   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 //-----------------------------------------------------------------------------
  36 /**
  37  * \brief    Dict acts a memory representation of a dicom dictionary i.e.
  38  *           it is a container for a collection of dictionary entries.
  39  *           The dictionary is loaded from in an ascii file.
  40  *           There should be a single public dictionary (THE dictionary of
  41  *           the actual DICOM v3) but as many shadow dictionaries as imagers
  42  *           combined with all software versions...
  43  * \see DictSet
  44  */
  45 class GDCM_EXPORT Dict : public Base
  46 {
  47 public:
  48    Dict();
  49    Dict(std::string const &filename);
  50    ~Dict();
  51
  52 // Print
  53    void Print(std::ostream &os = std::cout, std::string const &indent = "");
  54
  55 // Entries
  56    bool AddEntry(DictEntry const &newEntry);
  57    bool ReplaceEntry(DictEntry const &newEntry);
  58    bool RemoveEntry (TagKey const &key);
  59    bool RemoveEntry (uint16_t group, uint16_t elem);
  60    void ClearEntry();
  61
  62 // Tag
  63    DictEntry *GetEntry(uint16_t group, uint16_t elem);
  64
  65    DictEntry *GetFirstEntry();
  66    DictEntry *GetNextEntry();
  67
  68 private:
  69    /// ASCII file holding the Dictionnary
  70    std::string Filename;
  71
  72    /// Access through TagKey
  73    TagKeyHT KeyHt;
  74    TagKeyHT::iterator ItKeyHt;
  75 };
  76 } // end namespace gdcm
  77
  78 //-----------------------------------------------------------------------------
  79 #endif