1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntrySet.cxx,v $
6 Date: $Date: 2004/10/12 04:35:45 $
7 Version: $Revision: 1.24 $
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 "gdcmGlobal.h"
23 #include "gdcmException.h"
24 #include "gdcmDocEntry.h"
25 #include "gdcmSeqEntry.h"
26 #include "gdcmValEntry.h"
27 #include "gdcmBinEntry.h"
32 //-----------------------------------------------------------------------------
36 * \brief Build a new Val Entry from all the low level arguments.
37 * Check for existence of dictionary entry, and build
38 * a default one when absent.
39 * @param group group number of the underlying DictEntry
40 * @param elem element number of the underlying DictEntry
42 ValEntry *DocEntrySet::NewValEntryByNumber(uint16_t group,
45 // Find out if the tag we encountered is in the dictionaries:
46 DictEntry *dictEntry = GetDictEntryByNumber(group, elem);
49 dictEntry = NewVirtualDictEntry(group, elem);
52 ValEntry *newEntry = new ValEntry(dictEntry);
55 dbg.Verbose(1, "Document::NewValEntryByNumber",
56 "failed to allocate ValEntry");
64 * \brief Build a new Bin Entry from all the low level arguments.
65 * Check for existence of dictionary entry, and build
66 * a default one when absent.
67 * @param group group number of the underlying DictEntry
68 * @param elem element number of the underlying DictEntry
70 BinEntry *DocEntrySet::NewBinEntryByNumber(uint16_t group,
73 // Find out if the tag we encountered is in the dictionaries:
74 DictEntry *dictEntry = GetDictEntryByNumber(group, elem);
77 dictEntry = NewVirtualDictEntry(group, elem);
80 BinEntry *newEntry = new BinEntry(dictEntry);
83 dbg.Verbose(1, "Document::NewBinEntryByNumber",
84 "failed to allocate BinEntry");
91 * \brief Build a new Seq Entry from all the low level arguments.
92 * Check for existence of dictionary entry, and build
93 * a default one when absent.
94 * @param Group group number of the underlying DictEntry
95 * @param Elem element number of the underlying DictEntry
97 SeqEntry* DocEntrySet::NewSeqEntryByNumber(uint16_t Group,
100 // Find out if the tag we encountered is in the dictionaries:
101 DictEntry* DictEntry = GetDictEntryByNumber( Group, Elem );
104 DictEntry = NewVirtualDictEntry(Group, Elem);
107 SeqEntry *NewEntry = new SeqEntry( DictEntry );
110 dbg.Verbose(1, "Document::NewSeqEntryByNumber",
111 "failed to allocate SeqEntry");
117 //-----------------------------------------------------------------------------
121 * \brief Gets a Dicom Element inside a SQ Item Entry, by name
124 DocEntry *DocEntrySet::GetDocEntryByName(std::string const & name)
126 Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
127 DictEntry *dictEntry = pubDict->GetDictEntryByName(name);
133 return GetDocEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement());
138 * \brief Get the value of a Dicom Element inside a SQ Item Entry, by name
139 * @param name : name of the searched element.
143 std::string DocEntrySet::GetEntryByName(TagName const & name)
145 Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
146 DictEntry *dictEntry = pubDict->GetDictEntryByName(name);
153 return GetEntryByNumber(dictEntry->GetGroup(), dictEntry->GetElement());
158 * \brief Request a new virtual dict entry to the dict set
159 * @param group group number of the underlying DictEntry
160 * @param element element number of the underlying DictEntry
161 * @param vr VR of the underlying DictEntry
162 * @param fourth owner group
163 * @param name english name
165 DictEntry* DocEntrySet::NewVirtualDictEntry(uint16_t group,
167 std::string const & vr,
168 std::string const & fourth,
169 std::string const & name)
171 return Global::GetDicts()->NewVirtualDictEntry(group,element,vr,fourth,name);
175 * Creates a new DocEntry (without any 'value' ...)
176 * @param group group number of the underlying DictEntry
177 * @param elem elem number of the underlying DictEntry
179 DocEntry* DocEntrySet::NewDocEntryByNumber(uint16_t group,
182 // Find out if the tag we encountered is in the dictionaries:
183 Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
184 DictEntry *dictEntry = pubDict->GetDictEntryByNumber(group, elem);
187 dictEntry = NewVirtualDictEntry(group, elem);
190 DocEntry *newEntry = new DocEntry(dictEntry);
193 dbg.Verbose(1, "SQItem::NewDocEntryByNumber",
194 "failed to allocate DocEntry");
202 * Creates a new DocEntry (without any 'value' ...)
203 * @param group group number of the underlying DictEntry
204 * @param elem elem number of the underlying DictEntry
205 * @param VR V(alue) R(epresentation) of the Entry -if private Entry-
208 DocEntry* DocEntrySet::NewDocEntryByNumber(uint16_t group,
210 std::string const &VR)
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);
217 dictEntry = NewVirtualDictEntry(group, elem, VR);
220 DocEntry *newEntry = new DocEntry(dictEntry);
223 dbg.Verbose(1, "SQItem::NewDocEntryByNumber",
224 "failed to allocate DocEntry");
230 * Probabely move, as is, to DocEntrySet, as a non virtual method
231 * an remove Document::NewDocEntryByName
233 DocEntry *DocEntrySet::NewDocEntryByName (std::string const & name)
235 Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
236 DictEntry *newTag = pubDict->GetDictEntryByName(name);
239 newTag = NewVirtualDictEntry(0xffff, 0xffff, "LO", "unkn", name);
242 DocEntry* newEntry = new DocEntry(newTag);
245 dbg.Verbose(1, "SQItem::ObtainDocEntryByName",
246 "failed to allocate DocEntry");
255 * \brief Searches both the public and the shadow dictionary (when they
256 * exist) for the presence of the DictEntry with given name.
257 * The public dictionary has precedence on the shadow one.
258 * @param name Name of the searched DictEntry
259 * @return Corresponding DictEntry when it exists, NULL otherwise.
261 DictEntry *DocEntrySet::GetDictEntryByName(std::string const & name)
263 DictEntry *found = 0;
264 Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
267 dbg.Verbose(0, "Document::GetDictEntry",
268 "we SHOULD have a default dictionary");
272 found = pubDict->GetDictEntryByName(name);
278 * \brief Searches both the public and the shadow dictionary (when they
279 * exist) for the presence of the DictEntry with given
280 * group and element. The public dictionary has precedence on the
282 * @param group group number of the searched DictEntry
283 * @param element element number of the searched DictEntry
284 * @return Corresponding DictEntry when it exists, NULL otherwise.
286 DictEntry *DocEntrySet::GetDictEntryByNumber(uint16_t group,
289 DictEntry *found = 0;
290 Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
293 dbg.Verbose(0, "Document::GetDictEntry",
294 "we SHOULD have a default dictionary");
298 found = pubDict->GetDictEntryByNumber(group, element);
304 //-----------------------------------------------------------------------------
307 } // end namespace gdcm
309 //-----------------------------------------------------------------------------