STYLE: minor clean up

[gdcm.git] / src / gdcmDicomDir.h

diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h
index 5aae1c919d2761d4da56707dab2a711650445c00..07b099eabb2f2c1b3e05e36a7e5e36f54891b6a5 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/12/03 20:16:57 $
-  Version:   $Revision: 1.41 $
+  Date:      $Date: 2005/01/11 15:15:38 $
+  Version:   $Revision: 1.45 $
   
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -35,14 +35,16 @@ class DicomDirSerie;
 class DicomDirImage;
 class SQItem;
 
-typedef std::list<DicomDirPatient*>   ListDicomDirPatient;
-typedef std::vector<Document*>  VectDocument;
+typedef std::list<DicomDirPatient *>   ListDicomDirPatient;
+typedef std::vector<Document *>  VectDocument;
 
 //-----------------------------------------------------------------------------
 
 /**
  * \ingroup DicomDir
- * \brief    DicomDir 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 DicomDir: public Document
@@ -50,13 +52,12 @@ class GDCM_EXPORT DicomDir: public Document
 public:
    typedef void(Method)(void*);
 
-   DicomDir( std::string const & filename, bool parseDir = false );
+   DicomDir( std::string const &filename, bool parseDir = false );
    DicomDir(); 
                    
    ~DicomDir();
 
    /// \brief   canonical Printer 
-   /// \sa    SetPrintLevel
    void Print(std::ostream &os = std::cout);
 
    /// Informations contained in the parser
@@ -74,18 +75,18 @@ public:
    // 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*,
-                           void* = NULL,
-                           DicomDir::Method* = NULL );
-   void SetProgressMethod( DicomDir::Method*, 
-                           void* = NULL,
-                           DicomDir::Method* = NULL );
-   void SetEndMethod(      DicomDir::Method*,
-                           void* = NULL, 
-                           DicomDir::Method* = NULL );
-   void SetStartMethodArgDelete( DicomDir::Method* );
-   void SetProgressMethodArgDelete( DicomDir::Method* );
-   void SetEndMethodArgDelete( DicomDir::Method* );
+   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()  { return Progress; };
@@ -97,11 +98,11 @@ public:
    bool  IsAborted() { return Abort; };
    
    /// Adding
-   DicomDirMeta*    NewMeta();
-   DicomDirPatient* NewPatient();
+   DicomDirMeta    *NewMeta();
+   DicomDirPatient *NewPatient();
 
    /// Write  
-   bool WriteDicomDir(std::string const & fileName);
+   bool WriteDicomDir(std::string const &fileName);
 
    /// Types of the DicomDirObject within the DicomDir
    typedef enum
@@ -115,7 +116,7 @@ public:
    } DicomDirType;
    
 protected:
-   void CreateDicomDirChainedList(std::string const & path);
+   void CreateDicomDirChainedList(std::string const &path);
    void CallStartMethod();
    void CallProgressMethod();
    void CallEndMethod();
@@ -125,17 +126,17 @@ private:
    void CreateDicomDir();
 
    bool AddDicomDirMeta();
-   bool AddDicomDirPatientToEnd(DicomDirPatient* dd);
-   bool AddDicomDirStudyToEnd  (DicomDirStudy* dd);
-   bool AddDicomDirSerieToEnd  (DicomDirSerie* dd);
-   bool AddDicomDirImageToEnd  (DicomDirImage* dd);
+   bool AddDicomDirPatientToEnd(DicomDirPatient *dd);
+   bool AddDicomDirStudyToEnd  (DicomDirStudy *dd);
+   bool AddDicomDirSerieToEnd  (DicomDirSerie *dd);
+   bool AddDicomDirImageToEnd  (DicomDirImage *dd);
 
-   void SetElements(std::string const & path, VectDocument const &list);
-   void SetElement (std::string const & path, DicomDirType type,
-                    Document* header);
-   void MoveSQItem(SQItem* dst,SQItem *src);
+   void SetElements(std::string const &path, VectDocument const &list);
+   void SetElement (std::string const &path, DicomDirType type,
+                    Document *header);
+   void MoveSQItem(SQItem *dst,SQItem *src);
 
-   static bool HeaderLessThan(Document* header1, Document* header2);
+   static bool HeaderLessThan(Document *header1, Document *header2);
    
 // Variables