The following methods

[gdcm.git] / src / gdcmDicomDir.h

diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h
index edbc7b4bd0756d6393b0f6a5f9649251e840741a..f3f9b073e4f48101e4d9ec85dbad3629a886543d 100644 (file)
--- a/src/gdcmDicomDir.h
+++ b/src/gdcmDicomDir.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDir.h,v $
   Language:  C++
-  Date:      $Date: 2004/10/25 04:47:43 $
-  Version:   $Revision: 1.35 $
+  Date:      $Date: 2005/01/20 11:09:23 $
+  Version:   $Revision: 1.49 $
   
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -19,11 +19,7 @@
 #ifndef GDCMDICOMDIR_H
 #define GDCMDICOMDIR_H
 
-#include "gdcmCommon.h"
 #include "gdcmDocument.h"
-#include "gdcmDicomDirPatient.h"
-#include "gdcmDicomDirMeta.h"
-#include "gdcmDicomDirElement.h"
 
 #include <list>
 #include <vector>
@@ -31,63 +27,81 @@
 namespace gdcm 
 {
 //-----------------------------------------------------------------------------
-typedef std::list<DicomDirPatient*>   ListDicomDirPatient;
-typedef std::vector<Document*>  VectDocument;
+class DicomDirPatient;
+class DicomDirMeta;
+class DicomDirElement;
+class DicomDirStudy;
+class DicomDirSerie;
+class DicomDirImage;
+class SQItem;
+
+typedef std::list<DicomDirPatient *>   ListDicomDirPatient;
+typedef std::vector<Document *>  VectDocument;
 
-typedef GDCM_EXPORT void(Method)(void* = NULL);
 //-----------------------------------------------------------------------------
 
 /**
  * \ingroup DicomDir
- * \brief    DicomDir defines an object representing a DICOMDIR in memory.
+ * \brief   DicomDir defines an object representing a DICOMDIR in memory
+ *  as a tree-like structure DicomDirPatient -> DicomDirStudy -> DicomDirSerie
+ * -> DicomDirImage
  *
  */
 class GDCM_EXPORT DicomDir: public Document
 {
 public:
-   DicomDir( std::string const & filename, bool parseDir = false );
+   typedef void(Method)(void*);
+
+   DicomDir( std::string const &filename, bool parseDir = false );
    DicomDir(); 
                    
    ~DicomDir();
 
    /// \brief   canonical Printer 
-   /// \sa    SetPrintLevel
-   void Print(std::ostream &os = std::cout);
+   void Print(std::ostream &os = std::cout, std::string const & indent = "" );
 
+   
    /// Informations contained in the parser
    virtual bool IsReadable();
 
-   /// Returns a pointer to the DicomDirMeta for this DICOMDIR. 
-   DicomDirMeta* GetDicomDirMeta() { return MetaElems; };
-
-   /// Returns the PATIENT chained List for this DICOMDIR.    
-   ListDicomDirPatient const & GetDicomDirPatients() const { return Patients; };
-
    /// Parsing
    void ParseDirectory();
    
-   void SetStartMethod(Method*, void* = NULL, Method* = NULL);
-   void SetStartMethodArgDelete(Method*);
-   void SetProgressMethod(Method* ,void* = NULL, Method* = NULL);
-   void SetProgressMethodArgDelete(Method*);
-   void SetEndMethod(Method*, void* = NULL,Method* = NULL);
-   void SetEndMethodArgDelete(Method*);
-
+   // Note: the DicomDir:: namespace prefix is needed by Swig in the 
+   //       following method declarations. Refer to gdcmPython/gdcm.i
+   //       for the reasons of this unecessary notation at C++ level.
+   void SetStartMethod(    DicomDir::Method *method,
+                           void *arg = NULL,
+                           DicomDir::Method *argDelete = NULL );
+   void SetProgressMethod( DicomDir::Method *method, 
+                           void *arg = NULL,
+                           DicomDir::Method *argDelete = NULL );
+   void SetEndMethod(      DicomDir::Method *method,
+                           void *arg = NULL, 
+                           DicomDir::Method *argDelete = NULL );
+   void SetStartMethodArgDelete( DicomDir::Method *m );
+   void SetProgressMethodArgDelete( DicomDir::Method *m );
+   void SetEndMethodArgDelete( DicomDir::Method *m );
    /// GetProgress GetProgress
    float GetProgress()  { return Progress; };
-
    /// AbortProgress AbortProgress
    void  AbortProgress() { Abort = true; };
-
    /// IsAborted IsAborted
    bool  IsAborted() { return Abort; };
-   
+
+   /// Returns a pointer to the DicomDirMeta for this DICOMDIR. 
+   DicomDirMeta* GetMeta() { return MetaElems; };
+
+   // should avoid exposing internal mechanism
+   DicomDirPatient *GetFirstPatient();
+   DicomDirPatient *GetNextPatient();
+
    /// Adding
-   DicomDirMeta*    NewMeta();
-   DicomDirPatient* NewPatient();
+   DicomDirMeta    *NewMeta();
+   DicomDirPatient *NewPatient();
 
    /// Write  
-   bool WriteDicomDir(std::string const & fileName);
+   bool WriteDicomDir(std::string const &fileName);
 
    /// Types of the DicomDirObject within the DicomDir
    typedef enum
@@ -101,7 +115,7 @@ public:
    } DicomDirType;
    
 protected:
-   void CreateDicomDirChainedList(std::string const & path);
+   void CreateDicomDirChainedList(std::string const &path);
    void CallStartMethod();
    void CallProgressMethod();
    void CallEndMethod();
@@ -109,17 +123,18 @@ protected:
 private:
    void Initialize();
    void CreateDicomDir();
-   void AddDicomDirMeta();
-   void AddDicomDirPatientToEnd(SQItem* s);
-   void AddDicomDirStudyToEnd  (SQItem* s);
-   void AddDicomDirSerieToEnd  (SQItem* s);
-   void AddDicomDirImageToEnd  (SQItem* s);
 
-   void SetElements(std::string const & path, VectDocument const &list);
-   void SetElement (std::string const & path, DicomDirType type,
-                    Document* header);
+   bool AddPatientToEnd(DicomDirPatient *dd);
+   bool AddStudyToEnd  (DicomDirStudy *dd);
+   bool AddSerieToEnd  (DicomDirSerie *dd);
+   bool AddImageToEnd  (DicomDirImage *dd);
+
+   void SetElements(std::string const &path, VectDocument const &list);
+   void SetElement (std::string const &path, DicomDirType type,
+                    Document *header);
+   void MoveSQItem(SQItem *dst,SQItem *src);
 
-   static bool HeaderLessThan(Document* header1, Document* header2);
+   static bool HeaderLessThan(Document *header1, Document *header2);
    
 // Variables
 
@@ -128,6 +143,7 @@ private:
 
    /// Chained list of DicomDirPatient (to be exploited recursively) 
    ListDicomDirPatient Patients;
+   ListDicomDirPatient::iterator ItPatient;
 
    /// pointer to the initialisation method for any progress bar   
    Method* StartMethod;