1 /*=========================================================================
4 Module: $RCSfile: gdcmDicomDir.h,v $
6 Date: $Date: 2005/04/14 14:26:19 $
7 Version: $Revision: 1.59 $
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.
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.
17 =========================================================================*/
19 #ifndef GDCMDICOMDIR_H
20 #define GDCMDICOMDIR_H
22 #include "gdcmDocument.h"
29 //-----------------------------------------------------------------------------
30 class DicomDirPatient;
32 class DicomDirElement;
38 typedef std::list<DicomDirPatient *> ListDicomDirPatient;
39 typedef std::vector<Document *> VectDocument;
41 //-----------------------------------------------------------------------------
43 * \brief DicomDir defines an object representing a DICOMDIR in memory
44 * as a tree-like structure DicomDirPatient
49 class GDCM_EXPORT DicomDir: public Document
52 typedef void Method(void*);
54 DicomDir( std::string const &filename, bool parseDir = false );
59 void Load( std::string const &filename );
60 void Print(std::ostream &os = std::cout, std::string const &indent = "" );
62 void SetParseDir(bool parseDir) { ParseDir = parseDir; };
63 // Informations contained in the parser
64 virtual bool IsReadable();
67 DicomDirMeta *NewMeta();
68 /// Returns a pointer to the DicomDirMeta for this DICOMDIR.
69 DicomDirMeta *GetMeta() { return MetaElems; };
72 DicomDirPatient *NewPatient();
75 DicomDirPatient *GetFirstPatient();
76 DicomDirPatient *GetNextPatient();
79 void ParseDirectory();
81 // Note: the DicomDir:: namespace prefix is needed by Swig in the
82 // following method declarations. Refer to gdcmPython/gdcm.i
83 // for the reasons of this unnecessary notation at C++ level.
84 void SetStartMethod( DicomDir::Method *method,
86 DicomDir::Method *argDelete = NULL );
87 void SetProgressMethod( DicomDir::Method *method,
89 DicomDir::Method *argDelete = NULL );
90 void SetEndMethod( DicomDir::Method *method,
92 DicomDir::Method *argDelete = NULL );
93 void SetStartMethodArgDelete ( DicomDir::Method *m );
94 void SetProgressMethodArgDelete( DicomDir::Method *m );
95 void SetEndMethodArgDelete ( DicomDir::Method *m );
97 /// GetProgress GetProgress
98 float GetProgress() { return Progress; };
99 /// AbortProgress AbortProgress
100 void AbortProgress() { Abort = true; };
101 /// IsAborted IsAborted
102 bool IsAborted() { return Abort; };
105 bool WriteDicomDir(std::string const &fileName);
107 bool AnonymizeDicomDir();
109 /// Types of the DicomDirObject within the DicomDir
114 GDCM_DICOMDIR_PATIENT,
121 void CreateDicomDirChainedList(std::string const &path);
122 void CallStartMethod();
123 void CallProgressMethod();
124 void CallEndMethod();
128 void CreateDicomDir();
130 bool AddPatientToEnd(DicomDirPatient *dd);
131 bool AddStudyToEnd (DicomDirStudy *dd);
132 bool AddSerieToEnd (DicomDirSerie *dd);
133 bool AddImageToEnd (DicomDirImage *dd);
135 void SetElements(std::string const &path, VectDocument const &list);
136 void SetElement (std::string const &path, DicomDirType type,
138 void MoveSQItem(DocEntrySet *dst, DocEntrySet *src);
140 static bool HeaderLessThan(Document *header1, Document *header2);
144 /// Pointer on *the* DicomDirObject 'DicomDirMeta Elements'
145 DicomDirMeta *MetaElems;
147 /// Chained list of DicomDirPatient (to be exploited hierarchicaly)
148 ListDicomDirPatient Patients;
149 ListDicomDirPatient::iterator ItPatient;
151 /// pointer to the initialisation method for any progress bar
153 /// pointer to the incrementation method for any progress bar
154 Method *ProgressMethod;
155 /// pointer to the termination method for any progress bar
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
165 /// pointer to the ??? for any progress bar
167 /// pointer to the ??? for any progress bar
169 /// value of the ??? for any progress bar
171 /// value of the ??? for any progress bar
175 } // end namespace gdcm
176 //-----------------------------------------------------------------------------