src/gdcmDictSet.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDictSet.h,v $
   5   Language:  C++
   6   Date:      $Date: 2004/09/13 07:49:35 $
   7   Version:   $Revision: 1.25 $
   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.htm 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 "gdcmDict.h"
  23 #include <map>
  24 #include <list>
  25
  26 typedef std::string DictKey;
  27 typedef std::map<DictKey, gdcmDict*> DictSetHT;
  28
  29 //-----------------------------------------------------------------------------
  30 /*
  31  * \defgroup gdcmDictSet
  32  * \brief  Container for managing a set of loaded dictionaries.
  33  * \note   Hopefully, sharing dictionaries should avoid
  34  * \par    reloading an already loaded dictionary (saving time)
  35  * \par    having many in memory representations of the same dictionary
  36  *        (saving memory).
  37  */
  38 class GDCM_EXPORT gdcmDictSet
  39 {
  40 public:
  41    gdcmDictSet();
  42    ~gdcmDictSet();
  43
  44    void Print(std::ostream& os);
  45
  46    std::list<std::string>* GetPubDictEntryNames();
  47    std::map<std::string, std::list<std::string> > *
  48        GetPubDictEntryNamesByCategory();
  49
  50    gdcmDict* LoadDictFromFile( std::string const & fileName,
  51                                DictKey const & name );
  52
  53    gdcmDict* GetDict( DictKey const & DictName );
  54
  55    /// \brief   Retrieve the default reference DICOM V3 public dictionary.
  56    gdcmDict* GetDefaultPubDict() { return GetDict(PUB_DICT_NAME); };
  57
  58    // \brief   Retrieve the virtual reference DICOM dictionary.
  59    // \warning : not end user intended
  60    // gdcmDict* GetVirtualDict() { return &VirtualEntry; };
  61
  62    gdcmDictEntry* NewVirtualDictEntry(uint16_t group, uint16_t element,
  63                                       std::string vr     = "Unknown",
  64                                       std::string fourth = "Unknown",
  65                                       std::string name   = "Unknown");
  66
  67    static std::string BuildDictPath();
  68
  69 protected:
  70    bool AppendDict(gdcmDict *NewDict, DictKey const & name);
  71
  72 private:
  73    /// Hash table of all dictionaries contained in this gdcmDictSet
  74    DictSetHT Dicts;
  75    /// Directory path to dictionaries
  76    std::string DictPath;
  77    /// H table for the on the fly created gdcmDictEntries
  78    TagKeyHT VirtualEntry;
  79 };
  80
  81 //-----------------------------------------------------------------------------
  82 #endif