1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntry.cxx,v $
6 Date: $Date: 2004/10/12 04:35:45 $
7 Version: $Revision: 1.27 $
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 "gdcmDocEntry.h"
21 #include "gdcmGlobal.h"
24 #include <iomanip> // for std::ios::left, ...
29 #define MAX_SIZE_PRINT_ELEMENT_VALUE 64
31 //-----------------------------------------------------------------------------
32 // Constructor / Destructor
35 * \brief Constructor from a given DictEntry
36 * @param in Pointer to existing dictionary entry
38 DocEntry::DocEntry(DictEntry* in)
42 SetKey( in->GetKey( ) );
43 Offset = 0 ; // To avoid further missprinting
46 //-----------------------------------------------------------------------------
50 * \brief Prints the common part of ValEntry, BinEntry, SeqEntry
51 * @param os ostream we want to print in
53 void DocEntry::Print(std::ostream& os)
55 PrintLevel = 2; // FIXME
58 unsigned short int g, e;
70 s << DictEntry::TranslateToKey(GetGroup(),GetElement());
75 lgth = GetReadLength(); // ReadLength, as opposed to UsableLength
76 if (lgth == 0xffffffff)
78 st = Util::Format("x(ffff)"); // I said : "x(ffff)" !
79 s.setf(std::ios::left);
80 s << std::setw(10-st.size()) << " ";
82 s.setf(std::ios::left);
83 s << std::setw(8) << "-1";
87 st = Util::Format("x(%x)",lgth);
88 s.setf(std::ios::left);
89 s << std::setw(10-st.size()) << " ";
91 s.setf(std::ios::left);
92 s << std::setw(8) << lgth;
95 st = Util::Format("x(%x)",o);
96 s << std::setw(10-st.size()) << " ";
98 s << std::setw(8) << o;
101 s << "[" << vr << "] ";
105 s.setf(std::ios::left);
106 s << std::setw(66-GetName().length()) << " ";
109 s << "[" << GetName()<< "]";
115 * \brief Writes the common part of any ValEntry, BinEntry, SeqEntry
116 * @param fp already open file pointer
117 * @param filetype type of the file to be written
119 void DocEntry::Write(FILE* fp, FileType filetype)
121 uint32_t ffff = 0xffffffff;
122 uint16_t group = GetGroup();
124 uint16_t el = GetElement();
125 uint32_t lgr = GetReadLength();
127 if ( group == 0xfffe && el == 0x0000 )
129 // Fix in order to make some MR PHILIPS images e-film readable
130 // see gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm:
131 // we just *always* ignore spurious fffe|0000 tag !
136 // ----------- Writes the common part
138 fwrite ( &group,(size_t)2 ,(size_t)1 ,fp); //group
139 fwrite ( &el, (size_t)2 ,(size_t)1 ,fp); //element
141 if ( filetype == ExplicitVR )
143 // Special case of delimiters:
146 // Delimiters have NO Value Representation
147 // Hence we skip writing the VR.
148 // In order to avoid further troubles, we choose to write them
149 // as 'no-length' Item Delimitors (we pad by writing 0xffffffff)
150 // The end of a given Item will be found when :
151 // - a new Item Delimitor Item is encountered (the Seq goes on)
152 // - a Sequence Delimitor Item is encountered (the Seq just ended)
154 // TODO : verify if the Sequence Delimitor Item was forced during Parsing
157 fwrite (&ff,(size_t)4 ,(size_t)1 ,fp);
162 uint16_t shortLgr = lgr;
166 // Unknown was 'written'
167 // deal with Little Endian
168 fwrite ( &shortLgr,(size_t)2 ,(size_t)1 ,fp);
169 fwrite ( &z, (size_t)2 ,(size_t)1 ,fp);
173 fwrite (vr.c_str(),(size_t)2 ,(size_t)1 ,fp);
175 if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") || (vr == "UN") )
177 fwrite ( &z, (size_t)2 ,(size_t)1 ,fp);
180 // we set SQ length to ffffffff
181 // and we shall write a Sequence Delimitor Item
182 // at the end of the Sequence!
183 fwrite ( &ffff,(size_t)4 ,(size_t)1 ,fp);
187 fwrite ( &lgr,(size_t)4 ,(size_t)1 ,fp);
192 fwrite ( &shortLgr,(size_t)2 ,(size_t)1 ,fp);
200 fwrite ( &ffff,(size_t)4 ,(size_t)1 ,fp);
204 fwrite ( &lgr,(size_t)4 ,(size_t)1 ,fp);
209 //-----------------------------------------------------------------------------
214 * \brief Gets the full length of the elementary DocEntry (not only value
215 * length) depending on the VR.
217 uint32_t DocEntry::GetFullLength()
219 uint32_t l = GetReadLength();
220 if ( IsImplicitVR() )
222 l = l + 8; // 2 (gr) + 2 (el) + 4 (lgth)
226 if ( GetVR()=="OB" || GetVR()=="OW" || GetVR()=="SQ" )
228 l = l + 12; // 2 (gr) + 2 (el) + 2 (vr) + 2 (unused) + 4 (lgth)
232 l = l + 8; // 2 (gr) + 2 (el) + 2 (vr) + 2 (lgth)
240 * \brief Copies all the attributes from an other DocEntry
242 void DocEntry::Copy (DocEntry* e)
244 DicomDict = e->DicomDict;
245 UsableLength = e->UsableLength;
246 ReadLength = e->ReadLength;
247 ImplicitVR = e->ImplicitVR;
249 PrintLevel = e->PrintLevel;
250 // TODO : remove DocEntry SQDepth
255 * \brief tells us if entry is the last one of a 'no length' SequenceItem
258 bool DocEntry::IsItemDelimitor()
260 return (GetGroup() == 0xfffe && GetElement() == 0xe00d);
264 * \brief tells us if entry is the last one of a 'no length' Sequence
267 bool DocEntry::IsSequenceDelimitor()
269 return (GetGroup() == 0xfffe && GetElement() == 0xe0dd);
272 //-----------------------------------------------------------------------------
276 //-----------------------------------------------------------------------------
279 //-----------------------------------------------------------------------------
281 } // end namespace gdcm