]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomDir.h
Doxygenation
[gdcm.git] / src / gdcmDicomDir.h
index 3ba3aa54e55b749a761fe1d4b1a4710236a322b6..4c432851aa0777a5f4f4224d3844dec44a9c6595 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDir.h,v $
   Language:  C++
-  Date:      $Date: 2004/11/09 10:25:27 $
-  Version:   $Revision: 1.37 $
+  Date:      $Date: 2005/11/21 09:46:25 $
+  Version:   $Revision: 1.70 $
   
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 #ifndef GDCMDICOMDIR_H
 #define GDCMDICOMDIR_H
 
-#include "gdcmCommon.h"
 #include "gdcmDocument.h"
-#include "gdcmDicomDirPatient.h"
-#include "gdcmDicomDirMeta.h"
-#include "gdcmDicomDirElement.h"
+#include "gdcmDebug.h"
 
 #include <list>
 #include <vector>
 namespace gdcm 
 {
 //-----------------------------------------------------------------------------
-typedef std::list<DicomDirPatient*>   ListDicomDirPatient;
-typedef std::vector<Document*>  VectDocument;
+class DicomDirPatient;
+class DicomDirMeta;
+class DicomDirElement;
+class DicomDirStudy;
+class DicomDirSerie;
+class DicomDirVisit;
+class DicomDirImage;
+class SQItem;
+
+typedef std::list<DicomDirPatient *> ListDicomDirPatient;
+typedef std::vector<Document *> VectDocument;
 
 //-----------------------------------------------------------------------------
-
 /**
- * \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
 {
+   gdcmTypeMacro(DicomDir);
+
 public:
-   typedef GDCM_EXPORT void(Method)(void*);
-   DicomDir( std::string const & filename, bool parseDir = false );
-   DicomDir(); 
-                   
-   ~DicomDir();
+/// \brief Constructs a DicomDir with a RefCounter
+   static DicomDir *New() {return new DicomDir();}
 
-   /// \brief   canonical Printer 
-   /// \sa    SetPrintLevel
-   void Print(std::ostream &os = std::cout);
+   typedef void Method(void*);
 
-   /// Informations contained in the parser
+   bool Load( );
+   void Print(std::ostream &os = std::cout, std::string const &indent = "" );
+   
+   /// Sets the root Directory name to parse, recursively
+   void SetDirectoryName(std::string const &dirName) 
+        { ParseDir = true; if (Filename != dirName)
+                               Filename = dirName, IsDocumentModified = true; }
+   /// Accessor to \ref Filename
+   virtual void SetFileName(std::string const &fileName) 
+                   { ParseDir = false; if (Filename != fileName)
+                              Filename = fileName, IsDocumentModified = true;}
+   
+   // Informations contained in the parser
    virtual bool IsReadable();
 
+   // Meta
+   DicomDirMeta *NewMeta();
    /// Returns a pointer to the DicomDirMeta for this DICOMDIR. 
-   DicomDirMeta* GetDicomDirMeta() { return MetaElems; };
+   DicomDirMeta *GetMeta() { return MetaElems; }
+
+   // Patients
+   DicomDirPatient *NewPatient();
+   void ClearPatient();
 
-   /// Returns the PATIENT chained List for this DICOMDIR.    
-   ListDicomDirPatient const & GetDicomDirPatients() const { return Patients; };
+   DicomDirPatient *GetFirstPatient();
+   DicomDirPatient *GetNextPatient();
 
-   /// Parsing
+   // Parsing
    void ParseDirectory();
-   
-   void SetStartMethod(    DicomDir::Method*,
-                           void* = NULL,
-                           DicomDir::Method* = NULL );
-   void SetProgressMethod( DicomDir::Method*, 
-                           void* = NULL,
-                           DicomDir::Method* = NULL );
-   void SetEndMethod(      DicomDir::Method*,
-                           void* = NULL, 
-                           DicomDir::Method* = NULL );
-   void SetStartMethodArgDelete( DicomDir::Method* );
-   void SetProgressMethodArgDelete( DicomDir::Method* );
-   void SetEndMethodArgDelete( DicomDir::Method* );
 
-   /// GetProgress GetProgress
-   float GetProgress()  { return Progress; };
+   // Note: the DicomDir:: namespace prefix is needed by Swig in the 
+   //       following method declarations. Refer to gdcmPython/gdcm.i
+   //       for the reasons of this unnecessary notation at C++ level.
+   void SetStartMethod(    DicomDir::Method *method,
+                           void *arg = NULL );
+   void SetProgressMethod( DicomDir::Method *method,
+                           void *arg = NULL );
+   void SetEndMethod(      DicomDir::Method *method,
+                           void *arg = NULL );
+   // Note: replace DicomDir::Method *method to void(*method)(void *) to
+   //       avoid wrapping problems with the typemap conversions
+   void SetStartMethod(    void(*method)(void *), // DicomDir::Method *method
+                           void *arg,
+                           void(*argDelete)(void *));
+   void SetProgressMethod( void(*method)(void *), // DicomDir::Method *method
+                           void *arg,
+                           void(*argDelete)(void *));
+   void SetEndMethod(      void(*method)(void *), // DicomDir::Method *method
+                           void *arg, 
+                           void(*argDelete)(void *));
+   void SetStartMethodArgDelete   ( DicomDir::Method *method );
+   void SetProgressMethodArgDelete( DicomDir::Method *method );
+   void SetEndMethodArgDelete     ( DicomDir::Method *method );
 
+   /// GetProgress GetProgress
+   float GetProgress()   { return Progress; }
    /// AbortProgress AbortProgress
-   void  AbortProgress() { Abort = true; };
-
+   void  AbortProgress() { Abort = true; }
    /// IsAborted IsAborted
-   bool  IsAborted() { return Abort; };
-   
-   /// Adding
-   DicomDirMeta*    NewMeta();
-   DicomDirPatient* NewPatient();
+   bool  IsAborted() { return Abort; }
 
-   /// Write  
-   bool WriteDicomDir(std::string const & fileName);
+   // Write
+   bool Write(std::string const &fileName);
+
+   bool Anonymize();
 
    /// Types of the DicomDirObject within the DicomDir
    typedef enum
@@ -103,11 +132,15 @@ public:
       GDCM_DICOMDIR_PATIENT,
       GDCM_DICOMDIR_STUDY,
       GDCM_DICOMDIR_SERIE,
+      GDCM_DICOMDIR_VISIT,
       GDCM_DICOMDIR_IMAGE
    } DicomDirType;
    
 protected:
-   void CreateDicomDirChainedList(std::string const & path);
+   DicomDir(); 
+   ~DicomDir();
+
+   void CreateDicomDirChainedList(std::string const &path);
    void CallStartMethod();
    void CallProgressMethod();
    void CallEndMethod();
@@ -115,48 +148,52 @@ 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);
-
-   static bool HeaderLessThan(Document* header1, Document* header2);
+   bool DoTheLoadingJob();
+   bool AddPatientToEnd(DicomDirPatient *dd);
+   bool AddStudyToEnd  (DicomDirStudy *dd);
+   bool AddSerieToEnd  (DicomDirSerie *dd);
+   bool AddVisitToEnd  (DicomDirVisit *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(DocEntrySet *dst, DocEntrySet *src);
+
+   static bool HeaderLessThan(Document *header1, Document *header2);
    
 // Variables
 
    /// Pointer on *the* DicomDirObject 'DicomDirMeta Elements'
-   DicomDirMetaMetaElems;
+   DicomDirMeta *MetaElems;
 
-   /// Chained list of DicomDirPatient (to be exploited recursively) 
+   /// Chained list of DicomDirPatient (to be exploited hierarchicaly) 
    ListDicomDirPatient Patients;
+   ListDicomDirPatient::iterator ItPatient;
 
    /// pointer to the initialisation method for any progress bar   
-   MethodStartMethod;
+   Method *StartMethod;
    /// pointer to the incrementation method for any progress bar
-   MethodProgressMethod;
+   Method *ProgressMethod;
    /// pointer to the termination method for any progress bar
-   MethodEndMethod;
+   Method *EndMethod;
    /// pointer to the ??? method for any progress bar   
-   MethodStartMethodArgDelete;
+   Method *StartMethodArgDelete;
    /// pointer to the ??? method for any progress bar
    Method* ProgressMethodArgDelete;
    /// pointer to the ??? method for any progress bar
-   MethodEndMethodArgDelete;
+   Method *EndMethodArgDelete;
    /// pointer to the ??? for any progress bar   
-   voidStartArg;
+   void *StartArg;
    /// pointer to the ??? for any progress bar
-   voidProgressArg;
+   void *ProgressArg;
    /// pointer to the ??? for any progress bar   
-   voidEndArg;
+   void *EndArg;
    /// value of the ??? for any progress bar
    float Progress;
    /// value of the ??? for any progress bar   
    bool Abort;
+   bool ParseDir;
 };
 } // end namespace gdcm
 //-----------------------------------------------------------------------------