]> Creatis software - gdcm.git/blob - src/gdcmSeqEntry.cxx
* src/gdcmSQItem[h|cxx] : rename some methods to have coherent names
[gdcm.git] / src / gdcmSeqEntry.cxx
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmSeqEntry.cxx,v $
5   Language:  C++
6   Date:      $Date: 2005/01/20 11:26:18 $
7   Version:   $Revision: 1.48 $
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 "gdcmSeqEntry.h"
20 #include "gdcmSQItem.h"
21 #include "gdcmTS.h"
22 #include "gdcmGlobal.h"
23 #include "gdcmUtil.h"
24 #include "gdcmDebug.h"
25
26 #include <iostream>
27 #include <iomanip>
28 #include <fstream>
29
30 namespace gdcm 
31 {
32
33 //-----------------------------------------------------------------------------
34 // Constructor / Destructor
35 /**
36  * \brief   Constructor from a given SeqEntry
37  */
38 SeqEntry::SeqEntry( DictEntry *e ) 
39              : DocEntry(e)
40 {
41    Length       = 0;
42    ReadLength   = 0xffffffff;
43    SQDepthLevel = -1;
44
45    DelimitorMode = false;
46    SeqTerm  = NULL;
47 }
48
49 /**
50  * \brief   Constructor from a given SeqEntry
51  * @param   e Pointer to existing Doc entry
52  * @param   depth depth level of the current Seq entry
53   */
54 SeqEntry::SeqEntry( DocEntry *e, int depth )
55              : DocEntry( e->GetDictEntry() )
56 {
57    Length       = 0;
58    ReadLength   = 0xffffffff;
59    SQDepthLevel = depth;
60
61    ImplicitVR   = e->IsImplicitVR();
62    Offset       = e->GetOffset();
63    SeqTerm = NULL;
64 }
65
66 /**
67  * \brief   Canonical destructor.
68  */
69 SeqEntry::~SeqEntry()
70 {
71    for(ListSQItem::iterator cc = Items.begin(); cc != Items.end(); ++cc)
72    {
73       delete *cc;
74    }
75    if (SeqTerm)
76    {
77       delete SeqTerm;
78    }
79 }
80
81 //-----------------------------------------------------------------------------
82 // Print
83 /**
84  * \brief   canonical Printer
85  */
86 void SeqEntry::Print( std::ostream &os, std::string const & )
87 {
88    // First, Print the Dicom Element itself.
89    os << "S ";
90    DocEntry::Print(os);
91    os << std::endl;
92
93    if (GetReadLength() == 0)
94       return;
95
96    // Then, Print each SQ Item   
97    for(ListSQItem::iterator cc = Items.begin(); cc != Items.end(); ++cc)
98    {
99       (*cc)->SetPrintLevel(PrintLevel);
100       (*cc)->Print(os);   
101    }
102
103    // at end, print the sequence terminator item, if any
104    if (DelimitorMode)
105    {
106       for ( int i = 0; i < SQDepthLevel; i++ )
107       {
108          os << "   | " ;
109       }
110       if (SeqTerm != NULL)
111       {
112          SeqTerm->SetPrintLevel(PrintLevel);
113          SeqTerm->Print(os);
114          os << std::endl;
115       } 
116       else 
117       {
118          // fuse
119          gdcmVerboseMacro("  -------- should have a sequence terminator item");
120       }
121    }                    
122 }
123
124 //-----------------------------------------------------------------------------
125 // Public
126 /*
127  * \brief   canonical Writer
128  */
129 void SeqEntry::WriteContent(std::ofstream *fp, FileType filetype)
130 {
131    uint16_t seq_term_gr = 0xfffe;
132    uint16_t seq_term_el = 0xe0dd;
133    uint32_t seq_term_lg = 0xffffffff;
134
135    //uint16_t item_term_gr = 0xfffe;
136    //uint16_t item_term_el = 0xe00d;
137    
138    DocEntry::WriteContent(fp, filetype);
139    for(ListSQItem::iterator cc  = Items.begin();
140                             cc != Items.end();
141                           ++cc)
142    {        
143       (*cc)->WriteContent(fp, filetype);
144    }
145    
146    // we force the writting of a Sequence Delimitation item
147    // because we wrote the Sequence as a 'no Length' sequence
148    binary_write(*fp, seq_term_gr);
149    binary_write(*fp, seq_term_el);
150    binary_write(*fp, seq_term_lg);
151 }
152
153 /**
154  * \brief   Get the first entry while visiting the SeqEntry
155  * \return  The first SQItem if found, otherwhise NULL
156  */ 
157 SQItem *SeqEntry::GetFirstSQItem()
158 {
159    ItSQItem = Items.begin();
160    if (ItSQItem != Items.end())
161       return *ItSQItem;
162    return NULL;
163
164
165 /**
166  * \brief   Get the next SQItem while visiting the SeqEntry
167  * \note : meaningfull only if GetFirstEntry already called
168  * \return  The next SQItem if found, otherwhise NULL
169  */
170
171 SQItem *SeqEntry::GetNextSQItem()
172 {
173    gdcmAssertMacro (ItSQItem != Items.end())
174    {
175       ++ItSQItem;
176       if (ItSQItem != Items.end())
177          return *ItSQItem;
178    }
179    return NULL;
180 }
181  
182 /**
183  * \brief return a pointer to the SQItem referenced by its ordinal number.
184  *        Returns the first item when argument is negative.
185  *        Returns the last item when argument is bigger than the total
186  *        item number.
187  */
188 SQItem *SeqEntry::GetSQItem(int nb)
189 {
190    if (nb<0)
191    {
192       return *(Items.begin());
193    }
194    int count = 0 ;
195    for(ListSQItem::iterator cc = Items.begin();
196                            cc != Items.end();
197                            count ++, ++cc)
198    {
199       if (count == nb)
200       {
201          return *cc;
202       }
203    }
204    return *(Items.end()); // Euhhhhh ?!? Is this the last one . FIXME
205 }
206
207 unsigned int SeqEntry::GetNumberOfSQItems()
208 {
209    return Items.size();
210 }
211
212 /// \brief   adds the passed ITEM to the ITEM chained List for this SeQuence.
213 void SeqEntry::AddSQItem(SQItem *sqItem, int itemNumber)
214 {
215    sqItem->SetSQItemNumber(itemNumber);
216    Items.push_back(sqItem);
217 }
218
219 //-----------------------------------------------------------------------------
220 // Protected
221
222
223 //-----------------------------------------------------------------------------
224 // Private
225
226 //-----------------------------------------------------------------------------
227 } // end namespace gdcm
228