1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntrySet.cxx,v $
6 Date: $Date: 2005/01/06 13:35:38 $
7 Version: $Revision: 1.29 $
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 =========================================================================*/
18 #include "gdcmDocEntrySet.h"
20 #include "gdcmDebug.h"
21 #include "gdcmCommon.h"
22 #include "gdcmDictSet.h"
23 #include "gdcmGlobal.h"
24 #include "gdcmException.h"
25 #include "gdcmDocEntry.h"
26 #include "gdcmSeqEntry.h"
27 #include "gdcmValEntry.h"
28 #include "gdcmBinEntry.h"
33 //-----------------------------------------------------------------------------
37 * \brief Build a new Val Entry from all the low level arguments.
38 * Check for existence of dictionary entry, and build
39 * a default one when absent.
40 * @param group group number of the underlying DictEntry
41 * @param elem element number of the underlying DictEntry
43 ValEntry *DocEntrySet::NewValEntryByNumber(uint16_t group,
46 // Find out if the tag we encountered is in the dictionaries:
47 DictEntry *dictEntry = GetDictEntryByNumber(group, elem);
50 dictEntry = NewVirtualDictEntry(group, elem);
53 ValEntry *newEntry = new ValEntry(dictEntry);
56 dbg.Verbose(1, "Document::NewValEntryByNumber",
57 "failed to allocate ValEntry");
65 * \brief Build a new Bin Entry from all the low level arguments.
66 * Check for existence of dictionary entry, and build
67 * a default one when absent.
68 * @param group group number of the underlying DictEntry
69 * @param elem element number of the underlying DictEntry
71 BinEntry *DocEntrySet::NewBinEntryByNumber(uint16_t group,
74 // Find out if the tag we encountered is in the dictionaries:
75 DictEntry *dictEntry = GetDictEntryByNumber(group, elem);
78 dictEntry = NewVirtualDictEntry(group, elem);
81 BinEntry *newEntry = new BinEntry(dictEntry);
84 dbg.Verbose(1, "Document::NewBinEntryByNumber",
85 "failed to allocate BinEntry");
92 * \brief Build a new Seq Entry from all the low level arguments.
93 * Check for existence of dictionary entry, and build
94 * a default one when absent.
95 * @param Group group number of the underlying DictEntry
96 * @param Elem element number of the underlying DictEntry
98 SeqEntry* DocEntrySet::NewSeqEntryByNumber(uint16_t Group,
101 // Find out if the tag we encountered is in the dictionaries:
102 DictEntry* DictEntry = GetDictEntryByNumber( Group, Elem );
105 DictEntry = NewVirtualDictEntry(Group, Elem);
108 SeqEntry *NewEntry = new SeqEntry( DictEntry );
111 dbg.Verbose(1, "Document::NewSeqEntryByNumber",
112 "failed to allocate SeqEntry");
118 //-----------------------------------------------------------------------------
122 * \brief Gets a Dicom Element inside a SQ Item Entry, by name
123 * @param name of the element to be found.
126 DocEntry* DocEntrySet::GetDocEntryByName( TagName const & name )
128 Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
129 DictEntry *dictEntry = pubDict->GetDictEntryByName(name);
135 return GetDocEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement());
140 * \brief Get the value of a Dicom Element inside a SQ Item Entry, by name
141 * @param name : name of the searched element.
145 std::string DocEntrySet::GetEntryByName(TagName const & name)
147 Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
148 DictEntry *dictEntry = pubDict->GetDictEntryByName(name);
155 return GetEntryByNumber(dictEntry->GetGroup(), dictEntry->GetElement());
160 * \brief Request a new virtual dict entry to the dict set
161 * @param group group number of the underlying DictEntry
162 * @param element element number of the underlying DictEntry
163 * @param vr VR of the underlying DictEntry
164 * @param fourth owner group
165 * @param name english name
167 DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group,
170 TagName const & fourth,
171 TagName const & name )
173 return Global::GetDicts()->NewVirtualDictEntry(group,element,vr,fourth,name);
177 * Creates a new DocEntry (without any 'value' ...)
178 * @param group group number of the underlying DictEntry
179 * @param elem elem number of the underlying DictEntry
181 DocEntry* DocEntrySet::NewDocEntryByNumber(uint16_t group,
184 // Find out if the tag we encountered is in the dictionaries:
185 Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
186 DictEntry *dictEntry = pubDict->GetDictEntryByNumber(group, elem);
189 dictEntry = NewVirtualDictEntry(group, elem);
192 DocEntry *newEntry = new DocEntry(dictEntry);
195 dbg.Verbose(1, "SQItem::NewDocEntryByNumber",
196 "failed to allocate DocEntry");
204 * Creates a new DocEntry (without any 'value' ...)
205 * @param group group number of the underlying DictEntry
206 * @param elem elem number of the underlying DictEntry
207 * @param vr V(alue) R(epresentation) of the Entry -if private Entry-
209 DocEntry* DocEntrySet::NewDocEntryByNumber(uint16_t group, uint16_t elem,
212 // Find out if the tag we encountered is in the dictionaries:
213 Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
214 DictEntry *dictEntry = pubDict->GetDictEntryByNumber(group, elem);
215 std::string goodVR = vr;
216 DictEntry *goodDict = dictEntry;
218 // Check if the would VR is good
222 // Check if the DictEntry VR corresponds with the would VR
224 if (goodDict->GetVR() != goodVR && goodVR!=GDCM_UNKNOWN)
227 // Create a new virtual DictEntry if necessary
231 goodDict = NewVirtualDictEntry(group, elem, goodVR,"FIXME",dictEntry->GetName());
233 goodDict = NewVirtualDictEntry(group, elem, goodVR);
236 // Create the DocEntry
237 DocEntry *newEntry = new DocEntry(goodDict);
240 dbg.Verbose(1, "SQItem::NewDocEntryByNumber",
241 "failed to allocate DocEntry");
248 * Probabely move, as is, to DocEntrySet, as a non virtual method
249 * and remove Document::NewDocEntryByName
251 DocEntry *DocEntrySet::NewDocEntryByName(TagName const & name)
253 Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
254 DictEntry *newTag = pubDict->GetDictEntryByName(name);
257 newTag = NewVirtualDictEntry(0xffff, 0xffff, "LO", GDCM_UNKNOWN, name);
260 DocEntry* newEntry = new DocEntry(newTag);
263 dbg.Verbose(1, "SQItem::ObtainDocEntryByName",
264 "failed to allocate DocEntry");
273 * \brief Searches both the public and the shadow dictionary (when they
274 * exist) for the presence of the DictEntry with given name.
275 * The public dictionary has precedence on the shadow one.
276 * @param name Name of the searched DictEntry
277 * @return Corresponding DictEntry when it exists, NULL otherwise.
279 DictEntry *DocEntrySet::GetDictEntryByName(TagName const & name)
281 DictEntry *found = 0;
282 Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
285 dbg.Verbose(0, "Document::GetDictEntry",
286 "we SHOULD have a default dictionary");
290 found = pubDict->GetDictEntryByName(name);
296 * \brief Searches both the public and the shadow dictionary (when they
297 * exist) for the presence of the DictEntry with given
298 * group and element. The public dictionary has precedence on the
300 * @param group group number of the searched DictEntry
301 * @param element element number of the searched DictEntry
302 * @return Corresponding DictEntry when it exists, NULL otherwise.
304 DictEntry *DocEntrySet::GetDictEntryByNumber(uint16_t group,
307 DictEntry *found = 0;
308 Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
311 dbg.Verbose(0, "Document::GetDictEntry",
312 "we SHOULD have a default dictionary");
316 found = pubDict->GetDictEntryByNumber(group, element);
322 //-----------------------------------------------------------------------------
325 } // end namespace gdcm
327 //-----------------------------------------------------------------------------