1 /*=========================================================================
4 Module: $RCSfile: gdcmSQItem.h,v $
6 Date: $Date: 2005/01/25 15:44:24 $
7 Version: $Revision: 1.37 $
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.
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.
17 =========================================================================*/
21 #include "gdcmDocEntrySet.h"
22 #include "gdcmElementSet.h"
31 //-----------------------------------------------------------------------------
32 typedef std::list<DocEntry *> ListDocEntry;
33 //-----------------------------------------------------------------------------
35 * \brief a SeqEntry is composed by a set of SQItems.
36 * Each SQItem is composed by a set of DocEntry
37 * A DocEntry may be a SeqEntry
40 class GDCM_EXPORT SQItem : public DocEntrySet
43 SQItem(int depthLevel);
46 virtual void Print(std::ostream &os = std::cout, std::string const & indent = "" );
47 void WriteContent(std::ofstream *fp, FileType filetype);
50 bool AddEntry(DocEntry *Entry); // add to the List
51 bool RemoveEntry(DocEntry *EntryToRemove);
52 bool RemoveEntryNoDestroy(DocEntry *EntryToRemove);
54 DocEntry *GetFirstEntry();
55 DocEntry *GetNextEntry();
57 DocEntry *GetDocEntry(uint16_t group, uint16_t elem);
59 bool IsEmpty() { return DocEntries.empty(); };
61 /// \brief returns the ordinal position of a given SQItem
62 int GetSQItemNumber() { return SQItemNumber; };
63 /// \brief Sets the ordinal position of a given SQItem
64 void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; };
66 /// \brief Accessor on \ref SQDepthLevel.
67 int GetDepthLevel() { return SQDepthLevel; }
68 /// \brief Accessor on \ref SQDepthLevel.
69 void SetDepthLevel(int depth) { SQDepthLevel = depth; }
71 /// \brief Accessor on \ref BaseTagKey.
72 void SetBaseTagKey( BaseTagKey const &key ) { BaseTagKeyNested = key; }
74 /// \brief Accessor on \ref BaseTagKey.
75 BaseTagKey const &GetBaseTagKey() const { return BaseTagKeyNested; }
78 // Variables that need to be access in subclasses
79 /// \brief Chained list of (Elementary) Doc Entries
80 ListDocEntry DocEntries;
81 /// Chained list iterator, used to visit the TagHT variable
82 ListDocEntry::iterator ItDocEntries;
85 /// \brief Sequences can be nested. This \ref SQDepthLevel represents
86 /// the level of the nesting of instances of this class.
87 /// \ref SQDepthLevel and its \ref SeqEntry::SQDepthLevel
88 /// counterpart are only defined on printing purposes
92 /// \brief A TagKey of a DocEntry nested in a sequence is prepended
93 /// with this BaseTagKey.
94 BaseTagKey BaseTagKeyNested;
96 /// \brief SQ Item ordinal number
99 } // end namespace gdcm
100 //-----------------------------------------------------------------------------