]> Creatis software - gdcm.git/blob - src/gdcmDicomDirSerie.h
Some more Doxygenation (for Doc/html.developper/annotated.html)
[gdcm.git] / src / gdcmDicomDirSerie.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDicomDirSerie.h,v $
5   Language:  C++
6   Date:      $Date: 2005/01/11 15:15:38 $
7   Version:   $Revision: 1.18 $
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 GDCMDICOMDIRSERIE_H
20 #define GDCMDICOMDIRSERIE_H
21
22 #include "gdcmDicomDirObject.h"
23
24 namespace gdcm 
25 {
26 class DicomDirImage;
27 //-----------------------------------------------------------------------------
28 typedef std::list<DicomDirImage *> ListDicomDirImage;
29
30 //-----------------------------------------------------------------------------
31 /**
32  * \ingroup DicomDirSerie
33  * \brief   describes a SERIE  within a within a STUDY
34  * (DicomDirStudy) of a given DICOMDIR (DicomDir)
35  */
36 class GDCM_EXPORT DicomDirSerie : public DicomDirObject 
37 {
38 public:
39    DicomDirSerie(); 
40    ~DicomDirSerie();
41
42    void Print( std::ostream &os = std::cout );
43    void WriteContent( std::ofstream *fp, FileType t );
44
45    /**
46     * \ingroup DicomDirSerie
47     * \brief   returns the IMAGE chained List for this SERIE.
48     */
49    ListDicomDirImage const &GetDicomDirImages() const { return Images; };
50
51    /**
52     * \ingroup DicomDirSerie
53     * \brief   adds the passed IMAGE to the IMAGE chained List for this SERIE.
54     */       
55    void AddDicomDirImage(DicomDirImage *obj) { Images.push_back(obj); };
56
57 /**
58  * \ingroup DicomDirSerie
59  * \brief   TODO
60  */ 
61    DicomDirImage *NewImage();
62     
63 private:
64 /**
65 * \brief chained list of DicomDirImages
66 */ 
67    ListDicomDirImage Images;
68 };
69 } // end namespace gdcm
70 //-----------------------------------------------------------------------------
71 #endif