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

diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h
index 5db25bd1..99d86780 100644
--- a/src/gdcmDicomDir.h
+++ b/src/gdcmDicomDir.h
@@ -1,10 +1,26 @@
-// gdcmDicomDir.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+  
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDicomDir.h,v $
+  Language:  C++
+  Date:      $Date: 2004/07/19 03:34:11 $
+  Version:   $Revision: 1.25 $
+  
+  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 "gdcmDocument.h"
 #include "gdcmDicomDirPatient.h"
 #include "gdcmDicomDirMeta.h"
 #include "gdcmDicomDirElement.h"
@@ -13,38 +29,43 @@
 #include <vector>
 
 //-----------------------------------------------------------------------------
-typedef std::list<gdcmDicomDirPatient *>   ListDicomDirPatient;
-typedef std::vector<gdcmHeader *>  ListHeader;
+typedef std::list<gdcmDicomDirPatient*>   ListDicomDirPatient;
+typedef std::vector<gdcmDocument*>  VectDocument;
 
 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, 
+   gdcmDicomDir(std::string const & fileName, 
                 bool parseDir = false,
                 bool exception_on_error = false);
-   
-   ~gdcmDicomDir(void);
+   gdcmDicomDir(bool exception_on_error = false); 
+                   
+   ~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 gdcmDicomDirMeta   *GetDicomDirMeta()      {return metaElems;};
-   inline ListDicomDirPatient &GetDicomDirPatients() {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);
@@ -52,15 +73,24 @@ public:
    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);
+   void WriteEntries(FILE *_fp);   
+   bool Write(std::string const & fileName);
 
-// Types
+   /// Types of the gdcmObject within the gdcmDicomDir
    typedef enum
    {
       GDCM_DICOMDIR_NONE,
@@ -72,44 +102,57 @@ public:
    } 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 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 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);
+   void UpdateDirectoryRecordSequenceLength();
 
-   static bool HeaderLessThan(gdcmHeader *header1,gdcmHeader *header2);
+   static bool HeaderLessThan(gdcmDocument *header1,gdcmDocument *header2);
+   
+// Variables
 
+   /// Pointer on *the* gdcmObject 'DicomDirMeta Elements'
    gdcmDicomDirMeta *metaElems;
+
+   /// 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;
 };