in order to be able to use fearlessly copy-paste group-elem are now called

[gdcm.git] / src / gdcmDicomDirSerie.h

diff --git a/src/gdcmDicomDirSerie.h b/src/gdcmDicomDirSerie.h
index 8021d859a0f5c3e072247833993a951edd2a03c4..992231747dea2e68f18acb63c13d3b26e475b35d 100644 (file)
--- a/src/gdcmDicomDirSerie.h
+++ b/src/gdcmDicomDirSerie.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirSerie.h,v $
   Language:  C++
-  Date:      $Date: 2004/11/25 15:46:11 $
-  Version:   $Revision: 1.14 $
+  Date:      $Date: 2005/01/17 10:59:52 $
+  Version:   $Revision: 1.20 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -20,48 +20,48 @@
 #define GDCMDICOMDIRSERIE_H
 
 #include "gdcmDicomDirObject.h"
-#include "gdcmDicomDirImage.h"
 
 namespace gdcm 
 {
+class DicomDirImage;
 //-----------------------------------------------------------------------------
 typedef std::list<DicomDirImage *> ListDicomDirImage;
 
 //-----------------------------------------------------------------------------
+/**
+ * \brief   describes a SERIE  within a within a STUDY
+ * (DicomDirStudy) of a given DICOMDIR (DicomDir)
+ */
 class GDCM_EXPORT DicomDirSerie : public DicomDirObject 
 {
 public:
-   DicomDirSerie( SQItem* s, TagDocEntryHT* ptagHT ); 
-   DicomDirSerie( TagDocEntryHT* ptagHT ); 
-
+   DicomDirSerie(); 
    ~DicomDirSerie();
 
-   void Print( std::ostream& os = std::cout );
-   void WriteContent( std::ofstream* fp, FileType t );
+   void Print( std::ostream &os = std::cout, std::string const & indent = "" );
+   void WriteContent( std::ofstream *fp, FileType t );
 
-   /**
-    * \ingroup DicomDirSerie
-    * \brief   returns the IMAGE chained List for this SERIE.
-    */
-   ListDicomDirImage const & GetDicomDirImages() const { return Images; };
+    // TODO Remove GetDicomDirImages
+    // use InitTraversal + GetNextEntry instead.
+ 
+   /// Returns the IMAGE chained List for this SERIE.
+   ListDicomDirImage const &GetDicomDirImages() const { return Images; };
 
-   /**
-    * \ingroup DicomDirSerie
-    * \brief   adds the passed IMAGE to the IMAGE chained List for this SERIE.
-    */       
+   // should avoid exposing internal mechanism
+   void InitTraversal();
+   DicomDirImage *GetNextEntry();
+        
+   /// adds the passed IMAGE to the IMAGE chained List for this SERIE.    
    void AddDicomDirImage(DicomDirImage *obj) { Images.push_back(obj); };
 
-/**
- * \ingroup DicomDirSerie
- * \brief   TODO
- */ 
-   DicomDirImage* NewImage();
-    
+   DicomDirImage *NewImage();
+
 private:
-/**
-* \brief chained list of DicomDirImages
-*/ 
+
+   ///chained list of DicomDirImages (to be exploited recursively)
    ListDicomDirImage Images;
+   /// iterator on the DicomDirImages of the current DicomDirSerie
+   ListDicomDirImage::iterator ItDicomDirImage;
 };
 } // end namespace gdcm
 //-----------------------------------------------------------------------------