Doxygenation

[gdcm.git] / src / gdcmDicomDir.h

diff --git a/src/gdcmDicomDir.h b/src/gdcmDicomDir.h
index 3ba3aa54e55b749a761fe1d4b1a4710236a322b6..4594450a8a5f116cab55b9363d47861b171d7b5f 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/11/09 10:25:27 $
-  Version:   $Revision: 1.37 $
+  Date:      $Date: 2004/12/16 13:46:36 $
+  Version:   $Revision: 1.42 $
   
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -19,11 +19,7 @@
 #ifndef GDCMDICOMDIR_H
 #define GDCMDICOMDIR_H
 
-#include "gdcmCommon.h"
 #include "gdcmDocument.h"
-#include "gdcmDicomDirPatient.h"
-#include "gdcmDicomDirMeta.h"
-#include "gdcmDicomDirElement.h"
 
 #include <list>
 #include <vector>
@@ -31,6 +27,14 @@
 namespace gdcm 
 {
 //-----------------------------------------------------------------------------
+class DicomDirPatient;
+class DicomDirMeta;
+class DicomDirElement;
+class DicomDirStudy;
+class DicomDirSerie;
+class DicomDirImage;
+class SQItem;
+
 typedef std::list<DicomDirPatient*>   ListDicomDirPatient;
 typedef std::vector<Document*>  VectDocument;
 
@@ -44,14 +48,14 @@ typedef std::vector<Document*>  VectDocument;
 class GDCM_EXPORT DicomDir: public Document
 {
 public:
-   typedef GDCM_EXPORT void(Method)(void*);
+   typedef void(Method)(void*);
+
    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
@@ -66,6 +70,9 @@ 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 unecessary notation at C++ level.
    void SetStartMethod(    DicomDir::Method*,
                            void* = NULL,
                            DicomDir::Method* = NULL );
@@ -115,15 +122,17 @@ protected:
 private:
    void Initialize();
    void CreateDicomDir();
-   void AddDicomDirMeta();
-   void AddDicomDirPatientToEnd(SQItem* s);
-   void AddDicomDirStudyToEnd  (SQItem* s);
-   void AddDicomDirSerieToEnd  (SQItem* s);
-   void AddDicomDirImageToEnd  (SQItem* s);
+
+   bool AddDicomDirMeta();
+   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);
 
    static bool HeaderLessThan(Document* header1, Document* header2);