Doxygenation

[gdcm.git] / src / gdcmDicomDirSerie.h

diff --git a/src/gdcmDicomDirSerie.h b/src/gdcmDicomDirSerie.h
index 751400477ed396ad5f0f7817b1ddf4cc15902424..eecc374ae82ed599e0d9d436c62bee6533767816 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/20 11:09:23 $
-  Version:   $Revision: 1.22 $
+  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
@@ -34,29 +34,123 @@ typedef std::list<DicomDirImage *> ListDicomDirImage;
  */
 class GDCM_EXPORT DicomDirSerie : public DicomDirObject 
 {
+   gdcmTypeMacro(DicomDirSerie);
+
 public:
-   DicomDirSerie(); 
-   ~DicomDirSerie();
+/// \brief Constructs a DicomDirSerie with a RefCounter
+   static DicomDirSerie *New(bool empty=false) {return new DicomDirSerie(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 );
- 
-   // should avoid exposing internal mechanism
+
+   // Image methods
+   DicomDirImage *NewImage();
+   /// Add a new gdcm::DicomDirImage to the Serie
+   void AddImage(DicomDirImage *obj) { Images.push_back(obj); }
+   void ClearImage();
+
    DicomDirImage *GetFirstImage();
    DicomDirImage *GetNextImage();
-   DicomDirImage *GetLastImage();
-        
-   /// adds the passed IMAGE to the IMAGE chained List for this SERIE.    
-   void AddImage(DicomDirImage *obj) { Images.push_back(obj); };
 
-   DicomDirImage *NewImage();
+protected:
+   DicomDirSerie(bool empty=false); 
+   ~DicomDirSerie();
 
 private:
-
    ///chained list of DicomDirImages (to be exploited recursively)
    ListDicomDirImage Images;
    /// iterator on the DicomDirImages of the current DicomDirSerie
    ListDicomDirImage::iterator ItImage;
+
+/*
+// for future use :
+
+   /// chained list of DicomDirOverlays(single level)
+   ListDicomDirOverlay Overlays;
+   /// iterator on the DicomDirOverlays of the current DicomDirSerie
+   ListDicomDirOverlay::iterator ItOverlay;
+
+   /// chained list of DicomDirModalityLuts(single level)
+   ListDicomDirModalityLut ModalityLuts;
+   /// iterator on the DicomDirModalityLuts of the current DicomDirSerie
+   ListDicomDirModalityLut::iterator ItModalityLut;
+
+   /// chained list of DicomDirModalityLuts(single level)
+   ListDicomDirModalityLut ModalityLuts;
+   /// iterator on the DicomDirModalityLuts of the current DicomDirSerie
+   ListDicomDirModalityLut::iterator ItModalityLuts;
+
+   /// chained list of DicomDirCurves(single level)
+   ListDicomDirCurve Curves;
+   /// iterator on the DicomDirCurves of the current DicomDirSerie
+   ListDicomDirCurve::iterator ItCurves;
+
+   /// chained list of DicomDirStoredPrints(single level)
+   ListDicomDirStoredPrint StoredPrints;
+   /// iterator on the DicomDirStoredPrints of the current DicomDirSerie
+   ListDicomDirStoredPrint::iterator ItStoredPrints;
+
+   /// chained list of DicomDirRtDoses(single level)
+   ListDicomDirRtDose RtDoses;
+   /// iterator on the DicomDirRtDoses of the current DicomDirSerie
+   ListDicomDirRtDose::iterator ItRtDoses;
+
+   /// chained list of DicomDirRtStructureSets(single level)
+   ListDicomDirRtStructureSet RtStructureSets;
+   /// iterator on the DicomDirRtStructureSets of the current DicomDirSerie
+   ListDicomDirRtStructureSet::iterator ItRtStructureSets;
+
+   /// chained list of DicomDirRtPlans(single level)
+   ListDicomDirRtPlan RtPlans;
+   /// iterator on the DicomDirRtPlans of the current DicomDirSerie
+   ListDicomDirPlan::iterator ItRtPlans;
+
+   /// chained list of DicomDirRtTreatRecords(single level)
+   ListDicomDirRtTreatRecord RtTreatRecords;
+   /// iterator on the DicomDirRtTreatRecords of the current DicomDirSerie
+   ListDicomDirRtTreatRecord::iterator ItRtTreatRecords;
+
+   /// chained list of DicomDirPresentations(single level)
+   ListDicomDirPresentation Presentations;
+   /// iterator on the DicomDirPresentations of the current DicomDirSerie
+   ListDicomDirPresentation::iterator ItPresentations;
+
+   /// chained list of DicomDirWaveForms(single level)
+   ListDicomDirWaveForm WaveForms;
+   /// iterator on the DicomDirWaveForms of the current DicomDirSerie
+   ListDicomDirWaveForm::iterator ItWaveForms;
+
+   /// chained list of DicomDirSrDocuments(single level)
+   ListDicomDirSrDocument SrDocuments;
+   /// iterator on the DicomDirSrDocuments of the current DicomDirSerie
+   ListDicomDirSrDocument::iterator ItSrDocuments;
+
+   /// chained list of DicomDirKeyObjectDocs(single level)
+   ListDicomDirKeyObjectDoc KeyObjectDocs;
+   /// iterator on the DicomDirKeyObjectDocs of the current DicomDirSerie
+   ListDicomDirKeyObjectDoc::iterator ItKeyObjectDocs;
+
+   /// chained list of DicomDirSpectroscopys(single level)
+   ListDicomDirSpectroscopy Spectroscopys;
+   /// iterator on the DicomDirSpectroscopys of the current DicomDirSerie
+   ListDicomDirSpectroscopy::iterator ItSpectroscopys;
+
+   /// chained list of DicomDirRawDatas(single level)
+   ListDicomDirRawData RawDatas;
+   /// iterator on the DicomDirRawDatas of the current DicomDirSerie
+   ListDicomDirRawData::iterator ItRawDatas;
+
+   /// chained list of DicomDirRegistrations(single level)
+   ListDicomDirRegistration Registrations;
+   /// iterator on the DicomDirRegistrations of the current DicomDirSerie
+   ListDicomDirRegistration::iterator ItRegistrations;
+
+   /// chained list of DicomDirFiducials(single level)
+   ListDicomDirFiducial Fiducials;
+   /// iterator on the DicomDirFiducials of the current DicomDirSerie
+   ListDicomDirFiducial::iterator ItFiducials;
+*/
+
 };
 } // end namespace gdcm
 //-----------------------------------------------------------------------------