1 /*=========================================================================
4 Module: $RCSfile: gdcmSQItem.h,v $
6 Date: $Date: 2005/01/11 15:15:38 $
7 Version: $Revision: 1.31 $
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);
47 void WriteContent(std::ofstream *fp, FileType filetype);
49 /// \brief returns the DocEntry chained List for this SQ Item.
50 ListDocEntry const &GetDocEntries() const { return DocEntries; };
52 /// \brief adds the passed DocEntry to the DocEntry chained List for
54 bool AddEntry(DocEntry *Entry); // add to the List
55 bool RemoveEntry(DocEntry *EntryToRemove);
56 bool RemoveEntryNoDestroy(DocEntry *EntryToRemove);
58 DocEntry *GetDocEntry(uint16_t group, uint16_t element);
60 bool SetEntry(std::string const &val, uint16_t group,
63 std::string GetEntry(uint16_t group, uint16_t element);
65 /// \brief returns the ordinal position of a given SQItem
66 int GetSQItemNumber() { return SQItemNumber; };
68 /// \brief Sets the ordinal position of a given SQItem
69 void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; };
71 /// \brief Accessor on \ref SQDepthLevel.
72 int GetDepthLevel() { return SQDepthLevel; }
74 /// \brief Accessor on \ref SQDepthLevel.
75 void SetDepthLevel(int depth) { SQDepthLevel = depth; }
77 /// \brief Accessor on \ref BaseTagKey.
78 void SetBaseTagKey( BaseTagKey const &key ) { BaseTagKeyNested = key; }
80 /// \brief Accessor on \ref BaseTagKey.
81 BaseTagKey const &GetBaseTagKey() const { return BaseTagKeyNested; }
84 DocEntry *GetNextEntry();
87 // Variables that need to be access in subclasses
89 /// \brief Chained list of (Elementary) Doc Entries
90 ListDocEntry DocEntries;
91 /// Chained list iterator, used to visit the TagHT variable
92 ListDocEntry::iterator ItDocEntries;
94 /// \brief pointer to the HTable of the Document,
95 /// (because we don't know it within any DicomDirObject nor any SQItem)
96 // TagDocEntryHT *PtagHT;
100 /// \brief Sequences can be nested. This \ref SQDepthLevel represents
101 /// the level of the nesting of instances of this class.
102 /// \ref SQDepthLevel and its \ref SeqEntry::SQDepthLevel
103 /// counterpart are only defined on printing purposes
104 /// (see \ref Print).
107 /// \brief A TagKey of a DocEntry nested in a sequence is prepended
108 /// with this BaseTagKey.
109 BaseTagKey BaseTagKeyNested;
111 /// \brief SQ Item ordinal number
114 } // end namespace gdcm
115 //-----------------------------------------------------------------------------