]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomDir.h
New features for DicomDir
[gdcm.git] / src / gdcmDicomDir.h
index 66bfe02f0c656e22537f3e9c3c2cd631fe111318..64b61a3a51eb3098d6f6f8ee4174f162f1307d99 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDir.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:26 $
-  Version:   $Revision: 1.43 $
+  Date:      $Date: 2005/07/08 10:13:38 $
+  Version:   $Revision: 1.62 $
   
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -39,69 +39,85 @@ 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
 {
 public:
-   typedef void(Method)(void*);
+   typedef void Method(void*);
 
    DicomDir( std::string const &filename, bool parseDir = false );
    DicomDir(); 
                    
    ~DicomDir();
 
-   /// \brief   canonical Printer 
-   void Print(std::ostream &os = std::cout);
-
-   /// Informations contained in the parser
+   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 \ref Filename
+   virtual void SetFileName(std::string const &fileName) 
+                   { ParseDir = false; if (Filename != fileName)
+                               Filename = fileName, IsDocumentModified = true; }
+
+   /// DEPRECATED : use SetDirectoryName
+   void SetParseDir(bool parseDir)  { ParseDir = parseDir; };
+   
+   // 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();
+
+   DicomDirPatient *GetFirstPatient();
+   DicomDirPatient *GetNextPatient();
 
-   /// Parsing
+   // 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 unecessary notation at C++ level.
-   void SetStartMethod(    DicomDir::Method *m,
-                           void* = NULL,
-                           DicomDir::Method *m = NULL );
-   void SetProgressMethod( DicomDir::Method *m, 
-                           void* = NULL,
-                           DicomDir::Method *m = NULL );
-   void SetEndMethod(      DicomDir::Method *m,
-                           void* = NULL, 
-                           DicomDir::Method *m = NULL );
-   void SetStartMethodArgDelete( DicomDir::Method *m );
+   //       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 );
+   void SetEndMethodArgDelete     ( DicomDir::Method *m );
 
    /// GetProgress GetProgress
    float GetProgress()  { return Progress; };
-
    /// AbortProgress AbortProgress
    void  AbortProgress() { Abort = true; };
-
    /// IsAborted IsAborted
    bool  IsAborted() { return Abort; };
-   
-   /// Adding
-   DicomDirMeta    *NewMeta();
-   DicomDirPatient *NewPatient();
 
-   /// Write  
+   // Write
    bool WriteDicomDir(std::string const &fileName);
 
+   bool AnonymizeDicomDir();
+
    /// Types of the DicomDirObject within the DicomDir
    typedef enum
    {
@@ -122,50 +138,51 @@ protected:
 private:
    void Initialize();
    void CreateDicomDir();
-
-   bool AddDicomDirMeta();
-   bool AddDicomDirPatientToEnd(DicomDirPatient *dd);
-   bool AddDicomDirStudyToEnd  (DicomDirStudy *dd);
-   bool AddDicomDirSerieToEnd  (DicomDirSerie *dd);
-   bool AddDicomDirImageToEnd  (DicomDirImage *dd);
+   bool DoTheLoadingJob();
+   bool AddPatientToEnd(DicomDirPatient *dd);
+   bool AddStudyToEnd  (DicomDirStudy *dd);
+   bool AddSerieToEnd  (DicomDirSerie *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(SQItem *dst,SQItem *src);
+   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
 //-----------------------------------------------------------------------------