STYLE: Remove old comments

[gdcm.git] / src / gdcmSeqEntry.h

diff --git a/src/gdcmSeqEntry.h b/src/gdcmSeqEntry.h
index e23657f9dc15afeccfff2a9f6c1a3d1f2b6caa38..7804b6cfe96f777aef64d863fbf38cb03e084fbf 100644 (file)
--- a/src/gdcmSeqEntry.h
+++ b/src/gdcmSeqEntry.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSeqEntry.h,v $
   Language:  C++
-  Date:      $Date: 2004/10/25 03:03:45 $
-  Version:   $Revision: 1.22 $
+  Date:      $Date: 2005/02/11 15:22:18 $
+  Version:   $Revision: 1.34 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -19,41 +19,52 @@
 #ifndef GDCMSQDOCENTRY_H
 #define GDCMSQDOCENTRY_H
 
-#include "gdcmSQItem.h"
 #include "gdcmDocEntry.h"
+
 #include <list>
+
 namespace gdcm 
 {
-
+class SQItem;
 //-----------------------------------------------------------------------------
 typedef std::list<SQItem *> ListSQItem;
-//-----------------------------------------------------------------------------
 
+//-----------------------------------------------------------------------------
+/**
+ * \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:
-   SeqEntry( DictEntry* );
-   SeqEntry(DocEntry* d,  int depth);
+   SeqEntry( DictEntry *e);
+   SeqEntry( DocEntry *d, int depth );
    ~SeqEntry();
    
-   virtual void Print(std::ostream &os = std::cout); 
-   virtual void Write(std::ofstream *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 const & GetSQItems() const { return Items; }
+   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;}
+   void SetDelimitorMode(bool dm) { DelimitorMode = dm; }
 
    /// Sets the Sequence Delimitation Item
-   void SetSequenceDelimitationItem(DocEntry * e) { SeqTerm = e;}
+   void SetDelimitationItem(DocEntry *e) { SeqTerm = e;   }
 
-   void AddEntry(SQItem *it, int itemNumber);
-   SQItem *GetSQItemByOrdinalNumber(int itemNumber);
+   /// Gets the Sequence Delimitation Item
+   DocEntry *GetDelimitationItem()       { return SeqTerm;}
 
    /// 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; }
 
@@ -61,13 +72,14 @@ protected:
 
 private:
 // 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;
+
    /// sequence terminator item 
    DocEntry *SeqTerm;