]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomDir.h
Fix mistypings
[gdcm.git] / src / gdcmDicomDir.h
index 81ebbbbf2ec4eeb885662931f17294189e9b6163..eb2ac4d7a38a5ac17ea6744353145470c14d9c48 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDir.h,v $
   Language:  C++
-  Date:      $Date: 2005/04/14 14:26:19 $
-  Version:   $Revision: 1.59 $
+  Date:      $Date: 2007/09/17 12:16:02 $
+  Version:   $Revision: 1.82 $
   
   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
+#ifndef _GDCMDICOMDIR_H_
+#define _GDCMDICOMDIR_H_
 
 #include "gdcmDocument.h"
+#include "gdcmDebug.h"
 
 #include <list>
 #include <vector>
 
-namespace gdcm 
+namespace GDCM_NAME_SPACE 
 {
 //-----------------------------------------------------------------------------
 class DicomDirPatient;
@@ -32,41 +33,54 @@ class DicomDirMeta;
 class DicomDirElement;
 class DicomDirStudy;
 class DicomDirSerie;
+class DicomDirVisit;
 class DicomDirImage;
+class DicomDirPrivate;
 class SQItem;
 
-typedef std::list<DicomDirPatient *>   ListDicomDirPatient;
-typedef std::vector<Document *>  VectDocument;
+typedef std::list<DicomDirPatient *> ListDicomDirPatient;
+typedef std::vector<Document *> VectDocument;
 
 //-----------------------------------------------------------------------------
 /**
  * \brief   DicomDir defines an object representing a DICOMDIR in memory
- *  as a tree-like structure DicomDirPatient 
- *                            -> DicomDirStudy 
- *                                -> DicomDirSerie
- *                                    -> DicomDirImage
+ *  as a tree-like structure :
+ *
+ *        ->DicomDirPatient 
+ *           -> DicomDirStudy 
+ *           -> DicomDirVisit 
+ *              -> DicomDirSerie
+ *                 -> DicomDirImage
+ *                 -> DicomDirPrivate (for Siemens CSA non image)
  */
 class GDCM_EXPORT DicomDir: public Document
 {
-public:
-   typedef void Method(void*);
+   gdcmTypeMacro(DicomDir);
 
-   DicomDir( std::string const &filename, bool parseDir = false );
-   DicomDir(); 
-                   
-   ~DicomDir();
+public:
+/// \brief Constructs a DicomDir with a RefCounter
+   static DicomDir *New() {return new DicomDir();}
 
-   void Load( std::string const &filename );
+//   GDCM_LEGACY( bool Load(std::string const &filename) )
+   bool Load( );
    void Print(std::ostream &os = std::cout, std::string const &indent = "" );
 
-   void SetParseDir(bool parseDir)  { ParseDir = parseDir; };
+   /// 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 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 *GetMeta() { return MetaElems; };
+   DicomDirMeta *GetMeta() { return MetaElems; }
 
    // Patients
    DicomDirPatient *NewPatient();
@@ -74,37 +88,25 @@ public:
 
    DicomDirPatient *GetFirstPatient();
    DicomDirPatient *GetNextPatient();
-
+   /// returns the number of Patients currently held in the gdcm::DicomDir
+   int              GetNumberOfPatients() { return Patients.size();}
+   
    // Parsing
    void ParseDirectory();
 
-   // 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,
-                           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; };
+   float GetProgress() const { return Progress; }
    /// AbortProgress AbortProgress
-   void  AbortProgress() { Abort = true; };
+   void  AbortProgress() { Abort = true; }
    /// IsAborted IsAborted
-   bool  IsAborted() { return Abort; };
+   bool  IsAborted() { return Abort; }
 
    // Write
-   bool WriteDicomDir(std::string const &fileName);
+   bool Write(std::string const &fileName);
 
-   bool AnonymizeDicomDir();
+   bool Anonymize();
+
+   virtual void Copy(DocEntrySet *set);
 
    /// Types of the DicomDirObject within the DicomDir
    typedef enum
@@ -114,31 +116,36 @@ public:
       GDCM_DICOMDIR_PATIENT,
       GDCM_DICOMDIR_STUDY,
       GDCM_DICOMDIR_SERIE,
-      GDCM_DICOMDIR_IMAGE
+      GDCM_DICOMDIR_VISIT,
+      GDCM_DICOMDIR_IMAGE,
+      GDCM_DICOMDIR_PRIVATE
    } DicomDirType;
-   
+
 protected:
+   DicomDir();
+   ~DicomDir();
+//   GDCM_LEGACY( DicomDir(std::string const &filename, bool parseDir = false) )
+
    void CreateDicomDirChainedList(std::string const &path);
-   void CallStartMethod();
-   void CallProgressMethod();
-   void CallEndMethod();
 
 private:
    void Initialize();
    void CreateDicomDir();
-
-   bool AddPatientToEnd(DicomDirPatient *dd);
-   bool AddStudyToEnd  (DicomDirStudy *dd);
-   bool AddSerieToEnd  (DicomDirSerie *dd);
-   bool AddImageToEnd  (DicomDirImage *dd);
-
+   bool DoTheLoadingJob();
+   bool AddPatientToEnd(DicomDirPatient *dd);   
+   bool AddStudyToEnd  (DicomDirStudy   *dd);
+   bool AddSerieToEnd  (DicomDirSerie   *dd);
+   bool AddVisitToEnd  (DicomDirVisit   *dd);
+   bool AddImageToEnd  (DicomDirImage   *dd);
+   bool AddPrivateToEnd(DicomDirPrivate *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'
@@ -148,29 +155,9 @@ private:
    ListDicomDirPatient Patients;
    ListDicomDirPatient::iterator ItPatient;
 
-   /// 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;
    bool ParseDir;
+
 };
 } // end namespace gdcm
 //-----------------------------------------------------------------------------