X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDicomDir.h;h=d2d024872f9012dbde776e727fb91d2f2c8ed632;hb=c5618e6b8276e1b21bbea354fe8bcba3c78eb4bd;hp=ae675fb00ab6931b23f6955bc9a33c004f749435;hpb=a919b2ba053a046eb268658ba81ad1bb1ddcd686;p=gdcm.git

diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h
index ae675fb0..d2d02487 100644
--- a/src/gdcmDicomDir.h
+++ b/src/gdcmDicomDir.h
@@ -5,71 +5,113 @@
 
 #include "gdcmHeader.h"
 #include "gdcmCommon.h"
-#include "gdcmPatient.h"
-#include "gdcmMeta.h"
+#include "gdcmDicomDirPatient.h"
+#include "gdcmDicomDirMeta.h"
 #include "gdcmDicomDirElement.h"
 
 #include <list>
 #include <vector>
 
 //-----------------------------------------------------------------------------
-typedef std::list<gdcmPatient *>   ListPatient;
+typedef std::list<gdcmDicomDirPatient *>   ListDicomDirPatient;
 typedef std::vector<gdcmHeader *>  ListHeader;
 
-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
 {
 public:
-//   gdcmDicomDir(ListTag *l,         bool exception_on_error = false);
+//   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); 
+                   
    ~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
    virtual bool IsReadable(void);
-   inline gdcmMeta   *GetMeta()      {return metaElems;};
-   inline ListPatient &GetPatients() {return patients;};
+/**
+ * \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);
-
-   inline void SetStartMethod(gdcmMethod *method,void *arg=NULL)    {startMethod=method;startArg=arg;};
-   inline void SetProgressMethod(gdcmMethod *method,void *arg=NULL) {progressMethod=method;progressArg=arg;};
-   inline void SetEndMethod(gdcmMethod *method,void *arg=NULL)      {endMethod=method;endArg=arg;};
-
-   inline float GetProgress(void)                   {return(progress);};
-
-   inline void AbortProgress(void)                  {abort=true;};
-   inline bool IsAborted(void)                      {return(abort);};
+   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 *);
+/**
+ * \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_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 CreateDicomDirChainedList(std::string path);
 
    void CallStartMethod(void);
    void CallProgressMethod(void);
@@ -78,29 +120,51 @@ protected:
 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);
+                                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);
-
-   gdcmMeta *metaElems;
-   ListPatient patients;
-
+   
+// 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;
-   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;
 };