]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomDir.h
ENH: do not help people do in-source build
[gdcm.git] / src / gdcmDicomDir.h
index eef34e48968b9d70ad7d93023ef4f39a742ca895..df5d9f64abaa2e5473041a9587751712c92f83c7 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: 2004/09/27 08:39:06 $
+  Version:   $Revision: 1.32 $
   
   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);
 //-----------------------------------------------------------------------------
 
 /**
@@ -43,24 +43,17 @@ typedef GDCM_EXPORT void(gdcmMethod)(void * = NULL);
 class GDCM_EXPORT gdcmDicomDir: public gdcmDocument
 {
 public:
-   gdcmDicomDir(const char *FileName, 
-                bool parseDir = false,
-                bool exception_on_error = false);
-   gdcmDicomDir(bool exception_on_error = false); 
+   gdcmDicomDir( std::string const & fileName, bool parseDir = false );
+   gdcmDicomDir(); 
                    
-   ~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; };
+   ~gdcmDicomDir();
 
    /// \brief   canonical Printer 
    /// \sa    SetPrintLevel
    virtual void Print(std::ostream &os = std::cout);
 
 // Informations contained in the parser
-   virtual bool IsReadable(void);
+   virtual bool IsReadable();
 
    /// Returns a pointer to the gdcmDicomDirMeta for this DICOMDIR. 
    gdcmDicomDirMeta* GetDicomDirMeta() { return metaElems; };
@@ -69,33 +62,32 @@ public:
    ListDicomDirPatient &GetDicomDirPatients() { return patients; };
 
 // Parsing
-   void ParseDirectory(void);
+   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(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); };
+   bool  IsAborted() { return abort; };
    
 // Adding
-   gdcmDicomDirMeta*    NewMeta(void);
-   gdcmDicomDirPatient* NewPatient(void);
+   gdcmDicomDirMeta*    NewMeta();
+   gdcmDicomDirPatient* NewPatient();
 
-// 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 gdcmDicomDirObject within the gdcmDicomDir
    typedef enum
    {
       GDCM_DICOMDIR_NONE,
@@ -103,58 +95,56 @@ public:
       GDCM_DICOMDIR_PATIENT,
       GDCM_DICOMDIR_STUDY,
       GDCM_DICOMDIR_SERIE,
-      GDCM_DICOMDIR_IMAGE,
+      GDCM_DICOMDIR_IMAGE
    } gdcmDicomDirType;
    
 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 Initialize();
+   void CreateDicomDir();
+   void AddDicomDirMeta();
+   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(void);
+                    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'
+   gdcmDicomDirMetametaElems;
 
    /// Chained list of DicomDirPatient (to be exploited recursively) 
    ListDicomDirPatient patients;
 
 /// pointer to the initialisation method for any progress bar   
-   gdcmMethod *startMethod;
+   gdcmMethodstartMethod;
 /// pointer to the incrementation method for any progress bar
-    gdcmMethod *progressMethod;
-/// pointer to the tremination method for any progress bar
-   gdcmMethod *endMethod;
+    gdcmMethodprogressMethod;
+/// pointer to the termination method for any progress bar
+   gdcmMethodendMethod;
 /// pointer to the ??? method for any progress bar   
-   gdcmMethod *startMethodArgDelete;
+   gdcmMethodstartMethodArgDelete;
 /// pointer to the ??? method for any progress bar
-   gdcmMethod *progressMethodArgDelete;
+   gdcmMethodprogressMethodArgDelete;
 /// pointer to the ??? method for any progress bar
-   gdcmMethod *endMethodArgDelete;
+   gdcmMethodendMethodArgDelete;
 /// pointer to the ??? for any progress bar   
-   void *startArg;
+   voidstartArg;
 /// pointer to the ??? for any progress bar
-   void *progressArg;
+   voidprogressArg;
 /// pointer to the ??? for any progress bar   
-   void *endArg;
+   voidendArg;
 /// value of the ??? for any progress bar
    float progress;
 /// value of the ??? for any progress bar