]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomDir.h
- now, DicomDir stuff stakes into account the 'new' structure
[gdcm.git] / src / gdcmDicomDir.h
index d2d024872f9012dbde776e727fb91d2f2c8ed632..4f80a6236ec69f271a1e2af20308ea5b6e84e252 100644 (file)
@@ -1,10 +1,26 @@
-// gdcmDicomDir.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+  
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDicomDir.h,v $
+  Language:  C++
+  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
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+  
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+  
+=========================================================================*/
+
 #ifndef GDCMDICOMDIR_H
 #define GDCMDICOMDIR_H
 
-#include "gdcmHeader.h"
 #include "gdcmCommon.h"
+#include "gdcmDocument.h"
 #include "gdcmDicomDirPatient.h"
 #include "gdcmDicomDirMeta.h"
 #include "gdcmDicomDirElement.h"
@@ -13,8 +29,8 @@
 #include <vector>
 
 //-----------------------------------------------------------------------------
-typedef std::list<gdcmDicomDirPatient *>   ListDicomDirPatient;
-typedef std::vector<gdcmHeader *>  ListHeader;
+typedef std::list<gdcmDicomDirPatient*>   ListDicomDirPatient;
+typedef std::vector<gdcmDocument*>  VectDocument;
 
 typedef GDCM_EXPORT void(gdcmMethod)(void * = NULL);
 //-----------------------------------------------------------------------------
@@ -24,50 +40,29 @@ typedef GDCM_EXPORT void(gdcmMethod)(void * = NULL);
  * \brief    gdcmDicomDir defines an object representing a DICOMDIR in memory.
  *
  */
-class GDCM_EXPORT gdcmDicomDir: public gdcmParser
+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 gdcmParser
-    * \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 gdcmParser
-    * \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);
-/**
- * \ingroup gdcmDicomDir
- * \brief   returns a pointer to the gdcmDicomDirMeta for this DICOMDIR.
- */   
-   inline gdcmDicomDirMeta   *GetDicomDirMeta()      
-      {return metaElems;};
-/**
- * \ingroup gdcmDicomDir
- * \brief   returns the PATIENT chained List for this DICOMDIR.
- */      
-   inline ListDicomDirPatient &GetDicomDirPatients() 
-      {return patients;};
+   virtual bool IsReadable();
+
+   /// Returns a pointer to the gdcmDicomDirMeta for this DICOMDIR. 
+   gdcmDicomDirMeta* GetDicomDirMeta() { return metaElems; };
+
+   /// Returns the PATIENT chained List for this DICOMDIR.    
+   ListDicomDirPatient &GetDicomDirPatients() { return patients; };
 
 // Parsing
-   void ParseDirectory(void);
-   void CheckBoundaries(void);
+   void ParseDirectory();
    
    void SetStartMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL);
    void SetStartMethodArgDelete(gdcmMethod *);
@@ -75,31 +70,24 @@ public:
    void SetProgressMethodArgDelete(gdcmMethod *);
    void SetEndMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL);
    void SetEndMethodArgDelete(gdcmMethod *);
-/**
- * \ingroup gdcmDicomDir
- * \brief   GetProgress.
- */ 
-   inline float GetProgress(void)  
-      {return(progress);};
-/**
- * \ingroup gdcmDicomDir
- * \brief   AbortProgress.
- */   inline void  AbortProgress(void)
-      {abort=true;      };
-/**
- * \ingroup gdcmDicomDir
- * \brief   IsAborted.
- */   inline bool  IsAborted(void)
-      {return(abort);   };
+
+   /// GetProgress GetProgress
+   float GetProgress()  { return progress; };
+
+   /// AbortProgress AbortProgress
+   void  AbortProgress() { abort = true; };
+
+   /// IsAborted IsAborted
+   bool  IsAborted() { return abort; };
    
 // Adding
-  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,
@@ -111,44 +99,41 @@ 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 CreateDicomDir(void);
-   void AddObjectToEnd(gdcmDicomDirType type,
-                                ListTag::iterator begin,ListTag::iterator end);
-   void AddDicomDirMetaToEnd   (ListTag::iterator begin,ListTag::iterator end);
-   void AddDicomDirPatientToEnd(ListTag::iterator begin,ListTag::iterator end);
-   void AddDicomDirStudyToEnd  (ListTag::iterator begin,ListTag::iterator end);
-   void AddDicomDirSerieToEnd  (ListTag::iterator begin,ListTag::iterator end);
-   void AddDicomDirImageToEnd  (ListTag::iterator begin,ListTag::iterator end);
-
-   void SetElements(std::string &path,ListHeader &list);
-   void SetElement (std::string &path,gdcmDicomDirType type,gdcmHeader *header);
+   void Initialize();
+   void CreateDicomDir();
+   void AddDicomDirMeta();
+   void AddDicomDirPatientToEnd(gdcmSQItem *s);
+   void AddDicomDirStudyToEnd  (gdcmSQItem *s);
+   void AddDicomDirSerieToEnd  (gdcmSQItem *s);
+   void AddDicomDirImageToEnd  (gdcmSQItem *s);
+
+   void SetElements(std::string &path, VectDocument &list);
+   void SetElement (std::string &path,gdcmDicomDirType type,
+                    gdcmDocument *header);
    
-   void UpdateDirectoryRecordSequenceLength(void);
+   void UpdateDirectoryRecordSequenceLength();
 
-   static bool HeaderLessThan(gdcmHeader *header1,gdcmHeader *header2);
+   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;