1 /*=========================================================================
4 Module: $RCSfile: gdcmSQItem.h,v $
6 Date: $Date: 2004/12/03 17:13:18 $
7 Version: $Revision: 1.25 $
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 //-----------------------------------------------------------------------------
34 class GDCM_EXPORT SQItem : public DocEntrySet
37 SQItem(int depthLevel);
40 void Print(std::ostream &os = std::cout);
41 void WriteContent(std::ofstream *fp, FileType filetype);
43 /// \brief returns the DocEntry chained List for this SQ Item.
44 ListDocEntry const & GetDocEntries() const { return DocEntries; };
46 /// \brief adds the passed DocEntry to the DocEntry chained List for
48 void AddDocEntry(DocEntry *e) { DocEntries.push_back(e); };
50 bool AddEntry(DocEntry *Entry); // add to the List
51 bool RemoveEntry(DocEntry *EntryToRemove);
52 bool RemoveEntryNoDestroy(DocEntry *EntryToRemove);
54 DocEntry *GetDocEntryByNumber(uint16_t group, uint16_t element);
55 // FIXME method to write
56 //DocEntry *GetDocEntryByName (std::string Name);
58 bool SetEntryByNumber(std::string const & val, uint16_t group,
61 std::string GetEntryByNumber(uint16_t group, uint16_t element);
63 /// \brief returns the ordinal position of a given SQItem
64 int GetSQItemNumber() { return SQItemNumber; };
66 /// \brief Sets the ordinal position of a given SQItem
67 void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; };
69 /// Accessor on \ref SQDepthLevel.
70 int GetDepthLevel() { return SQDepthLevel; }
72 /// Accessor on \ref SQDepthLevel.
73 void SetDepthLevel(int depth) { SQDepthLevel = depth; }
75 /// Accessor on \ref BaseTagKey.
76 void SetBaseTagKey( BaseTagKey const & key ) { BaseTagKeyNested = key; }
78 /// Accessor on \ref BaseTagKey.
79 BaseTagKey const & GetBaseTagKey() const { return BaseTagKeyNested; }
82 DocEntry *GetNextEntry();
85 // Variables that need to be access in subclasses
87 /// \brief Chained list of (Elementary) Doc Entries
88 ListDocEntry DocEntries;
89 /// Chained list iterator, used to visit the TagHT variable
90 ListDocEntry::iterator ItDocEntries;
92 ///\brief pointer to the HTable of the Document,
93 /// (because we don't know it within any DicomDirObject nor any SQItem)
94 TagDocEntryHT *PtagHT;
98 /// \brief Sequences can be nested. This \ref SQDepthLevel represents
99 /// the level of the nesting of instances of this class.
100 /// \ref SQDepthLevel and its \ref SeqEntry::SQDepthLevel
101 /// counterpart are only defined on printing purposes
102 /// (see \ref Print).
105 /// \brief A TagKey of a DocEntry nested in a sequence is prepended
106 /// with this BaseTagKey.
107 BaseTagKey BaseTagKeyNested;
110 /// \brief SQ Item ordinal number
114 } // end namespace gdcm
115 //-----------------------------------------------------------------------------