X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDicomDir.h;h=df5d9f64abaa2e5473041a9587751712c92f83c7;hb=5bf4ff55cc9887da061970902eb1effe24ede1b7;hp=5db25bd1eee6f4729c813b6f65d4788da5dfccc6;hpb=22f785a2627d1e7823701193bd7624739a3e033b;p=gdcm.git diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h index 5db25bd1..df5d9f64 100644 --- a/src/gdcmDicomDir.h +++ b/src/gdcmDicomDir.h @@ -1,10 +1,26 @@ -// gdcmDicomDir.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDicomDir.h,v $ + Language: C++ + Date: $Date: 2004/09/27 08:39:06 $ + Version: $Revision: 1.32 $ + + 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 "gdcmDocument.h" #include "gdcmDicomDirPatient.h" #include "gdcmDicomDirMeta.h" #include "gdcmDicomDirElement.h" @@ -13,54 +29,65 @@ #include //----------------------------------------------------------------------------- -typedef std::list ListDicomDirPatient; -typedef std::vector ListHeader; +typedef std::list ListDicomDirPatient; +typedef std::vector VectDocument; -typedef GDCM_EXPORT void(gdcmMethod)(void * = NULL); +typedef GDCM_EXPORT void(gdcmMethod)(void* = NULL); //----------------------------------------------------------------------------- -/* - * \defgroup gdcmDicomDir + +/** + * \ingroup gdcmDicomDir * \brief gdcmDicomDir defines an object representing a DICOMDIR in memory. * */ -class GDCM_EXPORT gdcmDicomDir: public gdcmParser +class GDCM_EXPORT gdcmDicomDir: public gdcmDocument { public: -// gdcmDicomDir(ListTag *l, -// bool exception_on_error = false); - gdcmDicomDir(const char *FileName, - bool parseDir = false, - bool exception_on_error = false); - - ~gdcmDicomDir(void); + gdcmDicomDir( std::string const & fileName, bool parseDir = false ); + gdcmDicomDir(); + + ~gdcmDicomDir(); - void SetPrintLevel(int level) { printLevel = level; }; + /// \brief canonical Printer + /// \sa SetPrintLevel virtual void Print(std::ostream &os = std::cout); // Informations contained in the parser - virtual bool IsReadable(void); - inline gdcmDicomDirMeta *GetDicomDirMeta() {return metaElems;}; - inline ListDicomDirPatient &GetDicomDirPatients() {return patients;}; + virtual bool IsReadable(); + + /// Returns a pointer to the gdcmDicomDirMeta for this DICOMDIR. + gdcmDicomDirMeta* GetDicomDirMeta() { return metaElems; }; + + /// Returns the PATIENT chained List for this DICOMDIR. + ListDicomDirPatient &GetDicomDirPatients() { return patients; }; // Parsing - void ParseDirectory(void); + 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*); - 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; }; - inline float GetProgress(void) {return(progress);}; + /// AbortProgress AbortProgress + void AbortProgress() { abort = true; }; - inline void AbortProgress(void) {abort=true;}; - inline bool IsAborted(void) {return(abort);}; + /// IsAborted IsAborted + bool IsAborted() { return abort; }; + +// Adding + gdcmDicomDirMeta* NewMeta(); + gdcmDicomDirPatient* NewPatient(); -// Write - bool Write(std::string fileName); +// Write + bool WriteDicomDir(std::string const & fileName); -// Types + /// Types of the gdcmDicomDirObject within the gdcmDicomDir typedef enum { GDCM_DICOMDIR_NONE, @@ -68,48 +95,59 @@ public: GDCM_DICOMDIR_PATIENT, GDCM_DICOMDIR_STUDY, GDCM_DICOMDIR_SERIE, - GDCM_DICOMDIR_IMAGE, + GDCM_DICOMDIR_IMAGE } gdcmDicomDirType; protected: - void NewDicomDir(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 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); + + static bool HeaderLessThan(gdcmDocument* header1,gdcmDocument* header2); - void UpdateDirectoryRecordSequenceLength(void); +// Variables - static bool HeaderLessThan(gdcmHeader *header1,gdcmHeader *header2); + /// Pointer on *the* gdcmDicomDirObject 'DicomDirMeta Elements' + gdcmDicomDirMeta* metaElems; - gdcmDicomDirMeta *metaElems; + /// 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; - +/// 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; };