1 /*=========================================================================
4 Module: $RCSfile: gdcmDict.h,v $
6 Date: $Date: 2005/01/06 20:03:27 $
7 Version: $Revision: 1.26 $
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.
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.
17 =========================================================================*/
23 #include "gdcmDictEntry.h"
32 //-----------------------------------------------------------------------------
33 typedef std::string DictKey;
34 typedef std::map<TagKey, DictEntry> TagKeyHT;
35 typedef std::map<TagName, DictEntry> TagNameHT;
36 typedef std::list<std::string> EntryNamesList;
37 typedef std::map<std::string,
38 std::list<std::string> > EntryNamesByCatMap;
39 //-----------------------------------------------------------------------------
42 * \brief Dict acts a memory representation of a dicom dictionary i.e.
43 * it is a container for a collection of dictionary entries. The
44 * dictionary is loaded from in an ascii file.
45 * There should be a single public dictionary (THE dictionary of
46 * the actual DICOM v3) but as many shadow dictionaries as imagers
47 * combined with all software versions...
50 class GDCM_EXPORT Dict : public Base
53 Dict(std::string const & filename);
57 void Print(std::ostream &os = std::cout);
58 void PrintByKey(std::ostream &os = std::cout);
59 void PrintByName(std::ostream &os = std::cout);
62 bool AddNewEntry (DictEntry const &newEntry);
63 bool ReplaceEntry(DictEntry const &newEntry);
64 bool RemoveEntry (TagKey const &key);
65 bool RemoveEntry (uint16_t group, uint16_t element);
68 DictEntry *GetDictEntryByName(TagName const &name);
69 DictEntry *GetDictEntryByNumber(uint16_t group, uint16_t element);
71 EntryNamesList *GetDictEntryNames();
72 EntryNamesByCatMap *GetDictEntryNamesByCategory();
74 /// \brief Returns a ref to the Dicom Dictionary H table (map)
75 /// @return the Dicom Dictionary H table
76 const TagKeyHT & GetEntriesByKey() const { return KeyHt; }
78 /// \brief Returns a ref to the Dicom Dictionary H table (map)
79 /// @return the Dicom Dictionary H table
80 const TagNameHT & GetEntriesByName() const { return NameHt; }
83 /// ASCII file holding the Dictionnary
86 /// Access through TagKey (see alternate access with NameHt)
89 /// Access through TagName (see alternate access with KeyHt)
92 } // end namespace gdcm
94 //-----------------------------------------------------------------------------