]> Creatis software - gdcm.git/blob - src/gdcmDicomDir.h
2005-01-15 Jean-Pierre Roux <jpr@creatis.univ-lyon1.fr>
[gdcm.git] / src / gdcmDicomDir.h
1 /*=========================================================================
2   
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDicomDir.h,v $
5   Language:  C++
6   Date:      $Date: 2005/01/17 10:59:52 $
7   Version:   $Revision: 1.47 $
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 GDCMDICOMDIR_H
20 #define GDCMDICOMDIR_H
21
22 #include "gdcmDocument.h"
23
24 #include <list>
25 #include <vector>
26
27 namespace gdcm 
28 {
29 //-----------------------------------------------------------------------------
30 class DicomDirPatient;
31 class DicomDirMeta;
32 class DicomDirElement;
33 class DicomDirStudy;
34 class DicomDirSerie;
35 class DicomDirImage;
36 class SQItem;
37
38 typedef std::list<DicomDirPatient *>   ListDicomDirPatient;
39 typedef std::vector<Document *>  VectDocument;
40
41 //-----------------------------------------------------------------------------
42
43 /**
44  * \ingroup DicomDir
45  * \brief   DicomDir defines an object representing a DICOMDIR in memory
46  *  as a tree-like structure DicomDirPatient -> DicomDirStudy -> DicomDirSerie
47  * -> DicomDirImage
48  *
49  */
50 class GDCM_EXPORT DicomDir: public Document
51 {
52 public:
53    typedef void(Method)(void*);
54
55    DicomDir( std::string const &filename, bool parseDir = false );
56    DicomDir(); 
57                    
58    ~DicomDir();
59
60    /// \brief   canonical Printer 
61    void Print(std::ostream &os = std::cout, std::string const & indent = "" );
62
63    /// Informations contained in the parser
64    virtual bool IsReadable();
65
66    /// Returns a pointer to the DicomDirMeta for this DICOMDIR. 
67    DicomDirMeta* GetDicomDirMeta() { return MetaElems; };
68
69    // should avoid exposing internal mechanism
70    void InitTraversal();
71    DicomDirPatient *GetNextEntry();
72
73    /// Parsing
74    void ParseDirectory();
75    
76    // Note: the DicomDir:: namespace prefix is needed by Swig in the 
77    //       following method declarations. Refer to gdcmPython/gdcm.i
78    //       for the reasons of this unecessary notation at C++ level.
79    void SetStartMethod(    DicomDir::Method *method,
80                            void *arg = NULL,
81                            DicomDir::Method *argDelete = NULL );
82    void SetProgressMethod( DicomDir::Method *method, 
83                            void *arg = NULL,
84                            DicomDir::Method *argDelete = NULL );
85    void SetEndMethod(      DicomDir::Method *method,
86                            void *arg = NULL, 
87                            DicomDir::Method *argDelete = NULL );
88    void SetStartMethodArgDelete( DicomDir::Method *m );
89    void SetProgressMethodArgDelete( DicomDir::Method *m );
90    void SetEndMethodArgDelete( DicomDir::Method *m );
91
92    /// GetProgress GetProgress
93    float GetProgress()  { return Progress; };
94
95    /// AbortProgress AbortProgress
96    void  AbortProgress() { Abort = true; };
97
98    /// IsAborted IsAborted
99    bool  IsAborted() { return Abort; };
100    
101    /// Adding
102    DicomDirMeta    *NewMeta();
103    DicomDirPatient *NewPatient();
104
105    /// Write  
106    bool WriteDicomDir(std::string const &fileName);
107
108    /// Types of the DicomDirObject within the DicomDir
109    typedef enum
110    {
111       GDCM_DICOMDIR_NONE,
112       GDCM_DICOMDIR_META,
113       GDCM_DICOMDIR_PATIENT,
114       GDCM_DICOMDIR_STUDY,
115       GDCM_DICOMDIR_SERIE,
116       GDCM_DICOMDIR_IMAGE
117    } DicomDirType;
118    
119 protected:
120    void CreateDicomDirChainedList(std::string const &path);
121    void CallStartMethod();
122    void CallProgressMethod();
123    void CallEndMethod();
124
125 private:
126    void Initialize();
127    void CreateDicomDir();
128
129    bool AddDicomDirMeta();
130    bool AddDicomDirPatientToEnd(DicomDirPatient *dd);
131    bool AddDicomDirStudyToEnd  (DicomDirStudy *dd);
132    bool AddDicomDirSerieToEnd  (DicomDirSerie *dd);
133    bool AddDicomDirImageToEnd  (DicomDirImage *dd);
134
135    void SetElements(std::string const &path, VectDocument const &list);
136    void SetElement (std::string const &path, DicomDirType type,
137                     Document *header);
138    void MoveSQItem(SQItem *dst,SQItem *src);
139
140    static bool HeaderLessThan(Document *header1, Document *header2);
141    
142 // Variables
143
144    /// Pointer on *the* DicomDirObject 'DicomDirMeta Elements'
145    DicomDirMeta* MetaElems;
146    ListDicomDirPatient::iterator ItDicomDirPatient;
147
148    /// Chained list of DicomDirPatient (to be exploited recursively) 
149    ListDicomDirPatient Patients;
150
151    /// pointer to the initialisation method for any progress bar   
152    Method* StartMethod;
153    /// pointer to the incrementation method for any progress bar
154    Method* ProgressMethod;
155    /// pointer to the termination method for any progress bar
156    Method* EndMethod;
157    /// pointer to the ??? method for any progress bar   
158    Method* StartMethodArgDelete;
159    /// pointer to the ??? method for any progress bar
160    Method* ProgressMethodArgDelete;
161    /// pointer to the ??? method for any progress bar
162    Method* EndMethodArgDelete;
163    /// pointer to the ??? for any progress bar   
164    void* StartArg;
165    /// pointer to the ??? for any progress bar
166    void* ProgressArg;
167    /// pointer to the ??? for any progress bar   
168    void* EndArg;
169    /// value of the ??? for any progress bar
170    float Progress;
171    /// value of the ??? for any progress bar   
172    bool Abort;
173 };
174 } // end namespace gdcm
175 //-----------------------------------------------------------------------------
176 #endif