-// gdcmSeqEntry.h
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmSeqEntry.h,v $
+ Language: C++
+ Date: $Date: 2005/10/24 16:00:48 $
+ Version: $Revision: 1.36 $
+
+ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
+ l'Image). All rights reserved. See Doc/License.txt or
+ http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
+
+ This software is distributed WITHOUT ANY WARRANTY; without even
+ the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ PURPOSE. See the above copyright notices for more information.
+
+=========================================================================*/
#ifndef GDCMSQDOCENTRY_H
#define GDCMSQDOCENTRY_H
+#include "gdcmDocEntry.h"
+
+#include <list>
+
+namespace gdcm
+{
+class SQItem;
//-----------------------------------------------------------------------------
-typedef std::list<gdcmSQItem *> ListSQItem;
-//-----------------------------------------------------------------------------
+typedef std::list<SQItem *> ListSQItem;
-class GDCM_EXPORT gdcmSeqEntry : public gdcmDocEntry
+//-----------------------------------------------------------------------------
+/**
+ * \brief a SeqEntry (as opposed to a DataEntry) is a non elementary DocEntry.
+ * It is composed by a set of SQItems.
+ * Each SQItem is composed by a set of DocEntry
+ * A DocEntry may be a SeqEntry
+ * ... and so forth
+ */
+class GDCM_EXPORT SeqEntry : public DocEntry
{
+ gdcmTypeMacro(SeqEntry);
+
public:
- gdcmSeqEntry(void);
- ~gdcmSeqEntry(void);
+ static SeqEntry *New(DictEntry *e) {return new SeqEntry(e);}
+ static SeqEntry *New(DocEntry *d, int depth) {return new SeqEntry(d,depth);}
+
+ void Print(std::ostream &os = std::cout, std::string const &indent = "" );
+ void WriteContent(std::ofstream *fp, FileType filetype);
+
+ void AddSQItem(SQItem *it, int itemNumber);
+ void ClearSQItem();
+ SQItem *GetFirstSQItem();
+ SQItem *GetNextSQItem();
+ SQItem *GetSQItem(int itemNumber);
+ unsigned int GetNumberOfSQItems();
+
+ /// Sets the delimitor mode
+ void SetDelimitorMode(bool dm) { DelimitorMode = dm; }
+
- virtual void Print(std::ostream &os = std::cout);
+ void SetDelimitationItem(DocEntry *e);
- /// \brief returns the SQITEM chained List for this SeQuence.
- inline ListSQItem &GetSQItems()
- {return items;};
+ /// Gets the Sequence Delimitation Item
+ DocEntry *GetDelimitationItem() { return SeqTerm;}
- /// \brief adds the passed ITEM to the ITEM chained List for this SeQuence.
- inline void AddSQItem(gdcmSQItem *it)
- {items.push_back(it);};
+ /// Gets the depth level
+ int GetDepthLevel() const { return SQDepthLevel; }
+ /// Sets the depth level of a Sequence Entry embedded in a SeQuence
+ void SetDepthLevel(int depth) { SQDepthLevel = depth; }
- /// \brief creates a new SQITEM for this SeQuence.
- gdcmSQItem * NewItem(void);
-
protected:
private:
+ SeqEntry( DictEntry *e);
+ SeqEntry( DocEntry *d, int depth );
+ ~SeqEntry();
// Variables
+ /// If this Sequence is in delimitor mode (length =0xffffffff) or not
+ bool DelimitorMode;
+
+ /// Chained list of SQ Items
+ ListSQItem Items;
+ /// iterator on the SQItems of the current SeqEntry
+ ListSQItem::iterator ItSQItem;
-/// \brief chained list of SQ Items
- ListSQItem items;
+ /// sequence terminator item
+ DocEntry *SeqTerm;
+ /// \brief Defines the depth level of this \ref SeqEntry inside
+ /// the (optionaly) nested sequences. \ref SQDepthLevel
+ /// and its \ref SQItem::SQDepthLevel counterpart
+ /// are only defined on printing purposes (see \ref Print).
+ int SQDepthLevel;
};
-
-
+} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif