- now, DicomDir stuff stakes into account the 'new' structure

[gdcm.git] / src / gdcmDicomDir.h

diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h
index 98ee8ac4fbc18ab93071a8514c5ea57c7e3ab0d2..4f80a6236ec69f271a1e2af20308ea5b6e84e252 100644 (file)
--- a/src/gdcmDicomDir.h
+++ b/src/gdcmDicomDir.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDir.h,v $
   Language:  C++
-  Date:      $Date: 2004/06/19 23:51:03 $
-  Version:   $Revision: 1.22 $
+  Date:      $Date: 2004/08/26 15:29:52 $
+  Version:   $Revision: 1.27 $
   
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -29,8 +29,8 @@
 #include <vector>
 
 //-----------------------------------------------------------------------------
-typedef std::list<gdcmDicomDirPatient *>   ListDicomDirPatient;
-typedef std::vector<gdcmDocument *>  VectDocument;
+typedef std::list<gdcmDicomDirPatient*>   ListDicomDirPatient;
+typedef std::vector<gdcmDocument*>  VectDocument;
 
 typedef GDCM_EXPORT void(gdcmMethod)(void * = NULL);
 //-----------------------------------------------------------------------------
@@ -43,42 +43,26 @@ typedef GDCM_EXPORT void(gdcmMethod)(void * = NULL);
 class GDCM_EXPORT gdcmDicomDir: public gdcmDocument
 {
 public:
-//   gdcmDicomDir(ListTag *l,
-//                bool exception_on_error = false);
-   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);
-
-   /**
-    * \ingroup gdcmDicomDir
-    * \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; };
-  /**
-    * \ingroup gdcmDicomDir
-    * \brief   canonical Printer 
-    * \sa    SetPrintLevel
-  */     
+   ~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();
 
-/// \brief   returns a pointer to the gdcmDicomDirMeta for this DICOMDIR. 
-   inline gdcmDicomDirMeta   *GetDicomDirMeta()      
-      {return metaElems;};
+   /// Returns a pointer to the gdcmDicomDirMeta for this DICOMDIR. 
+   gdcmDicomDirMeta* GetDicomDirMeta() { return metaElems; };
 
- /// \brief   returns the PATIENT chained List for this DICOMDIR.    
-   inline ListDicomDirPatient &GetDicomDirPatients() 
-      {return patients;};
+   /// Returns the PATIENT chained List for this DICOMDIR.    
+   ListDicomDirPatient &GetDicomDirPatients() { return patients; };
 
 // Parsing
-   void ParseDirectory(void);
+   void ParseDirectory();
    
    void SetStartMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL);
    void SetStartMethodArgDelete(gdcmMethod *);
@@ -87,27 +71,23 @@ public:
    void SetEndMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL);
    void SetEndMethodArgDelete(gdcmMethod *);
 
-/// \brief GetProgress GetProgress
-   inline float GetProgress(void)  
-      {return(progress);};
+   /// GetProgress GetProgress
+   float GetProgress()  { return progress; };
 
-/// \brief AbortProgress AbortProgress
-   inline void  AbortProgress(void)
-      {abort=true;      };
+   /// AbortProgress AbortProgress
+   void  AbortProgress() { abort = true; };
 
-/// \brief IsAborted IsAborted
-      inline bool  IsAborted(void)
-      {return(abort);   };
+   /// IsAborted IsAborted
+   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 Write(std::string const & fileName);
 
-/// Types of the gdcmObject within the gdcmDicomDir
+   /// Types of the gdcmObject within the gdcmDicomDir
    typedef enum
    {
       GDCM_DICOMDIR_NONE,
@@ -119,17 +99,15 @@ public:
    } 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 AddObjectToEnd(gdcmDicomDirType type, gdcmSQItem *s);
-   void AddDicomDirMeta   ();
+   void Initialize();
+   void CreateDicomDir();
+   void AddDicomDirMeta();
    void AddDicomDirPatientToEnd(gdcmSQItem *s);
    void AddDicomDirStudyToEnd  (gdcmSQItem *s);
    void AddDicomDirSerieToEnd  (gdcmSQItem *s);
@@ -139,23 +117,23 @@ private:
    void SetElement (std::string &path,gdcmDicomDirType type,
                     gdcmDocument *header);
    
-   void UpdateDirectoryRecordSequenceLength(void);
+   void UpdateDirectoryRecordSequenceLength();
 
    static bool HeaderLessThan(gdcmDocument *header1,gdcmDocument *header2);
    
 // Variables
 
-/// \brief pointer on *the* gdcmObject 'DicomDirMeta Elements'
+   /// Pointer on *the* gdcmObject 'DicomDirMeta Elements'
    gdcmDicomDirMeta *metaElems;
 
-/// \brief chained list of DicomDirPatient (to be exploited recursively) 
+   /// 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
+/// pointer to the termination method for any progress bar
    gdcmMethod *endMethod;
 /// pointer to the ??? method for any progress bar   
    gdcmMethod *startMethodArgDelete;