Program: gdcm
Module: $RCSfile: gdcmDicomDir.h,v $
Language: C++
- Date: $Date: 2004/11/09 13:10:44 $
- Version: $Revision: 1.38 $
+ Date: $Date: 2005/07/08 10:13:38 $
+ Version: $Revision: 1.62 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#ifndef GDCMDICOMDIR_H
#define GDCMDICOMDIR_H
-#include "gdcmCommon.h"
#include "gdcmDocument.h"
-#include "gdcmDicomDirPatient.h"
-#include "gdcmDicomDirMeta.h"
-#include "gdcmDicomDirElement.h"
#include <list>
#include <vector>
namespace gdcm
{
//-----------------------------------------------------------------------------
-typedef std::list<DicomDirPatient*> ListDicomDirPatient;
-typedef std::vector<Document*> VectDocument;
+class DicomDirPatient;
+class DicomDirMeta;
+class DicomDirElement;
+class DicomDirStudy;
+class DicomDirSerie;
+class DicomDirImage;
+class SQItem;
-//-----------------------------------------------------------------------------
+typedef std::list<DicomDirPatient *> ListDicomDirPatient;
+typedef std::vector<Document *> VectDocument;
+//-----------------------------------------------------------------------------
/**
- * \ingroup DicomDir
- * \brief DicomDir 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 DicomDir: public Document
{
public:
- typedef void(Method)(void*);
+ typedef void Method(void*);
- DicomDir( std::string const & filename, bool parseDir = false );
+ DicomDir( std::string const &filename, bool parseDir = false );
DicomDir();
~DicomDir();
- /// \brief canonical Printer
- /// \sa SetPrintLevel
- void Print(std::ostream &os = std::cout);
-
- /// Informations contained in the parser
+ bool Load( std::string const &filename );
+ 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; }
+
+ /// DEPRECATED : use SetDirectoryName
+ void SetParseDir(bool parseDir) { ParseDir = parseDir; };
+
+ // Informations contained in the parser
virtual bool IsReadable();
+ // Meta
+ DicomDirMeta *NewMeta();
/// Returns a pointer to the DicomDirMeta for this DICOMDIR.
- DicomDirMeta* GetDicomDirMeta() { return MetaElems; };
+ DicomDirMeta *GetMeta() { return MetaElems; };
+
+ // Patients
+ DicomDirPatient *NewPatient();
+ void ClearPatient();
- /// Returns the PATIENT chained List for this DICOMDIR.
- ListDicomDirPatient const & GetDicomDirPatients() const { return Patients; };
+ DicomDirPatient *GetFirstPatient();
+ DicomDirPatient *GetNextPatient();
- /// Parsing
+ // Parsing
void ParseDirectory();
-
- void SetStartMethod( DicomDir::Method*,
- void* = NULL,
- DicomDir::Method* = NULL );
- void SetProgressMethod( DicomDir::Method*,
- void* = NULL,
- DicomDir::Method* = NULL );
- void SetEndMethod( DicomDir::Method*,
- void* = NULL,
- DicomDir::Method* = NULL );
- void SetStartMethodArgDelete( DicomDir::Method* );
- void SetProgressMethodArgDelete( DicomDir::Method* );
- void SetEndMethodArgDelete( DicomDir::Method* );
+
+ // 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,
+ DicomDir::Method *argDelete = NULL );
+ void SetProgressMethod( DicomDir::Method *method,
+ void *arg = NULL,
+ DicomDir::Method *argDelete = NULL );
+ void SetEndMethod( DicomDir::Method *method,
+ void *arg = NULL,
+ DicomDir::Method *argDelete = NULL );
+ void SetStartMethodArgDelete ( DicomDir::Method *m );
+ void SetProgressMethodArgDelete( DicomDir::Method *m );
+ void SetEndMethodArgDelete ( DicomDir::Method *m );
/// GetProgress GetProgress
float GetProgress() { return Progress; };
-
/// AbortProgress AbortProgress
void AbortProgress() { Abort = true; };
-
/// IsAborted IsAborted
bool IsAborted() { return Abort; };
-
- /// Adding
- DicomDirMeta* NewMeta();
- DicomDirPatient* NewPatient();
- /// Write
- bool WriteDicomDir(std::string const & fileName);
+ // Write
+ bool WriteDicomDir(std::string const &fileName);
+
+ bool AnonymizeDicomDir();
/// Types of the DicomDirObject within the DicomDir
typedef enum
} DicomDirType;
protected:
- void CreateDicomDirChainedList(std::string const & path);
+ void CreateDicomDirChainedList(std::string const &path);
void CallStartMethod();
void CallProgressMethod();
void CallEndMethod();
private:
void Initialize();
void CreateDicomDir();
- void AddDicomDirMeta();
- void AddDicomDirPatientToEnd(SQItem* s);
- void AddDicomDirStudyToEnd (SQItem* s);
- void AddDicomDirSerieToEnd (SQItem* s);
- void AddDicomDirImageToEnd (SQItem* s);
-
- void SetElements(std::string const & path, VectDocument const &list);
- void SetElement (std::string const & path, DicomDirType type,
- Document* header);
-
- static bool HeaderLessThan(Document* header1, Document* header2);
+ bool DoTheLoadingJob();
+ bool AddPatientToEnd(DicomDirPatient *dd);
+ bool AddStudyToEnd (DicomDirStudy *dd);
+ bool AddSerieToEnd (DicomDirSerie *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* DicomDirObject 'DicomDirMeta Elements'
- DicomDirMeta* MetaElems;
+ DicomDirMeta *MetaElems;
- /// Chained list of DicomDirPatient (to be exploited recursively)
+ /// Chained list of DicomDirPatient (to be exploited hierarchicaly)
ListDicomDirPatient Patients;
+ ListDicomDirPatient::iterator ItPatient;
/// pointer to the initialisation method for any progress bar
- Method* StartMethod;
+ Method *StartMethod;
/// pointer to the incrementation method for any progress bar
- Method* ProgressMethod;
+ Method *ProgressMethod;
/// pointer to the termination method for any progress bar
- Method* EndMethod;
+ Method *EndMethod;
/// pointer to the ??? method for any progress bar
- Method* StartMethodArgDelete;
+ Method *StartMethodArgDelete;
/// pointer to the ??? method for any progress bar
Method* ProgressMethodArgDelete;
/// pointer to the ??? method for any progress bar
- Method* EndMethodArgDelete;
+ Method *EndMethodArgDelete;
/// pointer to the ??? for any progress bar
- void* StartArg;
+ void *StartArg;
/// pointer to the ??? for any progress bar
- void* ProgressArg;
+ void *ProgressArg;
/// pointer to the ??? for any progress bar
- void* EndArg;
+ 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
//-----------------------------------------------------------------------------