]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomDir.h
Doxygenation
[gdcm.git] / src / gdcmDicomDir.h
index 3604104e0ea059aef8a8858eac64db13b3ce8f01..4c432851aa0777a5f4f4224d3844dec44a9c6595 100644 (file)
-// gdcmDicomDir.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+  
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDicomDir.h,v $
+  Language:  C++
+  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
+  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
+     PURPOSE.  See the above copyright notices for more information.
+  
+=========================================================================*/
+
 #ifndef GDCMDICOMDIR_H
 #define GDCMDICOMDIR_H
 
-#include "gdcmHeader.h"
-#include "gdcmCommon.h"
-#include "gdcmPatient.h"
-#include "gdcmDicomDirElement.h"
+#include "gdcmDocument.h"
+#include "gdcmDebug.h"
 
 #include <list>
 #include <vector>
 
+namespace gdcm 
+{
 //-----------------------------------------------------------------------------
-typedef std::list<gdcmPatient *> ListPatient;
-typedef std::vector<gdcmHeader *>  ListHeader;
+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;
 
 //-----------------------------------------------------------------------------
-/*
- * \defgroup gdcmDicomDir
- * \brief    gdcmDicomDir 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 gdcmDicomDir: public gdcmParser
+class GDCM_EXPORT DicomDir: public Document
 {
+   gdcmTypeMacro(DicomDir);
+
 public:
-//   gdcmDicomDir(ListTag *l,          bool exception_on_error = false);
-   gdcmDicomDir(const char *FileName, bool parseDir = false,
-                bool exception_on_error = false);
+/// \brief Constructs a DicomDir with a RefCounter
+   static DicomDir *New() {return new DicomDir();}
+
+   typedef void Method(void*);
+
+   bool Load( );
+   void Print(std::ostream &os = std::cout, std::string const &indent = "" );
    
-   ~gdcmDicomDir(void);
+   /// 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 *GetMeta() { return MetaElems; }
 
-   void SetPrintLevel(int level) { printLevel = level; };
-   virtual void Print(std::ostream &os = std::cout);
+   // Patients
+   DicomDirPatient *NewPatient();
+   void ClearPatient();
 
-   inline ListPatient &GetPatients() {return patients;};
+   DicomDirPatient *GetFirstPatient();
+   DicomDirPatient *GetNextPatient();
 
-// Write
-   bool Write(std::string fileName);
-   void ParseDirectory(void);
+   // Parsing
+   void ParseDirectory();
 
-// Types
+   // 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; }
+   /// IsAborted IsAborted
+   bool  IsAborted() { return Abort; }
+
+   // Write
+   bool Write(std::string const &fileName);
+
+   bool Anonymize();
+
+   /// Types of the DicomDirObject within the DicomDir
    typedef enum
    {
-      GDCM_NONE,
-      GDCM_PATIENT,
-      GDCM_STUDY,
-      GDCM_SERIE,
-      GDCM_IMAGE,
-   } gdcmDicomDirType;
+      GDCM_DICOMDIR_NONE,
+      GDCM_DICOMDIR_META,
+      GDCM_DICOMDIR_PATIENT,
+      GDCM_DICOMDIR_STUDY,
+      GDCM_DICOMDIR_SERIE,
+      GDCM_DICOMDIR_VISIT,
+      GDCM_DICOMDIR_IMAGE
+   } DicomDirType;
    
 protected:
-   void NewDicomDir(std::string path);
-   std::string GetPath(void);
+   DicomDir(); 
+   ~DicomDir();
+
+   void CreateDicomDirChainedList(std::string const &path);
+   void CallStartMethod();
+   void CallProgressMethod();
+   void CallEndMethod();
 
 private:
-   void CreateDicomDir(void);
-   void AddObjectToEnd(gdcmDicomDirType type,ListTag::iterator begin,ListTag::iterator end);
-   void AddPatientToEnd(ListTag::iterator begin,ListTag::iterator end);
-   void AddStudyToEnd(ListTag::iterator begin,ListTag::iterator end);
-   void AddSerieToEnd(ListTag::iterator begin,ListTag::iterator end);
-   void AddImageToEnd(ListTag::iterator begin,ListTag::iterator end);
+   void Initialize();
+   void CreateDicomDir();
+   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 &path,ListHeader &list);
-   void SetElement(std::string &path,gdcmDicomDirType type,gdcmHeader *header);
+   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(gdcmHeader *header1,gdcmHeader *header2);
+   static bool HeaderLessThan(Document *header1, Document *header2);
+   
+// Variables
 
-   ListPatient patients;
-};
+   /// Pointer on *the* DicomDirObject 'DicomDirMeta Elements'
+   DicomDirMeta *MetaElems;
 
+   /// 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
 //-----------------------------------------------------------------------------
 #endif