]> Creatis software - gdcm.git/blob - src/gdcmDicomDirStudy.h
Update comments for DicomDir stuff
[gdcm.git] / src / gdcmDicomDirStudy.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDicomDirStudy.h,v $
5   Language:  C++
6   Date:      $Date: 2005/02/06 14:31:09 $
7   Version:   $Revision: 1.25 $
8                                                                                 
9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10   l'Image). All rights reserved. See Doc/License.txt or
11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
12                                                                                 
13      This software is distributed WITHOUT ANY WARRANTY; without even
14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15      PURPOSE.  See the above copyright notices for more information.
16                                                                                 
17 =========================================================================*/
18
19 #ifndef GDCMDICOMDIRSTUDY_H
20 #define GDCMDICOMDIRSTUDY_H
21
22 #include "gdcmDicomDirObject.h"
23
24 namespace gdcm 
25 {
26 class DicomDirSerie;
27 //-----------------------------------------------------------------------------
28 typedef std::list<DicomDirSerie *> ListDicomDirSerie;
29
30 //-----------------------------------------------------------------------------
31 /**
32  * \brief   describes a STUDY within a within a PATIENT
33  * (DicomDirPatient) of a given DICOMDIR (DicomDir)
34  */
35 class GDCM_EXPORT DicomDirStudy : public DicomDirObject
36 {
37 public:
38    DicomDirStudy(bool empty=false); 
39    ~DicomDirStudy();
40
41    void Print(std::ostream &os = std::cout, std::string const &indent = "" );
42    void WriteContent(std::ofstream *fp, FileType t);
43
44    // Serie methods
45    DicomDirSerie *NewSerie();
46    /// Adds a gdcm::DicomDirSerie to a Study
47    void AddSerie(DicomDirSerie *obj) { Series.push_back(obj); };
48    void ClearSerie();
49
50    DicomDirSerie *GetFirstSerie();
51    DicomDirSerie *GetNextSerie();
52    DicomDirSerie *GetLastSerie();
53     
54 private:
55
56    /// chained list of DicomDirSeries (to be exploited recursively)
57    ListDicomDirSerie Series;
58    /// iterator on the DicomDirSeries of the current DicomDirStudy
59    ListDicomDirSerie::iterator ItSerie;
60
61 };
62 } // end namespace gdcm
63
64 //-----------------------------------------------------------------------------
65 #endif