typedef GDCM_EXPORT void(gdcmMethod)(void * = NULL);
//-----------------------------------------------------------------------------
-/*
- * \defgroup gdcmDicomDir
+
+/**
+ * \ingroup gdcmDicomDir
* \brief gdcmDicomDir defines an object representing a DICOMDIR in memory.
*
*/
~gdcmDicomDir(void);
- void SetPrintLevel(int level) { printLevel = level; };
+ /**
+ * \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
+ */
virtual void Print(std::ostream &os = std::cout);
// Informations contained in the parser
// Parsing
void ParseDirectory(void);
-
+ void CheckBoundaries(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); };
+/**
+ * \ingroup gdcmDicomDir
+ * \brief GetProgress.
+ */
+ inline float GetProgress(void)
+ {return(progress);};
+/**
+ * \ingroup gdcmDicomDir
+ * \brief AbortProgress.
+ */ inline void AbortProgress(void)
+ {abort=true; };
+/**
+ * \ingroup gdcmDicomDir
+ * \brief IsAborted.
+ */ inline bool IsAborted(void)
+ {return(abort); };
// Adding
gdcmDicomDirPatient * NewPatient(void);
// Write
+ void WriteEntries(FILE *_fp);
bool Write(std::string fileName);
-// Types
+/// Types of the gdcmObject within the gdcmDicomDir
typedef enum
{
GDCM_DICOMDIR_NONE,
protected:
void CreateDicomDirChainedList(std::string path);
- std::string GetPath(void);
void CallStartMethod(void);
void CallProgressMethod(void);
void UpdateDirectoryRecordSequenceLength(void);
static bool HeaderLessThan(gdcmHeader *header1,gdcmHeader *header2);
- void WriteDicomDirEntries(FILE *_fp);
// Variables
/**
*/
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 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;
};