X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDicomDir.h;h=07b099eabb2f2c1b3e05e36a7e5e36f54891b6a5;hb=6578460d701eb48ccdac0a8ca316360fc6dd3944;hp=98ee8ac4fbc18ab93071a8514c5ea57c7e3ab0d2;hpb=61e1a3e0ce5480990a0d0b844cf0e86d1775306d;p=gdcm.git diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h index 98ee8ac4..07b099ea 100644 --- a/src/gdcmDicomDir.h +++ b/src/gdcmDicomDir.h @@ -3,12 +3,12 @@ Program: gdcm Module: $RCSfile: gdcmDicomDir.h,v $ Language: C++ - Date: $Date: 2004/06/19 23:51:03 $ - Version: $Revision: 1.22 $ + Date: $Date: 2005/01/11 15:15:38 $ + Version: $Revision: 1.45 $ 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 @@ -19,95 +19,92 @@ #ifndef GDCMDICOMDIR_H #define GDCMDICOMDIR_H -#include "gdcmCommon.h" #include "gdcmDocument.h" -#include "gdcmDicomDirPatient.h" -#include "gdcmDicomDirMeta.h" -#include "gdcmDicomDirElement.h" #include #include +namespace gdcm +{ //----------------------------------------------------------------------------- -typedef std::list ListDicomDirPatient; -typedef std::vector VectDocument; +class DicomDirPatient; +class DicomDirMeta; +class DicomDirElement; +class DicomDirStudy; +class DicomDirSerie; +class DicomDirImage; +class SQItem; + +typedef std::list ListDicomDirPatient; +typedef std::vector VectDocument; -typedef GDCM_EXPORT void(gdcmMethod)(void * = NULL); //----------------------------------------------------------------------------- /** - * \ingroup gdcmDicomDir - * \brief gdcmDicomDir defines an object representing a DICOMDIR in memory. + * \ingroup DicomDir + * \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 { public: -// gdcmDicomDir(ListTag *l, -// bool exception_on_error = false); - gdcmDicomDir(const char *FileName, - bool parseDir = false, - bool exception_on_error = false); - gdcmDicomDir(bool exception_on_error = false); + typedef void(Method)(void*); + + DicomDir( std::string const &filename, bool parseDir = false ); + DicomDir(); - ~gdcmDicomDir(void); - - /** - * \ingroup gdcmDicomDir - * \brief Sets the print level for the Dicom Header - * \note 0 for Light Print; 1 for 'medium' Print, 2 for Heavy - */ - void SetPrintLevel(int level) - { printLevel = level; }; - /** - * \ingroup gdcmDicomDir - * \brief canonical Printer - * \sa SetPrintLevel - */ - virtual void Print(std::ostream &os = std::cout); - -// Informations contained in the parser - virtual bool IsReadable(void); - -/// \brief returns a pointer to the gdcmDicomDirMeta for this DICOMDIR. - inline gdcmDicomDirMeta *GetDicomDirMeta() - {return metaElems;}; - - /// \brief returns the PATIENT chained List for this DICOMDIR. - inline ListDicomDirPatient &GetDicomDirPatients() - {return patients;}; - -// Parsing - void ParseDirectory(void); + ~DicomDir(); + + /// \brief canonical Printer + void Print(std::ostream &os = std::cout); + + /// Informations contained in the parser + virtual bool IsReadable(); + + /// Returns a pointer to the DicomDirMeta for this DICOMDIR. + DicomDirMeta* GetDicomDirMeta() { return MetaElems; }; + + /// Returns the PATIENT chained List for this DICOMDIR. + ListDicomDirPatient const & GetDicomDirPatients() const { return Patients; }; + + /// 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 *); - -/// \brief GetProgress GetProgress - inline float GetProgress(void) - {return(progress);}; - -/// \brief AbortProgress AbortProgress - inline void AbortProgress(void) - {abort=true; }; - -/// \brief IsAborted IsAborted - inline bool IsAborted(void) - {return(abort); }; + // Note: the DicomDir:: namespace prefix is needed by Swig in the + // following method declarations. Refer to gdcmPython/gdcm.i + // for the reasons of this unecessary 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 - gdcmDicomDirMeta * NewMeta(void); - gdcmDicomDirPatient * NewPatient(void); + /// Adding + DicomDirMeta *NewMeta(); + DicomDirPatient *NewPatient(); -// Write - void WriteEntries(FILE *_fp); - bool Write(std::string fileName); + /// Write + bool WriteDicomDir(std::string const &fileName); -/// Types of the gdcmObject within the gdcmDicomDir + /// Types of the DicomDirObject within the DicomDir typedef enum { GDCM_DICOMDIR_NONE, @@ -115,65 +112,63 @@ public: GDCM_DICOMDIR_PATIENT, GDCM_DICOMDIR_STUDY, GDCM_DICOMDIR_SERIE, - GDCM_DICOMDIR_IMAGE, - } gdcmDicomDirType; + GDCM_DICOMDIR_IMAGE + } DicomDirType; protected: - void CreateDicomDirChainedList(std::string path); - - void CallStartMethod(void); - void CallProgressMethod(void); - void CallEndMethod(void); + void CreateDicomDirChainedList(std::string const &path); + void CallStartMethod(); + void CallProgressMethod(); + void CallEndMethod(); private: - void Initialize(void); - void CreateDicomDir(void); -// void AddObjectToEnd(gdcmDicomDirType type, gdcmSQItem *s); - 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(void); + void Initialize(); + void CreateDicomDir(); - static bool HeaderLessThan(gdcmDocument *header1,gdcmDocument *header2); + bool AddDicomDirMeta(); + bool AddDicomDirPatientToEnd(DicomDirPatient *dd); + bool AddDicomDirStudyToEnd (DicomDirStudy *dd); + bool AddDicomDirSerieToEnd (DicomDirSerie *dd); + bool AddDicomDirImageToEnd (DicomDirImage *dd); + + void SetElements(std::string const &path, VectDocument const &list); + void SetElement (std::string const &path, DicomDirType type, + Document *header); + void MoveSQItem(SQItem *dst,SQItem *src); + + static bool HeaderLessThan(Document *header1, Document *header2); // Variables -/// \brief pointer on *the* gdcmObject 'DicomDirMeta Elements' - gdcmDicomDirMeta *metaElems; - -/// \brief 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 tremination 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 recursively) + ListDicomDirPatient Patients; + + /// 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; }; - +} // end namespace gdcm //----------------------------------------------------------------------------- #endif