-// gdcmDicomDir.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmDicomDir.h,v $
+ Language: C++
+ Date: $Date: 2005/01/06 20:03:26 $
+ Version: $Revision: 1.43 $
+
+ 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 <list>
#include <vector>
+namespace gdcm
+{
//-----------------------------------------------------------------------------
-typedef std::list<gdcmDicomDirPatient *> ListDicomDirPatient;
-typedef std::vector<gdcmHeader *> ListHeader;
+class DicomDirPatient;
+class DicomDirMeta;
+class DicomDirElement;
+class DicomDirStudy;
+class DicomDirSerie;
+class DicomDirImage;
+class SQItem;
+
+typedef std::list<DicomDirPatient *> ListDicomDirPatient;
+typedef std::vector<Document *> 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.
*
*/
-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 *m,
+ void* = NULL,
+ DicomDir::Method *m = NULL );
+ void SetProgressMethod( DicomDir::Method *m,
+ void* = NULL,
+ DicomDir::Method *m = NULL );
+ void SetEndMethod( DicomDir::Method *m,
+ void* = NULL,
+ DicomDir::Method *m = 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,
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, 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,ListHeader &list);
- void SetElement (std::string &path,gdcmDicomDirType type,gdcmHeader *header);
-
- void UpdateDirectoryRecordSequenceLength(void);
+ void Initialize();
+ void CreateDicomDir();
- static bool HeaderLessThan(gdcmHeader *header1,gdcmHeader *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