]> Creatis software - gdcm.git/blob - src/gdcmSQItem.h
Avoid warnings
[gdcm.git] / src / gdcmSQItem.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmSQItem.h,v $
5   Language:  C++
6   Date:      $Date: 2005/11/29 17:11:52 $
7   Version:   $Revision: 1.50 $
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 #ifndef GDCMSQITEM_H
19 #define GDCMSQITEM_H
20
21 #include "gdcmDocEntrySet.h"
22 #include "gdcmElementSet.h"
23
24 #include <list>
25 #include <fstream>
26
27 namespace gdcm 
28 {
29 class DocEntry;
30
31 //-----------------------------------------------------------------------------
32 typedef std::list<DocEntry *> ListDocEntry;
33
34 //-----------------------------------------------------------------------------
35 /**
36  * \brief a SeqEntry is composed by a set of SQItems.
37  *        Each SQItem is composed by a set of DocEntry
38  *        A DocEntry may be a SeqEntry
39  *        ... and so forth 
40  */ 
41 class GDCM_EXPORT SQItem : public DocEntrySet 
42 {
43    gdcmTypeMacro(SQItem);
44
45 public:
46    static SQItem *New(int depthLevel) {return new SQItem(depthLevel);}
47
48    virtual void Print(std::ostream &os = std::cout, 
49                                                std::string const &indent = "" ); 
50    void WriteContent(std::ofstream *fp, FileType filetype);
51    uint32_t ComputeFullLength();
52
53    bool AddEntry(DocEntry *Entry); // add to the List
54    bool RemoveEntry(DocEntry *EntryToRemove);
55    void ClearEntry();
56   
57    DocEntry *GetFirstEntry();
58    DocEntry *GetNextEntry();
59
60    DocEntry *GetDocEntry(uint16_t group, uint16_t elem);
61
62    bool IsEmpty() { return DocEntries.empty(); }
63
64    /// \brief   returns the ordinal position of a given SQItem
65    int GetSQItemNumber() { return SQItemNumber; }
66    /// \brief   Sets the ordinal position of a given SQItem
67    void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; }
68
69    ///  \brief Accessor on \ref SQDepthLevel.
70    int GetDepthLevel() { return SQDepthLevel; }                                                                             
71
72    ///  \brief Accessor on \ref SQDepthLevel.
73    void SetDepthLevel(int depth) { SQDepthLevel = depth; }
74
75    virtual void Copy(DocEntrySet *set);
76
77 protected:
78    SQItem(int depthLevel);
79    ~SQItem();
80
81 // Variables that need to be accessed in subclasses
82    /// \brief Chained list of Doc Entries
83    ListDocEntry DocEntries;
84    /// Iterator, used to visit the entries
85    ListDocEntry::iterator ItDocEntries;
86   
87 private:
88    /// \brief Sequences can be nested. This \ref SQDepthLevel represents
89    ///        the level of the nesting of instances of this class.
90    ///        \ref SQDepthLevel and its \ref SeqEntry::SQDepthLevel
91    ///        counterpart are only defined on printing purposes
92    ///        (see \ref Print).
93    int SQDepthLevel;
94
95    /// \brief SQ Item ordinal number 
96    int SQItemNumber;
97 };
98 } // end namespace gdcm
99 //-----------------------------------------------------------------------------
100 #endif