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

[gdcm.git] / src / gdcmDicomDirStudy.h

diff --git a/src/gdcmDicomDirStudy.h b/src/gdcmDicomDirStudy.h
index 5f37eb2acb6f4d847e1994b4e9d4c4fd2bc1b386..214ba2d9daaa4030e2d8eac912de0fe47ef9a2e9 100644 (file)
--- a/src/gdcmDicomDirStudy.h
+++ b/src/gdcmDicomDirStudy.h
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirStudy.h,v $
   Language:  C++
-  Date:      $Date: 2004/09/23 10:47:10 $
-  Version:   $Revision: 1.8 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.16 $
                                                                                 
   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.htm for details.
+  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
@@ -20,45 +20,53 @@
 #define GDCMDICOMDIRSTUDY_H
 
 #include "gdcmDicomDirObject.h"
-#include "gdcmDicomDirSerie.h"
 
+namespace gdcm 
+{
+class DicomDirSerie;
 //-----------------------------------------------------------------------------
-typedef std::list<gdcmDicomDirSerie *> ListDicomDirSerie;
+typedef std::list<DicomDirSerie *> ListDicomDirSerie;
 
 //-----------------------------------------------------------------------------
-class GDCM_EXPORT gdcmDicomDirStudy : public gdcmDicomDirObject
+/**
+ * \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(gdcmSQItem *s, TagDocEntryHT *ptagHT); 
-   gdcmDicomDirStudy(TagDocEntryHT *ptagHT); 
+   DicomDirStudy(); 
+   ~DicomDirStudy();
 
-   ~gdcmDicomDirStudy();
+   void Print(std::ostream &os = std::cout);
+   void WriteContent(std::ofstream *fp, FileType t);
 
-   virtual void Print(std::ostream &os = std::cout);
-   virtual void Write(FILE *fp, FileType t);
-/**
- * \ingroup gdcmDicomDirStudy
- * \brief   returns the SERIE chained List for this STUDY.
- */
-   ListDicomDirSerie &GetDicomDirSeries() { return series; };
-/**
- * \ingroup gdcmDicomDirStudy
- * \brief   adds the passed SERIE to the SERIE chained List for this STUDY.
- */ 
-   void AddDicomDirSerie(gdcmDicomDirSerie *obj) { series.push_back(obj); };
+   /**
+    * \ingroup DicomDirStudy
+    * \brief   returns the SERIE chained List for this STUDY.
+    */
+   ListDicomDirSerie const &GetDicomDirSeries() const { return Series; };
 
-/**
- * \ingroup gdcmDicomDirStudy
- * \brief   TODO
- */ 
-   gdcmDicomDirSerie* NewSerie();
+   /**
+    * \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:
 /**
 * \brief chained list of DicomDirSeries (to be exploited recursively)
 */ 
-   ListDicomDirSerie series;
+   ListDicomDirSerie Series;
 };
+} // end namespace gdcm
 
 //-----------------------------------------------------------------------------
 #endif