X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDicomDir.h;h=f3f9b073e4f48101e4d9ec85dbad3629a886543d;hb=033352f8a0d333fc12b7fa625d1819a574f4ddef;hp=cd700d34ed680137727a18b80c0f102ca2dab45a;hpb=55d77e0913ff360d639af1841c70d14dc8687584;p=gdcm.git diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h index cd700d34..f3f9b073 100644 --- a/src/gdcmDicomDir.h +++ b/src/gdcmDicomDir.h @@ -1,79 +1,109 @@ -// gdcmDicomDir.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDicomDir.h,v $ + Language: C++ + Date: $Date: 2005/01/20 11:09:23 $ + Version: $Revision: 1.49 $ + + 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.html for details. + + This software is distributed WITHOUT ANY WARRANTY; without even + the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE. See the above copyright notices for more information. + +=========================================================================*/ + #ifndef GDCMDICOMDIR_H #define GDCMDICOMDIR_H -#include "gdcmHeader.h" -#include "gdcmCommon.h" -#include "gdcmDicomDirPatient.h" -#include "gdcmDicomDirMeta.h" -#include "gdcmDicomDirElement.h" +#include "gdcmDocument.h" #include #include +namespace gdcm +{ //----------------------------------------------------------------------------- -typedef std::list ListDicomDirPatient; -typedef std::vector ListHeader; +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); //----------------------------------------------------------------------------- -/* - * \defgroup 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 gdcmParser +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); + ~DicomDir(); - void SetPrintLevel(int level) { printLevel = level; }; - virtual void Print(std::ostream &os = std::cout); + /// \brief canonical Printer + void Print(std::ostream &os = std::cout, std::string const & indent = "" ); -// Informations contained in the parser - virtual bool IsReadable(void); -/** - * \ingroup gdcmDicomDir - * \brief returns a pointer to the gdcmDicomDirMeta for this DICOMDIR. - */ - inline gdcmDicomDirMeta *GetDicomDirMeta() - {return metaElems;}; -/** - * \ingroup gdcmDicomDir - * \brief returns the PATIENT chained List for this DICOMDIR. - */ - inline ListDicomDirPatient &GetDicomDirPatients() - {return patients;}; - -// Parsing - void ParseDirectory(void); - - 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 *); - - inline float GetProgress(void) {return(progress);}; - inline void AbortProgress(void){abort=true; }; - inline bool IsAborted(void) {return(abort); }; -// Adding - gdcmDicomDirPatient * NewPatient(void); - -// Write - bool Write(std::string fileName); + /// Informations contained in the parser + virtual bool IsReadable(); -// Types + /// Parsing + void ParseDirectory(); + + // 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; }; + + /// Returns a pointer to the DicomDirMeta for this DICOMDIR. + DicomDirMeta* GetMeta() { return MetaElems; }; + + // should avoid exposing internal mechanism + DicomDirPatient *GetFirstPatient(); + DicomDirPatient *GetNextPatient(); + + /// Adding + DicomDirMeta *NewMeta(); + DicomDirPatient *NewPatient(); + + /// Write + bool WriteDicomDir(std::string const &fileName); + + /// Types of the DicomDirObject within the DicomDir typedef enum { GDCM_DICOMDIR_NONE, @@ -81,58 +111,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); - std::string GetPath(void); - - void CallStartMethod(void); - void CallProgressMethod(void); - void CallEndMethod(void); + void CreateDicomDirChainedList(std::string const &path); + void CallStartMethod(); + void CallProgressMethod(); + void CallEndMethod(); private: - void CreateDicomDir(void); - void AddObjectToEnd(gdcmDicomDirType type, - ListTag::iterator begin,ListTag::iterator end); - void AddDicomDirMetaToEnd (ListTag::iterator begin,ListTag::iterator end); - void AddDicomDirPatientToEnd(ListTag::iterator begin,ListTag::iterator end); - void AddDicomDirStudyToEnd (ListTag::iterator begin,ListTag::iterator end); - void AddDicomDirSerieToEnd (ListTag::iterator begin,ListTag::iterator end); - void AddDicomDirImageToEnd (ListTag::iterator begin,ListTag::iterator end); - - void SetElements(std::string &path,ListHeader &list); - void SetElement (std::string &path,gdcmDicomDirType type,gdcmHeader *header); - - void UpdateDirectoryRecordSequenceLength(void); + void Initialize(); + void CreateDicomDir(); + + 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(SQItem *dst,SQItem *src); - static bool HeaderLessThan(gdcmHeader *header1,gdcmHeader *header2); - void WriteDicomDirEntries(FILE *_fp); + 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; - - gdcmMethod *startMethod; - gdcmMethod *progressMethod; - gdcmMethod *endMethod; - gdcmMethod *startMethodArgDelete; - gdcmMethod *progressMethodArgDelete; - gdcmMethod *endMethodArgDelete; - void *startArg; - void *progressArg; - void *endArg; - - float progress; - bool abort; -}; + /// Pointer on *the* DicomDirObject 'DicomDirMeta Elements' + DicomDirMeta* MetaElems; + + /// Chained list of DicomDirPatient (to be exploited recursively) + 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; +}; +} // end namespace gdcm //----------------------------------------------------------------------------- #endif