1 /*=========================================================================
4 Module: $RCSfile: gdcmDictSet.cxx,v $
6 Date: $Date: 2004/10/18 02:17:07 $
7 Version: $Revision: 1.39 $
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 =========================================================================*/
19 #include "gdcmDictSet.h"
20 #include "gdcmDebug.h"
22 #include <stdlib.h> // For getenv
27 //-----------------------------------------------------------------------------
28 // Constructor / Destructor
31 * \brief The Dictionnary Set obtained with this constructor simply
32 * contains the Default Public dictionnary.
36 DictPath = BuildDictPath();
37 std::string pubDictFile(DictPath);
38 pubDictFile += PUB_DICT_FILENAME;
39 Dicts[PUB_DICT_NAME] = new Dict(pubDictFile);
48 // Remove dictionnaries
49 for (DictSetHT::iterator tag = Dicts.begin(); tag != Dicts.end(); ++tag)
51 Dict *entryToDelete = tag->second;
60 // Remove virtual dictionnary entries
61 std::map<std::string,DictEntry *>::iterator it;
62 for(it = VirtualEntry.begin(); it != VirtualEntry.end(); ++it)
64 DictEntry *entry = it->second;
73 //-----------------------------------------------------------------------------
77 * \brief Print, in an informal fashion, the list of all the dictionaries
78 * contained is this DictSet, along with their respective content.
79 * @param os Output stream used for printing.
81 void DictSet::Print(std::ostream& os)
83 for (DictSetHT::iterator dict = Dicts.begin(); dict != Dicts.end(); ++dict)
85 os << "Printing dictionary " << dict->first << std::endl;
86 dict->second->Print(os);
90 //-----------------------------------------------------------------------------
94 * \brief Consider all the entries of the public dicom dictionnary.
95 * Build all list of all the tag names of all those entries.
96 * \sa DictSet::GetPubDictTagNamesByCategory
97 * @return A list of all entries of the public dicom dictionnary.
99 EntryNamesList * DictSet::GetPubDictEntryNames()
101 return GetDefaultPubDict()->GetDictEntryNames();
107 * - Consider all the entries of the public dicom dictionnary.
108 * - Build an hashtable whose keys are the names of the groups
109 * (fourth field in each line of dictionary) and whose corresponding
110 * values are lists of all the dictionnary entries among that
111 * group. Note that apparently the Dicom standard doesn't explicitely
112 * define a name (as a string) for each group.
113 * - A typical usage of this method would be to enable a dynamic
114 * configuration of a Dicom file browser: the admin/user can
115 * select in the interface which Dicom tags should be displayed.
117 * - Dicom *doesn't* define any name for any 'categorie'
118 * (the dictionnary fourth field was formerly NIH defined
119 * -and no longer he is-
120 * and will be removed when Dicom provides us a text file
121 * with the 'official' Dictionnary, that would be more friendly
122 * than asking us to perform a line by line check of the dictionnary
123 * at the beginning of each year to -try to- guess the changes)
124 * - Therefore : please NEVER use that fourth field :-(
126 * @return An hashtable: whose keys are the names of the groups and whose
127 * corresponding values are lists of all the dictionnary entries
130 EntryNamesByCatMap * DictSet::GetPubDictEntryNamesByCategory()
132 return GetDefaultPubDict()->GetDictEntryNamesByCategory();
137 * \brief Loads a dictionary from a specified file, and add it
138 * to already the existing ones contained in this DictSet.
139 * @param fileName Absolute or relative filename containing the
140 * dictionary to load.
141 * @param name Symbolic name that be used as identifier of the newly
142 * created dictionary.
144 Dict *DictSet::LoadDictFromFile(std::string const & fileName,
145 DictKey const & name)
147 Dict *newDict = new Dict(fileName);
148 AppendDict(newDict, name);
155 * \brief Retrieve the specified dictionary (when existing) from this
157 * @param dictName The symbolic name of the searched dictionary.
158 * \result The retrieved dictionary.
160 Dict *DictSet::GetDict(DictKey const & dictName)
162 DictSetHT::iterator dict = Dicts.find(dictName);
163 if(dict != Dicts.end())
171 * \brief Create a DictEntry which will be reference
173 * @return virtual entry
175 DictEntry *DictSet::NewVirtualDictEntry( uint16_t group,
182 const std::string tag = DictEntry::TranslateToKey(group,element)
183 + "#" + vr + "#" + fourth + "#" + name;
184 std::map<std::string,DictEntry *>::iterator it;
186 it = VirtualEntry.find(tag);
187 if(it != VirtualEntry.end())
193 entry = new DictEntry(group, element, vr, fourth, name);
194 VirtualEntry[tag] = entry;
201 * \brief Obtain from the GDCM_DICT_PATH environnement variable the
202 * path to directory containing the dictionnaries. When
203 * the environnement variable is absent the path is defaulted
205 * @return path to directory containing the dictionnaries
207 std::string DictSet::BuildDictPath()
209 std::string resultPath;
210 const char *envPath = 0;
211 envPath = getenv("GDCM_DICT_PATH");
213 if (envPath && (strlen(envPath) != 0))
215 resultPath = envPath;
216 if ( resultPath[resultPath.length()-1] != '/' )
220 dbg.Verbose(1, "DictSet::BuildDictPath:",
221 "Dictionary path set from environnement");
225 resultPath = PUB_DICT_PATH;
231 //-----------------------------------------------------------------------------
233 bool DictSet::AppendDict(Dict *newDict, DictKey const & name)
235 Dicts[name] = newDict;
240 //-----------------------------------------------------------------------------
243 //-----------------------------------------------------------------------------
245 } // end namespace gdcm