2005-01-15 Jean-Pierre Roux <jpr@creatis.univ-lyon1.fr>

[gdcm.git] / src / gdcmDicomDirSerie.h

diff --git a/src/gdcmDicomDirSerie.h b/src/gdcmDicomDirSerie.h
index d86e5e49f1a75de5657d2792378d973622f92079..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: 2005/01/16 04:50:41 $
-  Version:   $Revision: 1.19 $
+  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
@@ -29,7 +29,6 @@ typedef std::list<DicomDirImage *> ListDicomDirImage;
 
 //-----------------------------------------------------------------------------
 /**
- * \ingroup DicomDirSerie
  * \brief   describes a SERIE  within a within a STUDY
  * (DicomDirStudy) of a given DICOMDIR (DicomDir)
  */
@@ -42,29 +41,27 @@ public:
    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.
-    */
+    // 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();
-    
+
 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
 //-----------------------------------------------------------------------------