Doxygenation

[gdcm.git] / src / gdcmDicomDirStudy.h

diff --git a/src/gdcmDicomDirStudy.h b/src/gdcmDicomDirStudy.h
index 2d94b737676bda5561efe0dd85e125e49c0bf644..6806dc2ffe17dd1c841d945999e23a6507e44464 100644 (file)
--- a/src/gdcmDicomDirStudy.h
+++ b/src/gdcmDicomDirStudy.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirStudy.h,v $
   Language:  C++
-  Date:      $Date: 2005/02/02 14:52:26 $
-  Version:   $Revision: 1.23 $
+  Date:      $Date: 2005/11/21 09:46:25 $
+  Version:   $Revision: 1.31 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -24,9 +24,17 @@
 namespace gdcm 
 {
 class DicomDirSerie;
+class DicomDirVisit;
 //-----------------------------------------------------------------------------
 typedef std::list<DicomDirSerie *> ListDicomDirSerie;
 
+
+// For future use (Full DICOMDIR)
+typedef std::list<DicomDirVisit *> ListDicomDirVisit;
+/*
+typedef std::list<DicomDirResult *> ListDicomDirResult;
+typedef std::list<DicomDirStudyComponent *> ListDicomDirStudyComponent;
+*/
 //-----------------------------------------------------------------------------
 /**
  * \brief   describes a STUDY within a within a PATIENT
@@ -34,29 +42,72 @@ typedef std::list<DicomDirSerie *> ListDicomDirSerie;
  */
 class GDCM_EXPORT DicomDirStudy : public DicomDirObject
 {
+   gdcmTypeMacro(DicomDirStudy);
+
 public:
-   DicomDirStudy(bool empty=false); 
-   ~DicomDirStudy();
+/// \brief Constructs a DicomDirStudy with a RefCounter
+   static DicomDirStudy *New(bool empty=false) {return new DicomDirStudy(empty);}
 
-   void Print(std::ostream &os = std::cout, std::string const & indent = "" );
+   void Print(std::ostream &os = std::cout, std::string const &indent = "" );
    void WriteContent(std::ofstream *fp, FileType t);
 
-   // Serie methods
-   DicomDirSerie* NewSerie();
-   void AddSerie(DicomDirSerie *obj) { Series.push_back(obj); };
+   // 'Serie' methods
+   DicomDirSerie *NewSerie();
+   /// Adds a gdcm::DicomDirSerie to a gdcm::DicomDirStudy
+   void AddSerie(DicomDirSerie *obj) { Series.push_back(obj); }
    void ClearSerie();
-
    DicomDirSerie *GetFirstSerie();
    DicomDirSerie *GetNextSerie();
    DicomDirSerie *GetLastSerie();
-    
-private:
 
-   /// chained list of DicomDirSeries (to be exploited recursively)
+   // 'Visit' methods
+   DicomDirVisit *NewVisit();
+   /// Adds a gdcm::DicomDirVisit to a gdcm::DicomDirStudy
+   void AddVisit(DicomDirVisit *obj) { Visits.push_back(obj); }
+   void ClearVisit();
+   DicomDirVisit *GetFirstVisit();
+   DicomDirVisit *GetNextVisit();
+   DicomDirVisit *GetLastVisit();
+   
+   // for future use (Full DICOMDIR)
+/*
+   DicomDirResult *GetFirstResult();
+   DicomDirResult *GetNextResult();
+   DicomDirResult *GetLastResult();
+
+   DicomDirStudyComponent *GetFirstStudyComponent();
+   DicomDirStudyComponent *GetNextStudyComponent();
+   DicomDirStudyComponent *GetLastStudyComponent();
+*/    
+
+protected:
+   DicomDirStudy(bool empty=false); 
+   ~DicomDirStudy();
+
+private:
+   /// chained list of DicomDirSeries (to be exploited hierarchicaly)
    ListDicomDirSerie Series;
    /// iterator on the DicomDirSeries of the current DicomDirStudy
    ListDicomDirSerie::iterator ItSerie;
 
+   /// chained list of DicomDirVisits(single level)
+   ListDicomDirVisit Visits;
+   /// iterator on the DicomDirVisits of the current DicomDirStudy
+   ListDicomDirVisit::iterator ItVisit;
+   
+
+   // for future use (Full DICOMDIR)
+/*
+   /// chained list of DicomDirResults(single level)
+   ListDicomDirResult Results;
+   /// iterator on the DicomDirResults of the current DicomDirStudy
+   ListDicomDirResult::iterator ItResult;
+
+   /// chained list of DicomDirStudyComponents(single level)
+   ListDicomDirStudyComponent StudyComponents;
+   /// iterator on the DicomDirStudyComponents of the current DicomDirStudy
+   ListDicomDirStudyComponent::iterator ItStudyComponents;
+*/
 };
 } // end namespace gdcm