Update comments for DicomDir stuff

[gdcm.git] / src / gdcmDicomDir.h

diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h
index b54a54d1799225d4c1247c3f9ad4d94b6fb925c6..a7d6893daea6d031b6ad40d123d9c2756319c27a 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: 2005/02/01 10:29:54 $
-  Version:   $Revision: 1.51 $
+  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
@@ -40,11 +40,11 @@ typedef std::vector<Document *>  VectDocument;
 
 //-----------------------------------------------------------------------------
 /**
- * \ingroup DicomDir
  * \brief   DicomDir defines an object representing a DICOMDIR in memory
- *  as a tree-like structure DicomDirPatient -> DicomDirStudy -> DicomDirSerie
- * -> DicomDirImage
- *
+ *  as a tree-like structure DicomDirPatient 
+ *                            -> DicomDirStudy 
+ *                                -> DicomDirSerie
+ *                                    -> DicomDirImage
  */
 class GDCM_EXPORT DicomDir: public Document
 {
@@ -56,16 +56,26 @@ public:
                    
    ~DicomDir();
 
-   /// \brief   canonical Printer 
-   void Print(std::ostream &os = std::cout, std::string const & indent = "" );
+   void Print(std::ostream &os = std::cout, std::string const &indent = "" );
 
-   
-   /// Informations contained in the parser
+   // Informations contained in the parser
    virtual bool IsReadable();
 
-   /// Parsing
+   // 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.
@@ -81,6 +91,7 @@ public:
    void SetStartMethodArgDelete( DicomDir::Method *m );
    void SetProgressMethodArgDelete( DicomDir::Method *m );
    void SetEndMethodArgDelete( DicomDir::Method *m );
+
    /// GetProgress GetProgress
    float GetProgress()  { return Progress; };
    /// AbortProgress AbortProgress
@@ -88,21 +99,7 @@ public:
    /// IsAborted IsAborted
    bool  IsAborted() { return Abort; };
 
-   /// Returns a pointer to the DicomDirMeta for this DICOMDIR. 
-   DicomDirMeta* GetMeta() { return MetaElems; };
-
-   // should avoid exposing internal mechanism
-   DicomDirPatient *GetFirstPatient();
-   DicomDirPatient *GetNextPatient();
-
-   /// Adding
-   DicomDirMeta    *NewMeta();
-   DicomDirPatient *NewPatient();
-
-   /// Removing
-   void ClearPatient();
-
-   /// Write  
+   // Write
    bool WriteDicomDir(std::string const &fileName);
 
    /// Types of the DicomDirObject within the DicomDir
@@ -148,23 +145,23 @@ private:
    ListDicomDirPatient::iterator ItPatient;
 
    /// pointer to the initialisation method for any progress bar   
-   Method* StartMethod;
+   Method *StartMethod;
    /// pointer to the incrementation method for any progress bar
-   Method* ProgressMethod;
+   Method *ProgressMethod;
    /// pointer to the termination method for any progress bar
-   Method* EndMethod;
+   Method *EndMethod;
    /// pointer to the ??? method for any progress bar   
-   Method* StartMethodArgDelete;
+   Method *StartMethodArgDelete;
    /// pointer to the ??? method for any progress bar
    Method* ProgressMethodArgDelete;
    /// pointer to the ??? method for any progress bar
-   Method* EndMethodArgDelete;
+   Method *EndMethodArgDelete;
    /// pointer to the ??? for any progress bar   
-   void* StartArg;
+   void *StartArg;
    /// pointer to the ??? for any progress bar
-   void* ProgressArg;
+   void *ProgressArg;
    /// pointer to the ??? for any progress bar   
-   void* EndArg;
+   void *EndArg;
    /// value of the ??? for any progress bar
    float Progress;
    /// value of the ??? for any progress bar