* src/gdcmDocument.[h|cxx] : comment all methods concerning a flat hash

[gdcm.git] / src / gdcmSeqEntry.h

diff --git a/src/gdcmSeqEntry.h b/src/gdcmSeqEntry.h
index 5d0ca21b8febaa3fcabba6e399de32d706ada07d..901b33e6bf8d27081fd0ac064c55a07d392e4ea9 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/11/16 02:54:35 $
-  Version:   $Revision: 1.23 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.27 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -19,34 +19,41 @@
 #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();
    
    void Print(std::ostream &os = std::cout); 
-   void Write(std::ofstream *fp, FileType filetype);
+   void WriteContent(std::ofstream *fp, FileType filetype);
 
    /// returns the SQITEM chained List for this SeQuence.
-   ListSQItem const & GetSQItems() const { return Items; }
+   ListSQItem const &GetSQItems() const { return Items; }
       
    /// Sets the delimitor mode
    void SetDelimitorMode(bool dm) { DelimitorMode = dm; }
 
    /// Sets the Sequence Delimitation Item
-   void SetSequenceDelimitationItem(DocEntry * e) { SeqTerm = e;}
+   void SetSequenceDelimitationItem(DocEntry *e) { SeqTerm = e;}
 
    void AddEntry(SQItem *it, int itemNumber);
    SQItem *GetSQItemByOrdinalNumber(int itemNumber);