src/gdcmDictSet.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDictSet.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/11/28 16:31:23 $
   7   Version:   $Revision: 1.52 $
   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 "gdcmRefCounter.h"
  23 #include "gdcmDict.h"
  24
  25 #include <map>
  26 #include <list>
  27
  28 namespace gdcm
  29 {
  30 //-----------------------------------------------------------------------------
  31 typedef std::map<DictKey, Dict*> DictSetHT;
  32
  33 //-----------------------------------------------------------------------------
  34 /**
  35  * \brief  Container for managing a set of loaded dictionaries (Dict).
  36  * \note   Hopefully, sharing dictionaries should avoid
  37  *         - reloading an already loaded dictionary (saving time)
  38  *         - having many in memory representations of the same dictionary
  39  *        (saving memory).
  40  */
  41 class GDCM_EXPORT DictSet : public RefCounter
  42 {
  43    gdcmTypeMacro(DictSet);
  44
  45 public:
  46 /// \brief Contructs a DictSet with a RefCounter
  47    static DictSet *New() {return new DictSet();}
  48
  49    void Print(std::ostream &os = std::cout, std::string const &indent = "" );
  50
  51    // Probabely useless !
  52    //EntryNamesList *GetPubDictEntryNames();
  53    //EntryNamesByCatMap *GetPubDictEntryNamesByCategory();
  54
  55    Dict *LoadDictFromFile( std::string const &fileName,
  56                            DictKey const &name );
  57
  58    Dict *GetDict( DictKey const &DictName );
  59
  60    /// \brief   Returns the default reference DICOM V3 public dictionary.
  61    Dict* GetDefaultPubDict() { return GetDict(PUB_DICT_NAME); }
  62
  63    // \ brief   Returns the virtual references DICOM dictionary.
  64    // \ warning : not end user intended
  65    // Dict *GetVirtualDict() { return &VirtualEntries; }
  66
  67    Dict *GetFirstDict();
  68    Dict *GetNextDict();
  69
  70    static std::string BuildDictPath();
  71
  72 protected:
  73    DictSet();
  74    ~DictSet();
  75
  76 private:
  77    /// Hash table of all dictionaries contained in this DictSet
  78    DictSetHT Dicts;
  79    /// Iterator to visit the Dictionaries of a given DictSet
  80    DictSetHT::iterator ItDictHt;
  81
  82    /// Directory path to dictionaries
  83    std::string DictPath;
  84 };
  85 } // end namespace gdcm
  86
  87 //-----------------------------------------------------------------------------
  88 #endif