src/gdcmDictSet.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDictSet.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/06/14 14:00:04 $
   7   Version:   $Revision: 1.43 $
   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 GDCMDICTSET_H
  20 #define GDCMDICTSET_H
  21
  22 #include "gdcmBase.h"
  23 #include "gdcmDict.h"
  24
  25 #include <map>
  26 #include <list>
  27
  28 namespace gdcm
  29 {
  30 typedef std::map<DictKey, Dict*> DictSetHT;
  31
  32 //-----------------------------------------------------------------------------
  33 /**
  34  * \brief  Container for managing a set of loaded dictionaries (Dict).
  35  * \note   Hopefully, sharing dictionaries should avoid
  36  * \par    reloading an already loaded dictionary (saving time)
  37  * \par    having many in memory representations of the same dictionary
  38  *        (saving memory).
  39  */
  40 class GDCM_EXPORT DictSet : public Base
  41 {
  42 public:
  43    DictSet();
  44    ~DictSet();
  45
  46    void Print(std::ostream &os = std::cout, std::string const &indent = "" );
  47
  48    // Probabely useless !
  49    //EntryNamesList *GetPubDictEntryNames();
  50    //EntryNamesByCatMap *GetPubDictEntryNamesByCategory();
  51
  52    Dict *LoadDictFromFile( std::string const &fileName,
  53                            DictKey const &name );
  54
  55    Dict *GetDict( DictKey const &DictName );
  56
  57    /// \brief   Returns the default reference DICOM V3 public dictionary.
  58    Dict* GetDefaultPubDict() { return GetDict(PUB_DICT_NAME); };
  59
  60    // \ brief   Returns the virtual references DICOM dictionary.
  61    // \ warning : not end user intended
  62    // Dict *GetVirtualDict() { return &VirtualEntries; };
  63
  64    DictEntry *NewVirtualDictEntry(uint16_t group, uint16_t elem,
  65                                   TagName vr     = GDCM_UNKNOWN,
  66                                   TagName vm     = GDCM_UNKNOWN,
  67                                   TagName name   = GDCM_UNKNOWN);
  68
  69    Dict *GetFirstEntry();
  70    Dict *GetNextEntry();
  71
  72    static std::string BuildDictPath();
  73
  74 protected:
  75    bool AppendDict(Dict *NewDict, DictKey const &name);
  76
  77 private:
  78    /// Hash table of all dictionaries contained in this DictSet
  79    DictSetHT Dicts;
  80    DictSetHT::iterator ItDictHt;
  81
  82    /// Directory path to dictionaries
  83    std::string DictPath;
  84
  85    /// H table for the on the fly created DictEntries
  86    TagKeyHT VirtualEntries;
  87 };
  88 } // end namespace gdcm
  89
  90 //-----------------------------------------------------------------------------
  91 #endif