]> Creatis software - gdcm.git/blob - src/gdcmSeqEntry.h
Avoid warnings
[gdcm.git] / src / gdcmSeqEntry.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmSeqEntry.h,v $
5   Language:  C++
6   Date:      $Date: 2005/11/29 12:48:47 $
7   Version:   $Revision: 1.39 $
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 #ifndef GDCMSQDOCENTRY_H
20 #define GDCMSQDOCENTRY_H
21
22 #include "gdcmDocEntry.h"
23
24 #include <list>
25
26 namespace gdcm 
27 {
28 class SQItem;
29 //-----------------------------------------------------------------------------
30 typedef std::list<SQItem *> ListSQItem;
31
32 //-----------------------------------------------------------------------------
33 /**
34  * \brief a SeqEntry (as opposed to a DataEntry) is a non elementary DocEntry.
35  *        It is composed by a set of SQItems.
36  *        Each SQItem is composed by a set of DocEntry
37  *        A DocEntry may be a SeqEntry
38  *        ... and so forth 
39  */ 
40 class GDCM_EXPORT SeqEntry : public DocEntry 
41 {
42    gdcmTypeMacro(SeqEntry);
43
44 public:
45 /// \brief Contructs a SeqEntry with a RefCounter from DictEntry
46    static SeqEntry *New(DictEntry *e) {return new SeqEntry(e);}
47 /// \brief Contructs a SeqEntry with a RefCounter from DocEntry
48    static SeqEntry *New(DocEntry *d, int depth) {return new SeqEntry(d,depth);}
49
50    void Print(std::ostream &os = std::cout, std::string const &indent = "" ); 
51    void WriteContent(std::ofstream *fp, FileType filetype);
52    uint32_t ComputeFullLength();
53      
54    void AddSQItem(SQItem *it, int itemNumber);
55    void ClearSQItem();
56    SQItem *GetFirstSQItem();
57    SQItem *GetNextSQItem();
58    SQItem *GetSQItem(int itemNumber);
59    unsigned int GetNumberOfSQItems();
60       
61    /// Sets the delimitor mode
62    void SetDelimitorMode(bool dm) { DelimitorMode = dm; }
63    void SetDelimitationItem(DocEntry *e);
64    /// Gets the Sequence Delimitation Item
65    DocEntry *GetDelimitationItem() { return SeqTerm;}
66
67    /// Gets the depth level
68    int GetDepthLevel() const { return SQDepthLevel; }
69    /// Sets the depth level of a Sequence Entry embedded in a SeQuence
70    void SetDepthLevel(int depth) { SQDepthLevel = depth; }
71
72    virtual void Copy(DocEntry *doc);
73
74 protected:
75
76 private:
77    SeqEntry( DictEntry *e);
78    SeqEntry( DocEntry *d, int depth );
79    ~SeqEntry();
80
81 // Variables
82    /// If this Sequence is in delimitor mode (length =0xffffffff) or not
83    bool DelimitorMode;
84    
85    /// Chained list of SQ Items
86    ListSQItem Items;
87    /// iterator on the SQItems of the current SeqEntry
88    ListSQItem::iterator ItSQItem;
89
90    /// sequence terminator item 
91    DocEntry *SeqTerm;
92
93    /// \brief Defines the depth level of this \ref SeqEntry inside
94    ///        the (optionaly) nested sequences. \ref SQDepthLevel
95    ///        and its \ref SQItem::SQDepthLevel counterpart
96    ///        are only defined on printing purposes (see \ref Print).
97    int SQDepthLevel;
98 };
99 } // end namespace gdcm
100 //-----------------------------------------------------------------------------
101 #endif
102