src/gdcmDictSet.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDictSet.h,v $
   5   Language:  C++
   6   Date:      $Date: 2004/10/18 02:17:07 $
   7   Version:   $Revision: 1.28 $
   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 "gdcmDict.h"
  23 #include <map>
  24 #include <list>
  25
  26 namespace gdcm
  27 {
  28 typedef std::string DictKey;
  29 typedef std::map<DictKey, Dict*> DictSetHT;
  30
  31 //-----------------------------------------------------------------------------
  32 /*
  33  * \defgroup DictSet
  34  * \brief  Container for managing a set of loaded dictionaries.
  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
  41 {
  42 public:
  43    DictSet();
  44    ~DictSet();
  45
  46    void Print(std::ostream& os);
  47
  48    EntryNamesList * GetPubDictEntryNames();
  49    EntryNamesByCatMap * GetPubDictEntryNamesByCategory();
  50
  51    Dict* LoadDictFromFile( std::string const & fileName,
  52                            DictKey const & name );
  53
  54    Dict* GetDict( DictKey const & DictName );
  55
  56    /// \brief   Retrieve the default reference DICOM V3 public dictionary.
  57    Dict* GetDefaultPubDict() { return GetDict(PUB_DICT_NAME); };
  58
  59    // \brief   Retrieve the virtual reference DICOM dictionary.
  60    // \warning : not end user intended
  61    // Dict* GetVirtualDict() { return &VirtualEntry; };
  62
  63    DictEntry* NewVirtualDictEntry(uint16_t group, uint16_t element,
  64                                   TagName vr     = "Unknown",
  65                                   TagName fourth = "Unknown",
  66                                   TagName name   = "Unknown");
  67
  68    static std::string BuildDictPath();
  69
  70 protected:
  71    bool AppendDict(Dict *NewDict, DictKey const & name);
  72
  73 private:
  74    /// Hash table of all dictionaries contained in this DictSet
  75    DictSetHT Dicts;
  76
  77    /// Directory path to dictionaries
  78    std::string DictPath;
  79
  80    /// H table for the on the fly created DictEntries
  81    TagKeyHT VirtualEntry;
  82 };
  83 } // end namespace gdcm
  84
  85 //-----------------------------------------------------------------------------
  86 #endif