Avoid Doxygen Warnings

[gdcm.git] / src / gdcmDicomDir.h

diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h
index 3fc3c11f5a3bacbd6457642db12bc98f235d5ae1..15162e8d6e53add093968c7b606ad62b9fe5e176 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/07/08 19:07:12 $
-  Version:   $Revision: 1.63 $
+  Date:      $Date: 2005/11/29 12:48:46 $
+  Version:   $Revision: 1.72 $
   
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -20,6 +20,7 @@
 #define GDCMDICOMDIR_H
 
 #include "gdcmDocument.h"
+#include "gdcmDebug.h"
 
 #include <list>
 #include <vector>
@@ -36,8 +37,8 @@ class DicomDirVisit;
 class DicomDirImage;
 class SQItem;
 
-typedef std::list<DicomDirPatient *>   ListDicomDirPatient;
-typedef std::vector<Document *>  VectDocument;
+typedef std::list<DicomDirPatient *> ListDicomDirPatient;
+typedef std::vector<Document *> VectDocument;
 
 //-----------------------------------------------------------------------------
 /**
@@ -49,29 +50,23 @@ typedef std::vector<Document *>  VectDocument;
  */
 class GDCM_EXPORT DicomDir: public Document
 {
-public:
-   typedef void Method(void*);
+   gdcmTypeMacro(DicomDir);
 
-   DicomDir( std::string const &filename, bool parseDir = false );
-   DicomDir(); 
-                   
-   ~DicomDir();
+public:
+/// \brief Constructs a DicomDir with a RefCounter
+   static DicomDir *New() {return new DicomDir();}
 
-   bool Load( std::string const &filename );
    bool Load( );
    void Print(std::ostream &os = std::cout, std::string const &indent = "" );
    
    /// Sets the root Directory name to parse, recursively
    void SetDirectoryName(std::string const &dirName) 
         { ParseDir = true; if (Filename != dirName)
-                               Filename = dirName, IsDocumentModified = true; };
+                               Filename = dirName, IsDocumentModified = true; }
    /// Accessor to \ref Filename
    virtual void SetFileName(std::string const &fileName) 
                    { ParseDir = false; if (Filename != fileName)
-                               Filename = fileName, IsDocumentModified = true; }
-
-   /// DEPRECATED : use SetDirectoryName
-   void SetParseDir(bool parseDir)  { ParseDir = parseDir; };
+                              Filename = fileName, IsDocumentModified = true;}
    
    // Informations contained in the parser
    virtual bool IsReadable();
@@ -79,7 +74,7 @@ public:
    // Meta
    DicomDirMeta *NewMeta();
    /// Returns a pointer to the DicomDirMeta for this DICOMDIR. 
-   DicomDirMeta *GetMeta() { return MetaElems; };
+   DicomDirMeta *GetMeta() { return MetaElems; }
 
    // Patients
    DicomDirPatient *NewPatient();
@@ -91,33 +86,19 @@ public:
    // 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 unnecessary notation at C++ level.
-   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; };
+   float GetProgress() const { return Progress; }
    /// AbortProgress AbortProgress
-   void  AbortProgress() { Abort = true; };
+   void  AbortProgress() { Abort = true; }
    /// IsAborted IsAborted
-   bool  IsAborted() { return Abort; };
+   bool  IsAborted() { return Abort; }
 
    // Write
-   bool WriteDicomDir(std::string const &fileName);
+   bool Write(std::string const &fileName);
 
-   bool AnonymizeDicomDir();
+   bool Anonymize();
+
+   virtual void Copy(DocEntrySet *set);
 
    /// Types of the DicomDirObject within the DicomDir
    typedef enum
@@ -132,6 +113,9 @@ public:
    } DicomDirType;
    
 protected:
+   DicomDir(); 
+   ~DicomDir();
+
    void CreateDicomDirChainedList(std::string const &path);
    void CallStartMethod();
    void CallProgressMethod();
@@ -163,29 +147,12 @@ private:
    ListDicomDirPatient Patients;
    ListDicomDirPatient::iterator ItPatient;
 
-   /// pointer to the initialisation method for any progress bar   
-   Method *StartMethod;
-   /// pointer to the incrementation method for any progress bar
-   Method *ProgressMethod;
-   /// pointer to the termination method for any progress bar
-   Method *EndMethod;
-   /// pointer to the ??? method for any progress bar   
-   Method *StartMethodArgDelete;
-   /// pointer to the ??? method for any progress bar
-   Method* ProgressMethodArgDelete;
-   /// pointer to the ??? method for any progress bar
-   Method *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;
    bool ParseDir;
+
+   mutable bool Abort;
 };
 } // end namespace gdcm
 //-----------------------------------------------------------------------------