Program: gdcm
Module: $RCSfile: gdcmDicomDir.h,v $
Language: C++
- Date: $Date: 2004/08/02 16:42:14 $
- Version: $Revision: 1.26 $
+ Date: $Date: 2005/11/21 09:46:25 $
+ Version: $Revision: 1.70 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
- http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+ http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
#ifndef GDCMDICOMDIR_H
#define GDCMDICOMDIR_H
-#include "gdcmCommon.h"
#include "gdcmDocument.h"
-#include "gdcmDicomDirPatient.h"
-#include "gdcmDicomDirMeta.h"
-#include "gdcmDicomDirElement.h"
+#include "gdcmDebug.h"
#include <list>
#include <vector>
+namespace gdcm
+{
//-----------------------------------------------------------------------------
-typedef std::list<gdcmDicomDirPatient*> ListDicomDirPatient;
-typedef std::vector<gdcmDocument*> VectDocument;
+class DicomDirPatient;
+class DicomDirMeta;
+class DicomDirElement;
+class DicomDirStudy;
+class DicomDirSerie;
+class DicomDirVisit;
+class DicomDirImage;
+class SQItem;
+
+typedef std::list<DicomDirPatient *> ListDicomDirPatient;
+typedef std::vector<Document *> VectDocument;
-typedef GDCM_EXPORT void(gdcmMethod)(void * = NULL);
//-----------------------------------------------------------------------------
-
/**
- * \ingroup gdcmDicomDir
- * \brief gdcmDicomDir defines an object representing a DICOMDIR in memory.
- *
+ * \brief DicomDir defines an object representing a DICOMDIR in memory
+ * as a tree-like structure DicomDirPatient
+ * -> DicomDirStudy
+ * -> DicomDirSerie
+ * -> DicomDirImage
*/
-class GDCM_EXPORT gdcmDicomDir: public gdcmDocument
+class GDCM_EXPORT DicomDir: public Document
{
+ gdcmTypeMacro(DicomDir);
+
public:
- gdcmDicomDir( std::string const & fileName, bool parseDir = false );
- gdcmDicomDir();
-
- ~gdcmDicomDir();
+/// \brief Constructs a DicomDir with a RefCounter
+ static DicomDir *New() {return new DicomDir();}
- /// \brief canonical Printer
- /// \sa SetPrintLevel
- virtual void Print(std::ostream &os = std::cout);
+ typedef void Method(void*);
-// Informations contained in the parser
+ bool Load( );
+ void Print(std::ostream &os = std::cout, std::string const &indent = "" );
+
+ /// Sets the root Directory name to parse, recursively
+ void SetDirectoryName(std::string const &dirName)
+ { ParseDir = true; if (Filename != dirName)
+ Filename = dirName, IsDocumentModified = true; }
+ /// Accessor to \ref Filename
+ virtual void SetFileName(std::string const &fileName)
+ { ParseDir = false; if (Filename != fileName)
+ Filename = fileName, IsDocumentModified = true;}
+
+ // Informations contained in the parser
virtual bool IsReadable();
- /// Returns a pointer to the gdcmDicomDirMeta for this DICOMDIR.
- gdcmDicomDirMeta* GetDicomDirMeta() { return metaElems; };
+ // Meta
+ DicomDirMeta *NewMeta();
+ /// Returns a pointer to the DicomDirMeta for this DICOMDIR.
+ DicomDirMeta *GetMeta() { return MetaElems; }
+
+ // Patients
+ DicomDirPatient *NewPatient();
+ void ClearPatient();
- /// Returns the PATIENT chained List for this DICOMDIR.
- ListDicomDirPatient &GetDicomDirPatients() { return patients; };
+ DicomDirPatient *GetFirstPatient();
+ DicomDirPatient *GetNextPatient();
-// Parsing
+ // Parsing
void ParseDirectory();
-
- void SetStartMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL);
- void SetStartMethodArgDelete(gdcmMethod *);
- void SetProgressMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL);
- void SetProgressMethodArgDelete(gdcmMethod *);
- void SetEndMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL);
- void SetEndMethodArgDelete(gdcmMethod *);
- /// GetProgress GetProgress
- float GetProgress() { return progress; };
+ // Note: the DicomDir:: namespace prefix is needed by Swig in the
+ // following method declarations. Refer to gdcmPython/gdcm.i
+ // for the reasons of this unnecessary notation at C++ level.
+ void SetStartMethod( DicomDir::Method *method,
+ void *arg = NULL );
+ void SetProgressMethod( DicomDir::Method *method,
+ void *arg = NULL );
+ void SetEndMethod( DicomDir::Method *method,
+ void *arg = NULL );
+ // Note: replace DicomDir::Method *method to void(*method)(void *) to
+ // avoid wrapping problems with the typemap conversions
+ void SetStartMethod( void(*method)(void *), // DicomDir::Method *method
+ void *arg,
+ void(*argDelete)(void *));
+ void SetProgressMethod( void(*method)(void *), // DicomDir::Method *method
+ void *arg,
+ void(*argDelete)(void *));
+ void SetEndMethod( void(*method)(void *), // DicomDir::Method *method
+ void *arg,
+ void(*argDelete)(void *));
+ void SetStartMethodArgDelete ( DicomDir::Method *method );
+ void SetProgressMethodArgDelete( DicomDir::Method *method );
+ void SetEndMethodArgDelete ( DicomDir::Method *method );
+ /// GetProgress GetProgress
+ float GetProgress() { return Progress; }
/// AbortProgress AbortProgress
- void AbortProgress() { abort = true; };
-
+ void AbortProgress() { Abort = true; }
/// IsAborted IsAborted
- bool IsAborted() { return abort; };
-
-// Adding
- gdcmDicomDirMeta* NewMeta();
- gdcmDicomDirPatient* NewPatient();
+ bool IsAborted() { return Abort; }
+
+ // Write
+ bool Write(std::string const &fileName);
-// Write
- void WriteEntries(FILE *_fp);
- bool Write(std::string const & fileName);
+ bool Anonymize();
- /// Types of the gdcmObject within the gdcmDicomDir
+ /// Types of the DicomDirObject within the DicomDir
typedef enum
{
GDCM_DICOMDIR_NONE,
GDCM_DICOMDIR_PATIENT,
GDCM_DICOMDIR_STUDY,
GDCM_DICOMDIR_SERIE,
- GDCM_DICOMDIR_IMAGE,
- } gdcmDicomDirType;
+ GDCM_DICOMDIR_VISIT,
+ GDCM_DICOMDIR_IMAGE
+ } DicomDirType;
protected:
- void CreateDicomDirChainedList(std::string const & path);
+ DicomDir();
+ ~DicomDir();
+
+ void CreateDicomDirChainedList(std::string const &path);
void CallStartMethod();
void CallProgressMethod();
void CallEndMethod();
private:
void Initialize();
void CreateDicomDir();
- void AddDicomDirMeta();
- void AddDicomDirPatientToEnd(gdcmSQItem *s);
- void AddDicomDirStudyToEnd (gdcmSQItem *s);
- void AddDicomDirSerieToEnd (gdcmSQItem *s);
- void AddDicomDirImageToEnd (gdcmSQItem *s);
-
- void SetElements(std::string &path, VectDocument &list);
- void SetElement (std::string &path,gdcmDicomDirType type,
- gdcmDocument *header);
-
- void UpdateDirectoryRecordSequenceLength();
-
- static bool HeaderLessThan(gdcmDocument *header1,gdcmDocument *header2);
+ bool DoTheLoadingJob();
+ bool AddPatientToEnd(DicomDirPatient *dd);
+ bool AddStudyToEnd (DicomDirStudy *dd);
+ bool AddSerieToEnd (DicomDirSerie *dd);
+ bool AddVisitToEnd (DicomDirVisit *dd);
+ bool AddImageToEnd (DicomDirImage *dd);
+
+ void SetElements(std::string const &path, VectDocument const &list);
+ void SetElement (std::string const &path, DicomDirType type,
+ Document *header);
+ void MoveSQItem(DocEntrySet *dst, DocEntrySet *src);
+
+ static bool HeaderLessThan(Document *header1, Document *header2);
// Variables
- /// Pointer on *the* gdcmObject 'DicomDirMeta Elements'
- gdcmDicomDirMeta *metaElems;
-
- /// Chained list of DicomDirPatient (to be exploited recursively)
- ListDicomDirPatient patients;
-
-/// pointer to the initialisation method for any progress bar
- gdcmMethod *startMethod;
-/// pointer to the incrementation method for any progress bar
- gdcmMethod *progressMethod;
-/// pointer to the termination method for any progress bar
- gdcmMethod *endMethod;
-/// pointer to the ??? method for any progress bar
- gdcmMethod *startMethodArgDelete;
-/// pointer to the ??? method for any progress bar
- gdcmMethod *progressMethodArgDelete;
-/// pointer to the ??? method for any progress bar
- gdcmMethod *endMethodArgDelete;
-/// pointer to the ??? for any progress bar
- void *startArg;
-/// pointer to the ??? for any progress bar
- void *progressArg;
-/// pointer to the ??? for any progress bar
- void *endArg;
-/// value of the ??? for any progress bar
- float progress;
-/// value of the ??? for any progress bar
- bool abort;
+ /// Pointer on *the* DicomDirObject 'DicomDirMeta Elements'
+ DicomDirMeta *MetaElems;
+
+ /// Chained list of DicomDirPatient (to be exploited hierarchicaly)
+ ListDicomDirPatient Patients;
+ ListDicomDirPatient::iterator ItPatient;
+
+ /// pointer to the initialisation method for any progress bar
+ Method *StartMethod;
+ /// pointer to the incrementation method for any progress bar
+ Method *ProgressMethod;
+ /// pointer to the termination method for any progress bar
+ Method *EndMethod;
+ /// pointer to the ??? method for any progress bar
+ Method *StartMethodArgDelete;
+ /// pointer to the ??? method for any progress bar
+ Method* ProgressMethodArgDelete;
+ /// pointer to the ??? method for any progress bar
+ Method *EndMethodArgDelete;
+ /// pointer to the ??? for any progress bar
+ void *StartArg;
+ /// pointer to the ??? for any progress bar
+ void *ProgressArg;
+ /// pointer to the ??? for any progress bar
+ void *EndArg;
+ /// value of the ??? for any progress bar
+ float Progress;
+ /// value of the ??? for any progress bar
+ bool Abort;
+ bool ParseDir;
};
-
+} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif