-// gdcmDicomDir.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmDicomDir.h,v $
+ Language: C++
+ Date: $Date: 2004/08/26 15:29:52 $
+ Version: $Revision: 1.27 $
+
+ 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.
+
+ 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 "gdcmPatient.h"
-#include "gdcmMeta.h"
+#include "gdcmDocument.h"
+#include "gdcmDicomDirPatient.h"
+#include "gdcmDicomDirMeta.h"
#include "gdcmDicomDirElement.h"
#include <list>
#include <vector>
//-----------------------------------------------------------------------------
-typedef std::list<gdcmPatient *> ListPatient;
-typedef std::vector<gdcmHeader *> ListHeader;
+typedef std::list<gdcmDicomDirPatient*> ListDicomDirPatient;
+typedef std::vector<gdcmDocument*> 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 gdcmMeta *GetMeta() {return metaElems;};
- inline ListPatient &GetPatients() {return patients;};
+ virtual bool IsReadable();
-// Parsing
- void ParseDirectory(void);
+ /// 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 SetStartMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL);
void SetStartMethodArgDelete(gdcmMethod *);
void SetProgressMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL);
void SetEndMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL);
void SetEndMethodArgDelete(gdcmMethod *);
- inline float GetProgress(void) {return(progress);};
+ /// GetProgress GetProgress
+ float GetProgress() { 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 Write(std::string const & fileName);
-// Types
+ /// Types of the gdcmObject within the gdcmDicomDir
typedef enum
{
- GDCM_NONE,
- GDCM_META,
- GDCM_PATIENT,
- GDCM_STUDY,
- GDCM_SERIE,
- GDCM_IMAGE,
+ GDCM_DICOMDIR_NONE,
+ GDCM_DICOMDIR_META,
+ GDCM_DICOMDIR_PATIENT,
+ GDCM_DICOMDIR_STUDY,
+ GDCM_DICOMDIR_SERIE,
+ 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 AddMetaToEnd (ListTag::iterator begin,ListTag::iterator end);
- void AddPatientToEnd(ListTag::iterator begin,ListTag::iterator end);
- void AddStudyToEnd (ListTag::iterator begin,ListTag::iterator end);
- void AddSerieToEnd (ListTag::iterator begin,ListTag::iterator end);
- void AddImageToEnd (ListTag::iterator begin,ListTag::iterator end);
+ 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);
+
+ void UpdateDirectoryRecordSequenceLength();
- void SetElements(std::string &path,ListHeader &list);
- void SetElement (std::string &path,gdcmDicomDirType type,gdcmHeader *header);
+ static bool HeaderLessThan(gdcmDocument *header1,gdcmDocument *header2);
+
+// Variables
- static bool HeaderLessThan(gdcmHeader *header1,gdcmHeader *header2);
+ /// Pointer on *the* gdcmObject 'DicomDirMeta Elements'
+ gdcmDicomDirMeta *metaElems;
- gdcmMeta *metaElems;
- ListPatient patients;
+ /// Chained list of DicomDirPatient (to be exploited recursively)
+ ListDicomDirPatient patients;
+/// pointer to the initialisation method for any progress bar
gdcmMethod *startMethod;
- gdcmMethod *progressMethod;
+/// 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;
};
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff