X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDicomDir.h;h=d2d024872f9012dbde776e727fb91d2f2c8ed632;hb=cecf8a0bb86a9b3223a9d02d1106a564aa6ef7f9;hp=5db25bd1eee6f4729c813b6f65d4788da5dfccc6;hpb=22f785a2627d1e7823701193bd7624739a3e033b;p=gdcm.git

diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h
index 5db25bd1..d2d02487 100644
--- a/src/gdcmDicomDir.h
+++ b/src/gdcmDicomDir.h
@@ -18,8 +18,9 @@ typedef std::vector<gdcmHeader *>  ListHeader;
 
 typedef GDCM_EXPORT void(gdcmMethod)(void * = NULL);
 //-----------------------------------------------------------------------------
-/*
- * \defgroup gdcmDicomDir
+
+/**
+ * \ingroup gdcmDicomDir
  * \brief    gdcmDicomDir defines an object representing a DICOMDIR in memory.
  *
  */
@@ -31,36 +32,74 @@ public:
    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 gdcmDicomDirMeta   *GetDicomDirMeta()      {return metaElems;};
-   inline ListDicomDirPatient &GetDicomDirPatients() {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);
-
+   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,
@@ -72,8 +111,7 @@ public:
    } gdcmDicomDirType;
    
 protected:
-   void NewDicomDir(std::string path);
-   std::string GetPath(void);
+   void CreateDicomDirChainedList(std::string path);
 
    void CallStartMethod(void);
    void CallProgressMethod(void);
@@ -82,7 +120,7 @@ protected:
 private:
    void CreateDicomDir(void);
    void AddObjectToEnd(gdcmDicomDirType type,
-                        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);
@@ -95,21 +133,38 @@ private:
    void UpdateDirectoryRecordSequenceLength(void);
 
    static bool HeaderLessThan(gdcmHeader *header1,gdcmHeader *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;
-   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;
 };