]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomDir.h
ENH: Move the old setup.py to its new home
[gdcm.git] / src / gdcmDicomDir.h
index 4f80a6236ec69f271a1e2af20308ea5b6e84e252..40772ca8ddcd3aee59abca3d2a8cc614d92a497d 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDir.h,v $
   Language:  C++
-  Date:      $Date: 2004/08/26 15:29:52 $
-  Version:   $Revision: 1.27 $
+  Date:      $Date: 2004/10/09 03:21:55 $
+  Version:   $Revision: 1.33 $
   
   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
@@ -32,7 +32,7 @@
 typedef std::list<gdcmDicomDirPatient*>   ListDicomDirPatient;
 typedef std::vector<gdcmDocument*>  VectDocument;
 
-typedef GDCM_EXPORT void(gdcmMethod)(void * = NULL);
+typedef GDCM_EXPORT void(gdcmMethod)(void* = NULL);
 //-----------------------------------------------------------------------------
 
 /**
@@ -52,42 +52,42 @@ public:
    /// \sa    SetPrintLevel
    virtual void Print(std::ostream &os = std::cout);
 
-// Informations contained in the parser
+   /// Informations contained in the parser
    virtual bool IsReadable();
 
    /// Returns a pointer to the gdcmDicomDirMeta for this DICOMDIR. 
-   gdcmDicomDirMeta* GetDicomDirMeta() { return metaElems; };
+   gdcmDicomDirMeta* GetDicomDirMeta() { return MetaElems; };
 
    /// Returns the PATIENT chained List for this DICOMDIR.    
-   ListDicomDirPatient &GetDicomDirPatients() { return patients; };
+   ListDicomDirPatient &GetDicomDirPatients() { return Patients; };
 
-// Parsing
+   /// Parsing
    void ParseDirectory();
    
-   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 *);
+   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*);
 
    /// GetProgress GetProgress
-   float GetProgress()  { return progress; };
+   float GetProgress()  { return Progress; };
 
    /// AbortProgress AbortProgress
-   void  AbortProgress() { abort = true; };
+   void  AbortProgress() { Abort = true; };
 
    /// IsAborted IsAborted
-   bool  IsAborted() { return abort; };
+   bool  IsAborted() { return Abort; };
    
-// Adding
+   /// Adding
    gdcmDicomDirMeta*    NewMeta();
    gdcmDicomDirPatient* NewPatient();
 
-// Write  
-   bool Write(std::string const & fileName);
+   /// Write  
+   bool WriteDicomDir(std::string const & fileName);
 
-   /// Types of the gdcmObject within the gdcmDicomDir
+   /// Types of the gdcmDicomDirObject within the gdcmDicomDir
    typedef enum
    {
       GDCM_DICOMDIR_NONE,
@@ -95,7 +95,7 @@ public:
       GDCM_DICOMDIR_PATIENT,
       GDCM_DICOMDIR_STUDY,
       GDCM_DICOMDIR_SERIE,
-      GDCM_DICOMDIR_IMAGE,
+      GDCM_DICOMDIR_IMAGE
    } gdcmDicomDirType;
    
 protected:
@@ -108,49 +108,47 @@ private:
    void Initialize();
    void CreateDicomDir();
    void AddDicomDirMeta();
-   void AddDicomDirPatientToEnd(gdcmSQItem *s);
-   void AddDicomDirStudyToEnd  (gdcmSQItem *s);
-   void AddDicomDirSerieToEnd  (gdcmSQItem *s);
-   void AddDicomDirImageToEnd  (gdcmSQItem *s);
+   void AddDicomDirPatientToEnd(gdcmSQItems);
+   void AddDicomDirStudyToEnd  (gdcmSQItems);
+   void AddDicomDirSerieToEnd  (gdcmSQItems);
+   void AddDicomDirImageToEnd  (gdcmSQItems);
 
    void SetElements(std::string &path, VectDocument &list);
    void SetElement (std::string &path,gdcmDicomDirType type,
-                    gdcmDocument *header);
-   
-   void UpdateDirectoryRecordSequenceLength();
+                    gdcmDocument* header);
 
-   static bool HeaderLessThan(gdcmDocument *header1,gdcmDocument *header2);
+   static bool HeaderLessThan(gdcmDocument* header1,gdcmDocument* header2);
    
 // Variables
 
-   /// Pointer on *the* gdcmObject 'DicomDirMeta Elements'
-   gdcmDicomDirMeta *metaElems;
+   /// Pointer on *the* gdcmDicomDirObject 'DicomDirMeta Elements'
+   gdcmDicomDirMeta* 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 termination 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;
+
+   /// 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 termination 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;
 };
 
 //-----------------------------------------------------------------------------