1 /*=========================================================================
4 Module: $RCSfile: gdcmDicomDir.h,v $
6 Date: $Date: 2004/12/03 20:16:57 $
7 Version: $Revision: 1.41 $
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 //-----------------------------------------------------------------------------
45 * \brief DicomDir defines an object representing a DICOMDIR in memory.
48 class GDCM_EXPORT DicomDir: public Document
51 typedef void(Method)(void*);
53 DicomDir( std::string const & filename, bool parseDir = false );
58 /// \brief canonical Printer
60 void Print(std::ostream &os = std::cout);
62 /// Informations contained in the parser
63 virtual bool IsReadable();
65 /// Returns a pointer to the DicomDirMeta for this DICOMDIR.
66 DicomDirMeta* GetDicomDirMeta() { return MetaElems; };
68 /// Returns the PATIENT chained List for this DICOMDIR.
69 ListDicomDirPatient const & GetDicomDirPatients() const { return Patients; };
72 void ParseDirectory();
74 // Note: the DicomDir:: namespace prefix is needed by Swig in the
75 // following method declarations. Refer to gdcmPython/gdcm.i
76 // for the reasons of this unecessary notation at C++ level.
77 void SetStartMethod( DicomDir::Method*,
79 DicomDir::Method* = NULL );
80 void SetProgressMethod( DicomDir::Method*,
82 DicomDir::Method* = NULL );
83 void SetEndMethod( DicomDir::Method*,
85 DicomDir::Method* = NULL );
86 void SetStartMethodArgDelete( DicomDir::Method* );
87 void SetProgressMethodArgDelete( DicomDir::Method* );
88 void SetEndMethodArgDelete( DicomDir::Method* );
90 /// GetProgress GetProgress
91 float GetProgress() { return Progress; };
93 /// AbortProgress AbortProgress
94 void AbortProgress() { Abort = true; };
96 /// IsAborted IsAborted
97 bool IsAborted() { return Abort; };
100 DicomDirMeta* NewMeta();
101 DicomDirPatient* NewPatient();
104 bool WriteDicomDir(std::string const & fileName);
106 /// Types of the DicomDirObject within the DicomDir
111 GDCM_DICOMDIR_PATIENT,
118 void CreateDicomDirChainedList(std::string const & path);
119 void CallStartMethod();
120 void CallProgressMethod();
121 void CallEndMethod();
125 void CreateDicomDir();
127 bool AddDicomDirMeta();
128 bool AddDicomDirPatientToEnd(DicomDirPatient* dd);
129 bool AddDicomDirStudyToEnd (DicomDirStudy* dd);
130 bool AddDicomDirSerieToEnd (DicomDirSerie* dd);
131 bool AddDicomDirImageToEnd (DicomDirImage* dd);
133 void SetElements(std::string const & path, VectDocument const &list);
134 void SetElement (std::string const & path, DicomDirType type,
136 void MoveSQItem(SQItem* dst,SQItem *src);
138 static bool HeaderLessThan(Document* header1, Document* header2);
142 /// Pointer on *the* DicomDirObject 'DicomDirMeta Elements'
143 DicomDirMeta* MetaElems;
145 /// Chained list of DicomDirPatient (to be exploited recursively)
146 ListDicomDirPatient Patients;
148 /// pointer to the initialisation method for any progress bar
150 /// pointer to the incrementation method for any progress bar
151 Method* ProgressMethod;
152 /// pointer to the termination method for any progress bar
154 /// pointer to the ??? method for any progress bar
155 Method* StartMethodArgDelete;
156 /// pointer to the ??? method for any progress bar
157 Method* ProgressMethodArgDelete;
158 /// pointer to the ??? method for any progress bar
159 Method* EndMethodArgDelete;
160 /// pointer to the ??? for any progress bar
162 /// pointer to the ??? for any progress bar
164 /// pointer to the ??? for any progress bar
166 /// value of the ??? for any progress bar
168 /// value of the ??? for any progress bar
171 } // end namespace gdcm
172 //-----------------------------------------------------------------------------