X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDicomDirStudy.h;h=aad51502c0db209410f3b9c75c873f2f6707ae8e;hb=d5e16925a7d3c8dbd0e71b1989629ca0f619b119;hp=4c69b7b0a7670934fca90b526bb2bced3a0fe9c8;hpb=22f785a2627d1e7823701193bd7624739a3e033b;p=gdcm.git

diff --git a/src/gdcmDicomDirStudy.h b/src/gdcmDicomDirStudy.h
index 4c69b7b0..aad51502 100644
--- a/src/gdcmDicomDirStudy.h
+++ b/src/gdcmDicomDirStudy.h
@@ -1,28 +1,72 @@
-// gdcmDicomDirStudy.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDicomDirStudy.h,v $
+  Language:  C++
+  Date:      $Date: 2005/01/16 04:50:41 $
+  Version:   $Revision: 1.17 $
+                                                                                
+  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
+  l'Image). All rights reserved. See Doc/License.txt or
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
+                                                                                
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+                                                                                
+=========================================================================*/
+
 #ifndef GDCMDICOMDIRSTUDY_H
 #define GDCMDICOMDIRSTUDY_H
 
-#include "gdcmObject.h"
-#include "gdcmDicomDirSerie.h"
+#include "gdcmDicomDirObject.h"
 
+namespace gdcm 
+{
+class DicomDirSerie;
 //-----------------------------------------------------------------------------
-typedef std::list<gdcmDicomDirSerie *> ListDicomDirSerie;
+typedef std::list<DicomDirSerie *> ListDicomDirSerie;
 
 //-----------------------------------------------------------------------------
-class GDCM_EXPORT gdcmDicomDirStudy : public gdcmObject {
+/**
+ * \ingroup DicomDirStudy
+ * \brief   describes a STUDY within a within a PATIENT
+ * (DicomDirPatient) of a given DICOMDIR (DicomDir)
+ */
+class GDCM_EXPORT DicomDirStudy : public DicomDirObject
+{
 public:
-   gdcmDicomDirStudy(ListTag::iterator begin,ListTag::iterator end);
-   ~gdcmDicomDirStudy(void);
+   DicomDirStudy(); 
+   ~DicomDirStudy();
+
+   void Print(std::ostream &os = std::cout, std::string const & indent = "" );
+   void WriteContent(std::ofstream *fp, FileType t);
 
-   virtual void Print(std::ostream &os = std::cout);
+   /**
+    * \ingroup DicomDirStudy
+    * \brief   returns the SERIE chained List for this STUDY.
+    */
+   ListDicomDirSerie const &GetDicomDirSeries() const { return Series; };
 
-   inline ListDicomDirSerie &GetDicomDirSeries() {return series;};
-   inline void AddDicomDirSerie(gdcmDicomDirSerie *obj) {series.push_back(obj);};
+   /**
+    * \ingroup DicomDirStudy
+    * \brief   adds the passed SERIE to the SERIE chained List for this STUDY.
+    */ 
+   void AddDicomDirSerie(DicomDirSerie *obj) { Series.push_back(obj); };
 
+   /**
+    * \ingroup DicomDirStudy
+    * \brief   TODO
+    */ 
+   DicomDirSerie* NewSerie();
+    
 private:
-   ListDicomDirSerie series;
+/**
+* \brief chained list of DicomDirSeries (to be exploited recursively)
+*/ 
+   ListDicomDirSerie Series;
 };
+} // end namespace gdcm
 
 //-----------------------------------------------------------------------------
 #endif