1 /*=========================================================================
4 Module: $RCSfile: gdcmDict.cxx,v $
6 Date: $Date: 2005/02/01 10:29:55 $
7 Version: $Revision: 1.71 $
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 =========================================================================*/
21 #include "gdcmDebug.h"
29 //-----------------------------------------------------------------------------
30 void FillDefaultDataDict(Dict *d);
32 //-----------------------------------------------------------------------------
33 // Constructor / Destructor
44 * @param filename from which to build the dictionary.
46 Dict::Dict(std::string const &filename)
54 std::ifstream from( filename.c_str() );
57 gdcmVerboseMacro( "Can't open dictionary" << filename.c_str());
58 // Using default embeded one:
59 FillDefaultDataDict( this );
70 from >> std::ws; //remove white space
71 std::getline(from, name);
73 const DictEntry newEntry(group, element, vr, vm, name);
90 //-----------------------------------------------------------------------------
93 * \brief Remove all Dicom Dictionary Entries
95 void Dict::ClearEntry()
97 // we assume all the pointed DictEntries are already cleaned-up
98 // when we clean KeyHt.
103 * \brief adds a new Dicom Dictionary Entry
104 * @param newEntry entry to add
105 * @return false if Dicom Element already exists
107 bool Dict::AddEntry(DictEntry const &newEntry)
109 const TagKey &key = newEntry.GetKey();
111 if(KeyHt.count(key) == 1)
113 gdcmVerboseMacro( "Already present" << key.c_str());
118 KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), newEntry));
124 * \brief replaces an already existing Dicom Element by a new one
125 * @param newEntry new entry (overwrites any previous one with same tag)
126 * @return false if Dicom Element doesn't exist
128 bool Dict::ReplaceEntry(DictEntry const &newEntry)
130 if ( RemoveEntry(newEntry.GetKey()) )
132 KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), newEntry));
139 * \brief removes an already existing Dicom Dictionary Entry,
140 * identified by its Tag
141 * @param key (group|element)
142 * @return false if Dicom Dictionary Entry doesn't exist
144 bool Dict::RemoveEntry (TagKey const &key)
146 TagKeyHT::const_iterator it = KeyHt.find(key);
147 if(it != KeyHt.end())
155 gdcmVerboseMacro( "Unfound entry" << key.c_str());
161 * \brief removes an already existing Dicom Dictionary Entry,
162 * identified by its group,element number
163 * @param group Dicom group number of the Dicom Element
164 * @param elem Dicom element number of the Dicom Element
165 * @return false if Dicom Dictionary Entry doesn't exist
167 bool Dict::RemoveEntry (uint16_t group, uint16_t elem)
169 return RemoveEntry(DictEntry::TranslateToKey(group, elem));
173 * \brief Get the dictionary entry identified by a given tag (group,element)
174 * @param group group of the entry to be found
175 * @param elem element of the entry to be found
176 * @return the corresponding dictionary entry when existing, NULL otherwise
178 DictEntry *Dict::GetEntry(uint16_t group, uint16_t elem)
180 TagKey key = DictEntry::TranslateToKey(group, elem);
181 TagKeyHT::iterator it = KeyHt.find(key);
182 if ( it == KeyHt.end() )
186 return &(it->second);
190 * \brief Get the first entry while visiting the Dict entries
191 * \return The first DicEntry if found, otherwhise NULL
193 DictEntry *Dict::GetFirstEntry()
195 ItKeyHt = KeyHt.begin();
196 if( ItKeyHt != KeyHt.end() )
197 return &(ItKeyHt->second);
202 * \brief Get the next entry while visiting the Hash table (KeyHt)
203 * \note : meaningfull only if GetFirstEntry already called
204 * \return The next DictEntry if found, otherwhise NULL
206 DictEntry *Dict::GetNextEntry()
208 gdcmAssertMacro (ItKeyHt != KeyHt.end());
212 if (ItKeyHt != KeyHt.end())
213 return &(ItKeyHt->second);
218 //-----------------------------------------------------------------------------
221 //-----------------------------------------------------------------------------
224 //-----------------------------------------------------------------------------
227 * \brief Print all the dictionary entries contained in this dictionary.
228 * Entries will be sorted by tag i.e. the couple (group, element).
229 * @param os The output stream to be written to.
230 * @param indent Indentation string to be prepended during printing
232 void Dict::Print(std::ostream &os, std::string const & )
234 os << "Dict file name : " << Filename << std::endl;
235 std::ostringstream s;
237 for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
240 s << "(" << std::hex << std::setw(4) << tag->second.GetGroup() << ',';
241 s << std::hex << std::setw(4) << tag->second.GetElement() << ") = "
243 s << tag->second.GetVR() << ", ";
244 s << tag->second.GetVM() << ", ";
245 s << tag->second.GetName() << "." << std::endl;
250 //-----------------------------------------------------------------------------
251 } // end namespace gdcm