]> Creatis software - gdcm.git/blob - src/gdcmSeqEntry.h
* Preparation of writing a gdcmHeader iterator: generalisation of gdcmTagKey
[gdcm.git] / src / gdcmSeqEntry.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmSeqEntry.h,v $
5   Language:  C++
6   Date:      $Date: 2004/09/13 12:10:53 $
7   Version:   $Revision: 1.16 $
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.htm 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 <list>
23
24 #include "gdcmSQItem.h"
25 #include "gdcmDocEntry.h"
26
27 //-----------------------------------------------------------------------------
28 typedef std::list<gdcmSQItem *> ListSQItem;
29 //-----------------------------------------------------------------------------
30
31 class GDCM_EXPORT gdcmSeqEntry : public gdcmDocEntry 
32 {
33 public:
34    gdcmSeqEntry(gdcmDictEntry* e, int depth);
35    gdcmSeqEntry(gdcmDocEntry* d,  int depth);
36    virtual ~gdcmSeqEntry();
37    
38    virtual void Print(std::ostream &os = std::cout); 
39    virtual void Write(FILE *fp, FileType);
40
41    /// returns the SQITEM chained List for this SeQuence.
42    ListSQItem &GetSQItems() { return items; }
43       
44    /// Sets the delimitor mode
45    void SetDelimitorMode(bool dm) { delimitor_mode = dm;}
46
47    /// Sets the Sequence Delimitation Item
48    void SetSequenceDelimitationItem(gdcmDocEntry * e) { seq_term = e;}
49
50    void AddEntry(gdcmSQItem *it, int itemNumber);
51    gdcmSQItem *GetSQItemByOrdinalNumber(int itemNumber);
52
53    /// Gets the depth level
54    int GetDepthLevel() { return SQDepthLevel; }
55                                                                                 
56    /// Sets the depth level of a Sequence Entry embedded in a SeQuence
57    void SetDepthLevel(int depth) { SQDepthLevel = depth; }
58 protected:
59
60 private:
61 // Variables
62
63    /// If this Sequence is in delimitor mode (length =0xffffffff) or not
64    bool delimitor_mode;
65    
66    /// Chained list of SQ Items
67    ListSQItem items;
68    
69    /// sequence terminator item 
70    gdcmDocEntry *seq_term;
71
72    /// Gives the depth level of elements inside SeQuences
73    int SQDepthLevel;
74 };
75
76 //-----------------------------------------------------------------------------
77 #endif
78