Program: gdcm
Module: $RCSfile: gdcmSeqEntry.h,v $
Language: C++
- Date: $Date: 2004/09/27 08:39:07 $
- Version: $Revision: 1.18 $
+ Date: $Date: 2005/01/16 04:50:42 $
+ Version: $Revision: 1.28 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#ifndef GDCMSQDOCENTRY_H
#define GDCMSQDOCENTRY_H
-#include <list>
-
-#include "gdcmSQItem.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 ValEntry) 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
{
public:
- gdcmSeqEntry( gdcmDictEntry* );
- gdcmSeqEntry(gdcmDocEntry* d, int depth);
- virtual ~gdcmSeqEntry();
+ SeqEntry( DictEntry *e);
+ SeqEntry( DocEntry *d, int depth );
+ ~SeqEntry();
- virtual void Print(std::ostream &os = std::cout);
- virtual void Write(FILE *fp, FileType);
+ void Print(std::ostream &os = std::cout, std::string const & indent = "" );
+ void WriteContent(std::ofstream *fp, FileType filetype);
/// returns the SQITEM chained List for this SeQuence.
- ListSQItem &GetSQItems() { return items; }
+ ListSQItem const &GetSQItems() const { return Items; }
/// Sets the delimitor mode
- void SetDelimitorMode(bool dm) { delimitor_mode = dm;}
+ void SetDelimitorMode(bool dm) { DelimitorMode = dm; }
/// Sets the Sequence Delimitation Item
- void SetSequenceDelimitationItem(gdcmDocEntry * e) { seq_term = e;}
+ void SetSequenceDelimitationItem(DocEntry *e) { SeqTerm = e;}
- void AddEntry(gdcmSQItem *it, int itemNumber);
- gdcmSQItem *GetSQItemByOrdinalNumber(int itemNumber);
+ void AddEntry(SQItem *it, int itemNumber);
+ SQItem *GetSQItemByOrdinalNumber(int itemNumber);
/// Gets the depth level
- int GetDepthLevel() { return SQDepthLevel; }
-
+ int GetDepthLevel() const { return SQDepthLevel; }
+
/// Sets the depth level of a Sequence Entry embedded in a SeQuence
void SetDepthLevel(int depth) { SQDepthLevel = depth; }
+
protected:
private:
// Variables
/// If this Sequence is in delimitor mode (length =0xffffffff) or not
- bool delimitor_mode;
+ bool DelimitorMode;
/// Chained list of SQ Items
- ListSQItem items;
+ ListSQItem Items;
/// sequence terminator item
- gdcmDocEntry *seq_term;
+ DocEntry *SeqTerm;
- /// \brief Defines the depth level of this \ref gdcmSeqEntry inside
+ /// \brief Defines the depth level of this \ref SeqEntry inside
/// the (optionaly) nested sequences. \ref SQDepthLevel
- /// and its \ref gdcmSQItem::SQDepthLevel counterpart
+ /// and its \ref SQItem::SQDepthLevel counterpart
/// are only defined on printing purposes (see \ref Print).
int SQDepthLevel;
};
-
+} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif