]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomDir.h
Update comments for DicomDir stuff
[gdcm.git] / src / gdcmDicomDir.h
index eef34e48968b9d70ad7d93023ef4f39a742ca895..a7d6893daea6d031b6ad40d123d9c2756319c27a 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDir.h,v $
   Language:  C++
-  Date:      $Date: 2004/07/02 13:55:27 $
-  Version:   $Revision: 1.23 $
+  Date:      $Date: 2005/02/06 14:31:09 $
+  Version:   $Revision: 1.54 $
   
   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 GDCM_EXPORT void(gdcmMethod)(void * = NULL);
-//-----------------------------------------------------------------------------
+typedef std::list<DicomDirPatient *>   ListDicomDirPatient;
+typedef std::vector<Document *>  VectDocument;
 
+//-----------------------------------------------------------------------------
 /**
- * \ingroup 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 gdcmDocument
+class GDCM_EXPORT DicomDir: public Document
 {
 public:
-   gdcmDicomDir(const char *FileName, 
-                bool parseDir = false,
-                bool exception_on_error = false);
-   gdcmDicomDir(bool exception_on_error = false); 
-                   
-   ~gdcmDicomDir(void);
-
-   /// \brief Sets the print level for the Dicom Header 
-   /// \note    0 for Light Print; 1 for 'medium' Print, 2 for Heavy
-   void SetPrintLevel(int level) 
-      { printLevel = level; };
-
-   /// \brief   canonical Printer 
-   /// \sa    SetPrintLevel
-   virtual void Print(std::ostream &os = std::cout);
-
-// Informations contained in the parser
-   virtual bool IsReadable(void);
-
-   /// Returns a pointer to the gdcmDicomDirMeta for this DICOMDIR. 
-   gdcmDicomDirMeta* GetDicomDirMeta() { return metaElems; };
-
-   /// Returns the PATIENT chained List for this DICOMDIR.    
-   ListDicomDirPatient &GetDicomDirPatients() { return patients; };
+   typedef void(Method)(void*);
 
-// Parsing
-   void ParseDirectory(void);
-   
-   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 *);
+   DicomDir( std::string const &filename, bool parseDir = false );
+   DicomDir(); 
+                   
+   ~DicomDir();
+
+   void Print(std::ostream &os = std::cout, std::string const &indent = "" );
+
+   // Informations contained in the parser
+   virtual bool IsReadable();
+
+   // Meta
+   DicomDirMeta    *NewMeta();
+   /// Returns a pointer to the DicomDirMeta for this DICOMDIR. 
+   DicomDirMeta* GetMeta() { return MetaElems; };
+
+   // Patients
+   DicomDirPatient *NewPatient();
+   void ClearPatient();
+
+   DicomDirPatient *GetFirstPatient();
+   DicomDirPatient *GetNextPatient();
+
+   // 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 *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(void)  { return(progress); };
-
+   float GetProgress()  { return Progress; };
    /// AbortProgress AbortProgress
-   void  AbortProgress(void) {abort=true; };
-
+   void  AbortProgress() { Abort = true; };
    /// IsAborted IsAborted
-   bool  IsAborted(void) {return(abort); };
-   
-// Adding
-   gdcmDicomDirMeta*    NewMeta(void);
-   gdcmDicomDirPatient* NewPatient(void);
+   bool  IsAborted() { return Abort; };
 
-// Write
-   void WriteEntries(FILE *_fp);   
-   bool Write(std::string fileName);
+   // Write
+   bool WriteDicomDir(std::string const &fileName);
 
-   /// Types of the gdcmObject within the gdcmDicomDir
+   /// Types of the DicomDirObject within the DicomDir
    typedef enum
    {
       GDCM_DICOMDIR_NONE,
@@ -103,63 +110,63 @@ public:
       GDCM_DICOMDIR_PATIENT,
       GDCM_DICOMDIR_STUDY,
       GDCM_DICOMDIR_SERIE,
-      GDCM_DICOMDIR_IMAGE,
-   } gdcmDicomDirType;
+      GDCM_DICOMDIR_IMAGE
+   } DicomDirType;
    
 protected:
-   void CreateDicomDirChainedList(std::string path);
-   void CallStartMethod(void);
-   void CallProgressMethod(void);
-   void CallEndMethod(void);
+   void CreateDicomDirChainedList(std::string const &path);
+   void CallStartMethod();
+   void CallProgressMethod();
+   void CallEndMethod();
 
 private:
-   void Initialize(void);
-   void CreateDicomDir(void);
-   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);
-   
-   void UpdateDirectoryRecordSequenceLength(void);
+   void Initialize();
+   void CreateDicomDir();
+
+   bool AddPatientToEnd(DicomDirPatient *dd);
+   bool AddStudyToEnd  (DicomDirStudy *dd);
+   bool AddSerieToEnd  (DicomDirSerie *dd);
+   bool AddImageToEnd  (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(DocEntrySet *dst,DocEntrySet *src);
+
+   static bool HeaderLessThan(Document *header1, Document *header2);
    
 // Variables
 
-   /// Pointer on *the* gdcmObject '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 tremination 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;
+   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;
 };
-
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif