]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomDir.h
Fix mistypings
[gdcm.git] / src / gdcmDicomDir.h
index 56f8a083f73bca693ec69c20664d4359fd857f27..eb2ac4d7a38a5ac17ea6744353145470c14d9c48 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDir.h,v $
   Language:  C++
-  Date:      $Date: 2004/11/02 03:10:32 $
-  Version:   $Revision: 1.36 $
+  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 "gdcmCommon.h"
 #include "gdcmDocument.h"
-#include "gdcmDicomDirPatient.h"
-#include "gdcmDicomDirMeta.h"
-#include "gdcmDicomDirElement.h"
+#include "gdcmDebug.h"
 
 #include <list>
 #include <vector>
 
-namespace gdcm 
+namespace GDCM_NAME_SPACE 
 {
 //-----------------------------------------------------------------------------
-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 DicomDirPrivate;
+class SQItem;
+
+typedef std::list<DicomDirPatient *> ListDicomDirPatient;
+typedef std::vector<Document *> VectDocument;
 
-typedef GDCM_EXPORT void(Method)(void*);
 //-----------------------------------------------------------------------------
-
 /**
- * \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 
+ *           -> DicomDirVisit 
+ *              -> DicomDirSerie
+ *                 -> DicomDirImage
+ *                 -> DicomDirPrivate (for Siemens CSA non image)
  */
 class GDCM_EXPORT DicomDir: public Document
 {
-public:
-   DicomDir( std::string const & filename, bool parseDir = false );
-   DicomDir(); 
-                   
-   ~DicomDir();
+   gdcmTypeMacro(DicomDir);
 
-   /// \brief   canonical Printer 
-   /// \sa    SetPrintLevel
-   void Print(std::ostream &os = std::cout);
-
-   /// Informations contained in the parser
+public:
+/// \brief Constructs a DicomDir with a RefCounter
+   static DicomDir *New() {return new DicomDir();}
+
+//   GDCM_LEGACY( bool Load(std::string const &filename) )
+   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 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; }
 
-   /// Returns the PATIENT chained List for this DICOMDIR.    
-   ListDicomDirPatient const & GetDicomDirPatients() const { return Patients; };
+   // Patients
+   DicomDirPatient *NewPatient();
+   void ClearPatient();
 
-   /// Parsing
-   void ParseDirectory();
+   DicomDirPatient *GetFirstPatient();
+   DicomDirPatient *GetNextPatient();
+   /// returns the number of Patients currently held in the gdcm::DicomDir
+   int              GetNumberOfPatients() { return Patients.size();}
    
-   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*);
+   // Parsing
+   void ParseDirectory();
 
    /// 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; };
-   
-   /// 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();
+
+   virtual void Copy(DocEntrySet *set);
 
    /// Types of the DicomDirObject within the DicomDir
    typedef enum
@@ -97,60 +116,48 @@ public:
       GDCM_DICOMDIR_PATIENT,
       GDCM_DICOMDIR_STUDY,
       GDCM_DICOMDIR_SERIE,
-      GDCM_DICOMDIR_IMAGE
+      GDCM_DICOMDIR_VISIT,
+      GDCM_DICOMDIR_IMAGE,
+      GDCM_DICOMDIR_PRIVATE
    } DicomDirType;
-   
+
 protected:
-   void CreateDicomDirChainedList(std::string const & path);
-   void CallStartMethod();
-   void CallProgressMethod();
-   void CallEndMethod();
+   DicomDir();
+   ~DicomDir();
+//   GDCM_LEGACY( DicomDir(std::string const &filename, bool parseDir = false) )
+
+   void CreateDicomDirChainedList(std::string const &path);
 
 private:
    void Initialize();
    void CreateDicomDir();
-   void AddDicomDirMeta();
-   void AddDicomDirPatientToEnd(SQItem* s);
-   void AddDicomDirStudyToEnd  (SQItem* s);
-   void AddDicomDirSerieToEnd  (SQItem* s);
-   void AddDicomDirImageToEnd  (SQItem* s);
+   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);
 
-   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);
 
-   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   
-   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
 //-----------------------------------------------------------------------------