]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomDir.h
ENH: * Huge cleanup:
[gdcm.git] / src / gdcmDicomDir.h
index b58851d6104c3f9c86d28cd1075e93a68c63cd78..5aae1c919d2761d4da56707dab2a711650445c00 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDir.h,v $
   Language:  C++
-  Date:      $Date: 2004/09/24 11:39:21 $
-  Version:   $Revision: 1.31 $
+  Date:      $Date: 2004/12/03 20:16:57 $
+  Version:   $Revision: 1.41 $
   
   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.
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
   
      This software is distributed WITHOUT ANY WARRANTY; without even
      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 #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>
 
+namespace gdcm 
+{
 //-----------------------------------------------------------------------------
-typedef std::list<gdcmDicomDirPatient*>   ListDicomDirPatient;
-typedef std::vector<gdcmDocument*>  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(gdcmMethod)(void* = NULL);
 //-----------------------------------------------------------------------------
 
 /**
- * \ingroup gdcmDicomDir
- * \brief    gdcmDicomDir defines an object representing a DICOMDIR in memory.
+ * \ingroup DicomDir
+ * \brief    DicomDir defines an object representing a DICOMDIR in memory.
  *
  */
-class GDCM_EXPORT gdcmDicomDir: public gdcmDocument
+class GDCM_EXPORT DicomDir: public Document
 {
 public:
-   gdcmDicomDir( std::string const & fileName, bool parseDir = false );
-   gdcmDicomDir(); 
+   typedef void(Method)(void*);
+
+   DicomDir( std::string const & filename, bool parseDir = false );
+   DicomDir(); 
                    
-   ~gdcmDicomDir();
+   ~DicomDir();
 
    /// \brief   canonical Printer 
    /// \sa    SetPrintLevel
-   virtual void Print(std::ostream &os = std::cout);
+   void Print(std::ostream &os = std::cout);
 
-// Informations contained in the parser
+   /// Informations contained in the parser
    virtual bool IsReadable();
 
-   /// Returns a pointer to the gdcmDicomDirMeta for this DICOMDIR. 
-   gdcmDicomDirMeta* GetDicomDirMeta() { return metaElems; };
+   /// Returns a pointer to the DicomDirMeta for this DICOMDIR. 
+   DicomDirMeta* GetDicomDirMeta() { return MetaElems; };
 
    /// Returns the PATIENT chained List for this DICOMDIR.    
-   ListDicomDirPatient &GetDicomDirPatients() { return patients; };
+   ListDicomDirPatient const & GetDicomDirPatients() const { return Patients; };
 
-// Parsing
+   /// Parsing
    void ParseDirectory();
    
-   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*);
+   // 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*,
+                           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; };
+   float GetProgress()  { return Progress; };
 
    /// AbortProgress AbortProgress
-   void  AbortProgress() { abort = true; };
+   void  AbortProgress() { Abort = true; };
 
    /// IsAborted IsAborted
-   bool  IsAborted() { return abort; };
+   bool  IsAborted() { return Abort; };
    
-// Adding
-   gdcmDicomDirMeta*    NewMeta();
-   gdcmDicomDirPatient* NewPatient();
+   /// Adding
+   DicomDirMeta*    NewMeta();
+   DicomDirPatient* NewPatient();
 
-// Write  
+   /// Write  
    bool WriteDicomDir(std::string const & fileName);
 
-   /// Types of the gdcmDicomDirObject within the gdcmDicomDir
+   /// Types of the DicomDirObject within the DicomDir
    typedef enum
    {
       GDCM_DICOMDIR_NONE,
@@ -96,7 +112,7 @@ public:
       GDCM_DICOMDIR_STUDY,
       GDCM_DICOMDIR_SERIE,
       GDCM_DICOMDIR_IMAGE
-   } gdcmDicomDirType;
+   } DicomDirType;
    
 protected:
    void CreateDicomDirChainedList(std::string const & path);
@@ -107,49 +123,51 @@ protected:
 private:
    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);
+   bool AddDicomDirMeta();
+   bool AddDicomDirPatientToEnd(DicomDirPatient* dd);
+   bool AddDicomDirStudyToEnd  (DicomDirStudy* dd);
+   bool AddDicomDirSerieToEnd  (DicomDirSerie* dd);
+   bool AddDicomDirImageToEnd  (DicomDirImage* dd);
 
-   static bool HeaderLessThan(gdcmDocument* header1,gdcmDocument* header2);
+   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);
    
 // Variables
 
-   /// Pointer on *the* gdcmDicomDirObject 'DicomDirMeta Elements'
-   gdcmDicomDirMeta* metaElems;
+   /// Pointer on *the* DicomDirObject 'DicomDirMeta Elements'
+   DicomDirMeta* MetaElems;
 
    /// Chained list of DicomDirPatient (to be exploited recursively) 
-   ListDicomDirPatient patients;
-
-/// pointer to the initialisation method for any progress bar   
-   gdcmMethod* startMethod;
-/// 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;
+   ListDicomDirPatient Patients;
+
+   /// pointer to the initialisation method for any progress bar   
+   Method* StartMethod;
+   /// pointer to the incrementation method for any progress bar
+   Method* ProgressMethod;
+   /// pointer to the termination method for any progress bar
+   Method* EndMethod;
+   /// pointer to the ??? method for any progress bar   
+   Method* StartMethodArgDelete;
+   /// pointer to the ??? method for any progress bar
+   Method* ProgressMethodArgDelete;
+   /// pointer to the ??? method for any progress bar
+   Method* 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;
 };
-
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif