1 /*=========================================================================
4 Module: $RCSfile: gdcmSQItem.h,v $
6 Date: $Date: 2004/09/16 19:21:57 $
7 Version: $Revision: 1.15 $
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.
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 =========================================================================*/
22 #include "gdcmDocEntry.h"
23 #include "gdcmDocEntrySet.h"
24 #include "gdcmDocument.h"
29 //-----------------------------------------------------------------------------
30 typedef std::list<gdcmDocEntry *> ListDocEntry;
31 //-----------------------------------------------------------------------------
32 class GDCM_EXPORT gdcmSQItem : public gdcmDocEntrySet
38 virtual void Print(std::ostream &os = std::cout);
39 virtual void Write(FILE *fp, FileType filetype);
41 /// \brief returns the DocEntry chained List for this SQ Item.
42 ListDocEntry &GetDocEntries() { return docEntries; };
44 /// \brief adds the passed DocEntry to the DocEntry chained List for
46 void AddDocEntry(gdcmDocEntry *e) { docEntries.push_back(e); };
48 virtual bool AddEntry(gdcmDocEntry *Entry); // add to the List
50 gdcmDocEntry *GetDocEntryByNumber(uint16_t group, uint16_t element);
51 // FIXME method to write
52 //gdcmDocEntry *GetDocEntryByName (std::string Name);
54 bool SetEntryByNumber(std::string val, uint16_t group, uint16_t element);
56 virtual std::string GetEntryByNumber(uint16_t group, uint16_t element);
58 /// \brief returns the ordinal position of a given SQItem
59 int GetSQItemNumber() { return SQItemNumber; };
61 /// \brief Sets the ordinal position of a given SQItem
62 void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; };
64 /// Accessor on \ref SQDepthLevel.
65 int GetDepthLevel() { return SQDepthLevel; }
67 /// Accessor on \ref SQDepthLevel.
68 void SetDepthLevel(int depth) { SQDepthLevel = depth; }
70 /// Accessor on \ref BaseTagKey.
71 void SetBaseTagKey( gdcmBaseTagKey key ) { BaseTagKey = key; }
73 /// Accessor on \ref BaseTagKey.
74 gdcmBaseTagKey GetBaseTagKey( ) { return BaseTagKey; }
81 /// \brief chained list of (Elementary) Doc Entries
82 ListDocEntry docEntries;
84 /// \brief SQ Item ordinal number
87 ///\brief pointer to the HTable of the gdcmDocument,
88 /// (because we don't know it within any gdcmObject nor any gdcmSQItem)
89 TagDocEntryHT *PtagHT;
94 /// \brief Sequences can be nested. This \ref SQDepthLevel represents
95 /// the level of the nesting of instances of this class.
96 /// \ref SQDepthLevel and its \ref gdcmSeqEntry::SQDepthLevel
97 /// counterpart are only defined on printing purposes
101 /// \brief A TagKey of a gdcmDocEntry nested in a sequence is prepended
102 /// with this BaseTagKey.
103 gdcmBaseTagKey BaseTagKey;
107 //-----------------------------------------------------------------------------