]> Creatis software - gdcm.git/blob - gdcmSQItem.cxx
d5f11db52aa93f8046a37c2e647b9c076af403ce
[gdcm.git] / gdcmSQItem.cxx
1 /*=========================================================================
2   
3   Program:   gdcm
4   Module:    $RCSfile: gdcmSQItem.cxx,v $
5   Language:  C++
6   Date:      $Date: 2005/11/21 09:46:27 $
7   Version:   $Revision: 1.80 $
8   
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.
12   
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.
16   
17 =========================================================================*/
18
19 #include "gdcmSQItem.h"
20 #include "gdcmSeqEntry.h"
21 #include "gdcmGlobal.h"
22 #include "gdcmDictSet.h"
23 #include "gdcmUtil.h"
24 #include "gdcmDebug.h"
25
26 #include <fstream>
27
28 namespace gdcm 
29 {
30 //-----------------------------------------------------------------------------
31 // Constructor / Destructor
32 /**
33  * \brief   Constructor from a given SQItem
34  */
35 SQItem::SQItem(int depthLevel ) 
36           : DocEntrySet( )
37 {
38    SQDepthLevel = depthLevel;
39    SQItemNumber = 0;
40 }
41
42 /**
43  * \brief   Canonical destructor.
44  */
45 SQItem::~SQItem() 
46 {
47    ClearEntry();
48 }
49
50 //-----------------------------------------------------------------------------
51 // Public
52 /*
53  * \brief   canonical Writer
54  * @param fp     file pointer to an already open file. 
55  * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
56  */
57 void SQItem::WriteContent(std::ofstream *fp, FileType filetype)
58 {
59    int j;
60    uint16_t item[4] = { 0xfffe, 0xe000, 0xffff, 0xffff };
61    uint16_t itemt[4]= { 0xfffe, 0xe00d, 0xffff, 0xffff };
62
63     //we force the writting of an 'Item' Start Element
64     // because we want to write the Item as a 'No Length' item
65    for(j=0;j<4;++j)
66    {
67       binary_write( *fp, item[j]);  // fffe e000 ffff ffff 
68    }
69      
70    for (ListDocEntry::iterator it = DocEntries.begin();  
71                                it != DocEntries.end();
72                              ++it)
73    {   
74       // we skip delimitors (start and end one) because 
75       // we force them as 'no length'
76       if ( (*it)->GetGroup() == 0xfffe )
77       {
78          continue;
79       }
80
81       // Fix in order to make some MR PHILIPS images e-film readable
82       // see gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm:
83       // we just *always* ignore spurious fffe|0000 tag ! 
84       if ( (*it)->GetGroup() == 0xfffe && (*it)->GetElement() == 0x0000 )
85       {
86           break; // FIXME : break or continue; ?!?  
87                  // --> makes no difference since the only bugged file we have
88                  // contains 'impossible tag' fffe|0000 in last position !                            
89       }
90
91       (*it)->WriteContent(fp, filetype);
92    }
93       
94     //we force the writting of an 'Item Delimitation' item
95     // because we wrote the Item as a 'no Length' item
96    for(j=0;j<4;++j)
97    {
98       binary_write( *fp, itemt[j]);  // fffe e000 ffff ffff 
99    } 
100 }
101
102 /**
103  * \brief   Compute the full length of the SQItem (not only value length)
104  *           depending on the VR.
105  */
106 uint32_t SQItem::ComputeFullLength()
107 {
108    uint32_t l = 8;  // Item Starter length
109    for (ListDocEntry::iterator it = DocEntries.begin();  
110                                it != DocEntries.end();
111                              ++it)
112    {   
113       // we skip delimitors (start and end one) because 
114       // we force them as 'no length'
115       if ( (*it)->GetGroup() == 0xfffe )
116       {
117          continue;
118       }
119       l += (*it)->ComputeFullLength();
120    }
121    l += 8; // 'Item Delimitation' item 
122    return l;  
123 }
124
125 /**
126  * \brief   Inserts *in the right place* any Entry (Dicom Element)
127  *          into the Sequence Item
128  * @param entry Entry to add
129  * @return always true 
130  */
131 bool SQItem::AddEntry(DocEntry *entry)
132 {   
133    if (DocEntries.empty() )
134    {
135       DocEntries.push_back(entry);
136       entry->Register();
137       return true;
138    }
139  
140    ListDocEntry::iterator insertSpot;
141    ListDocEntry::iterator it = DocEntries.end();
142    do
143    {
144       it--;
145
146       if ( (*it)->IsItemDelimitor() )
147       {
148          continue;
149       }
150       if ( (*it)->GetGroup() < entry->GetGroup() )
151          break;
152       else
153          if ( (*it)->GetGroup() == entry->GetGroup() &&
154               (*it)->GetElement() < entry->GetElement() )
155             break;
156    } while (it != DocEntries.begin() );
157   
158    ++it;
159    insertSpot = it;
160    //++insertSpot; // ?!?
161    DocEntries.insert(insertSpot, entry); 
162    entry->Register();
163    return true;
164 }   
165
166 /**
167  * \brief   Clear the std::list from given entry AND delete the entry.
168  * @param   entryToRemove Entry to remove AND delete.
169  * @return true if the entry was found and removed; false otherwise
170  */
171 bool SQItem::RemoveEntry( DocEntry *entryToRemove )
172 {
173    for(ListDocEntry::iterator it = DocEntries.begin();
174                               it != DocEntries.end();
175                             ++it)
176    {
177       if ( *it == entryToRemove )
178       {
179          DocEntries.erase(it);
180          gdcmDebugMacro( "One element erased: " << entryToRemove->GetKey() );
181          entryToRemove->Unregister();
182          return true;
183       }
184    }
185    gdcmWarningMacro( "Entry not found: " << entryToRemove->GetKey() );
186    return false ;
187 }
188
189 /**
190  * \brief  Remove all entry in the Sequence Item 
191  */
192 void SQItem::ClearEntry()
193 {
194    for(ListDocEntry::iterator cc = DocEntries.begin();
195                               cc != DocEntries.end();
196                             ++cc)
197    {
198       (*cc)->Unregister();
199    }
200    DocEntries.clear();
201 }
202
203 /**
204  * \brief  Move all the entries from a given Sequence Item 
205  */
206 void SQItem::MoveObject(SQItem *source)
207 {
208    DocEntries = source->DocEntries;
209    source->DocEntries.clear();
210 }
211
212 /**
213  * \brief   Get the first Dicom entry while visiting the SQItem
214  * \return  The first DocEntry if found, otherwhise 0
215  */
216 DocEntry *SQItem::GetFirstEntry()
217 {
218    ItDocEntries = DocEntries.begin();
219    if ( ItDocEntries != DocEntries.end() )
220       return *ItDocEntries;
221    return 0;   
222 }
223                                                                                 
224 /**
225  * \brief   Get the next Dicom entry while visiting the SQItem
226  * \return  The next DocEntry if found, otherwhise NULL
227  */
228 DocEntry *SQItem::GetNextEntry()
229 {
230    ++ItDocEntries;
231    if ( ItDocEntries != DocEntries.end() )
232       return  *ItDocEntries;
233    return NULL;
234 }
235
236 /**
237  * \brief   Gets a Dicom Element inside a SQ Item Entry
238  * @param   group   Group number of the Entry
239  * @param   elem  Element number of the Entry
240  * @return Entry whose (group,elem) was passed. 0 if not found
241  */
242 DocEntry *SQItem::GetDocEntry(uint16_t group, uint16_t elem)
243 {
244    for(ListDocEntry::iterator i =  DocEntries.begin();
245                               i != DocEntries.end(); 
246                             ++i)
247    {
248       if ( (*i)->GetGroup() == group && (*i)->GetElement() == elem )
249          return *i;
250    }
251    return NULL;
252 }
253
254 //-----------------------------------------------------------------------------
255 // Protected
256
257 //-----------------------------------------------------------------------------
258 // Private
259
260 //-----------------------------------------------------------------------------
261 // Print
262 /*
263  * \brief   canonical Printer
264  * @param os     Stream to print to. 
265  * @param indent Indentation string to be prepended during printing.
266  */
267 void SQItem::Print(std::ostream &os, std::string const &)
268 {
269    std::ostringstream s;
270
271    if (SQDepthLevel > 0)
272    {
273       for (int i = 0; i < SQDepthLevel; ++i)
274       {
275          s << "   | " ;
276       }
277    }
278    os << s.str() << " --- SQItem number " << SQItemNumber  << std::endl;
279    for (ListDocEntry::iterator i  = DocEntries.begin();
280                                i != DocEntries.end();
281                              ++i)
282    {
283       DocEntry *Entry = *i;
284       bool PrintEndLine = true;
285
286       os << s.str();
287       Entry->SetPrintLevel(PrintLevel);
288       Entry->Print(os); 
289       if ( dynamic_cast<SeqEntry*>(Entry) )
290       {
291          PrintEndLine = false;
292       }
293       if (PrintEndLine)
294       {
295          os << std::endl;
296       }
297    } 
298 }
299
300 //-----------------------------------------------------------------------------
301 } // end namespace gdcm