X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDicomDir.h;h=c7605f6211a53edc74407af990e2dffd3ea10400;hb=dd2ef610b9d1f7be02fc7d620129f3ea8b4a5376;hp=7b2e724f6f388e4d117aa305ea772f9c6347228e;hpb=9b3db5f141ec2b11eadefaa2ea2a3a20058b37f9;p=gdcm.git diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h index 7b2e724f..c7605f62 100644 --- a/src/gdcmDicomDir.h +++ b/src/gdcmDicomDir.h @@ -1,91 +1,95 @@ -// gdcmDicomDir.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDicomDir.h,v $ + Language: C++ + Date: $Date: 2004/10/12 04:35:44 $ + Version: $Revision: 1.34 $ + + 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" #include #include +namespace gdcm +{ //----------------------------------------------------------------------------- -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(Method)(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. * */ -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); + DicomDir( std::string const & fileName, bool parseDir = false ); + DicomDir(); - ~gdcmDicomDir(void); - - /** - * \ingroup gdcmParser - * \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 gdcmParser - * \brief canonical Printer - * \sa SetPrintLevel - */ + ~DicomDir(); + + /// \brief canonical Printer + /// \sa SetPrintLevel virtual void Print(std::ostream &os = std::cout); -// 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 CheckBoundaries(void); + /// 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 &GetDicomDirPatients() { 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 *); - - inline float GetProgress(void) {return(progress);}; - inline void AbortProgress(void){abort=true; }; - inline bool IsAborted(void) {return(abort); }; + void SetStartMethod(Method*, void* = NULL, Method* = NULL); + void SetStartMethodArgDelete(Method*); + void SetProgressMethod(Method* ,void* = NULL, Method* = NULL); + void SetProgressMethodArgDelete(Method*); + void SetEndMethod(Method*, void* = NULL,Method* = NULL); + void SetEndMethodArgDelete(Method*); + + /// GetProgress GetProgress + float GetProgress() { return Progress; }; + + /// AbortProgress AbortProgress + void AbortProgress() { Abort = true; }; + + /// IsAborted IsAborted + bool IsAborted() { return Abort; }; -// Adding - gdcmDicomDirPatient * NewPatient(void); + /// Adding + DicomDirMeta* NewMeta(); + DicomDirPatient* NewPatient(); -// Write - bool Write(std::string fileName); + /// Write + bool WriteDicomDir(std::string const & fileName); -// Types + /// Types of the DicomDirObject within the DicomDir typedef enum { GDCM_DICOMDIR_NONE, @@ -93,57 +97,61 @@ 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 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); - - static bool HeaderLessThan(gdcmHeader *header1,gdcmHeader *header2); - void WriteDicomDirEntries(FILE *_fp); + 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 &path, VectDocument &list); + void SetElement (std::string &path,DicomDirType type, + Document* header); + + 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; + + /// 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