src/gdcmDict.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDict.h,v $
   5   Language:  C++
   6   Date:      $Date: 2004/10/27 22:31:12 $
   7   Version:   $Revision: 1.22 $
   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 "gdcmCommon.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::map<TagKey, DictEntry> TagKeyHT;
  34 typedef std::map<TagName, DictEntry> TagNameHT;
  35 typedef std::list<std::string>        EntryNamesList;
  36 typedef std::map<std::string, std::list<std::string> > EntryNamesByCatMap;
  37 //-----------------------------------------------------------------------------
  38 /*
  39  * \defgroup Dict
  40  * \brief    Dict acts a memory representation of a dicom dictionary i.e.
  41  *           it is a container for a collection of dictionary entries. The
  42  *           dictionary is loaded from in an ascii file.
  43  *           There should be a single public dictionary (THE dictionary of
  44  *           the actual DICOM v3) but as many shadow dictionaries as imagers
  45  *           combined with all software versions...
  46  * \see DictSet
  47  */
  48 class GDCM_EXPORT Dict
  49 {
  50 public:
  51    Dict(std::string const & filename);
  52    ~Dict();
  53
  54 // Print
  55    void Print(std::ostream &os = std::cout);
  56    void PrintByKey(std::ostream &os = std::cout);
  57    void PrintByName(std::ostream &os = std::cout);
  58
  59 // Entries
  60    bool AddNewEntry (DictEntry const & newEntry);
  61    bool ReplaceEntry(DictEntry const & newEntry);
  62    bool RemoveEntry (TagKey const & key);
  63    bool RemoveEntry (uint16_t group, uint16_t element);
  64
  65 // Tag
  66    DictEntry *GetDictEntryByName(TagName const & name);
  67    DictEntry *GetDictEntryByNumber(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 & GetEntriesByKey() const { return KeyHt; }
  75
  76    /// \brief  Returns a ref to the Dicom Dictionary H table (map)
  77    /// @return the Dicom Dictionary H table
  78    const TagNameHT & GetEntriesByName() const { return NameHt; }
  79
  80 private:
  81    /// ASCII file holding the Dictionnary
  82    std::string Filename;
  83
  84    /// Access through TagKey (see alternate access with NameHt)
  85    TagKeyHT  KeyHt;
  86
  87    /// Access through TagName (see alternate access with KeyHt)
  88    TagNameHT NameHt;
  89 };
  90 } // end namespace gdcm
  91
  92 //-----------------------------------------------------------------------------
  93 #endif