]> Creatis software - gdcm.git/blob - src/gdcmDicomDirStudy.h
STYLE: ivars should start with a capital letter. Accessors should be const to avoid...
[gdcm.git] / src / gdcmDicomDirStudy.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDicomDirStudy.h,v $
5   Language:  C++
6   Date:      $Date: 2004/10/25 04:08:20 $
7   Version:   $Revision: 1.12 $
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 #include "gdcmDicomDirSerie.h"
24 namespace gdcm 
25 {
26
27 //-----------------------------------------------------------------------------
28 typedef std::list<DicomDirSerie *> ListDicomDirSerie;
29
30 //-----------------------------------------------------------------------------
31 class GDCM_EXPORT DicomDirStudy : public DicomDirObject
32 {
33 public:
34    DicomDirStudy(SQItem *s, TagDocEntryHT *ptagHT); 
35    DicomDirStudy(TagDocEntryHT *ptagHT); 
36
37    ~DicomDirStudy();
38
39    void Print(std::ostream &os = std::cout);
40    void Write(std::ofstream *fp, FileType t);
41
42    /**
43     * \ingroup DicomDirStudy
44     * \brief   returns the SERIE chained List for this STUDY.
45     */
46    ListDicomDirSerie const &GetDicomDirSeries() const { return Series; };
47
48    /**
49     * \ingroup DicomDirStudy
50     * \brief   adds the passed SERIE to the SERIE chained List for this STUDY.
51     */ 
52    void AddDicomDirSerie(DicomDirSerie *obj) { Series.push_back(obj); };
53
54    /**
55     * \ingroup DicomDirStudy
56     * \brief   TODO
57     */ 
58    DicomDirSerie* NewSerie();
59     
60 private:
61 /**
62 * \brief chained list of DicomDirSeries (to be exploited recursively)
63 */ 
64    ListDicomDirSerie Series;
65 };
66 } // end namespace gdcm
67
68 //-----------------------------------------------------------------------------
69 #endif