src/gdcmDicomDir.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDicomDir.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/02/01 10:29:54 $
   7   Version:   $Revision: 1.51 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 #ifndef GDCMDICOMDIR_H
  20 #define GDCMDICOMDIR_H
  21
  22 #include "gdcmDocument.h"
  23
  24 #include <list>
  25 #include <vector>
  26
  27 namespace gdcm
  28 {
  29 //-----------------------------------------------------------------------------
  30 class DicomDirPatient;
  31 class DicomDirMeta;
  32 class DicomDirElement;
  33 class DicomDirStudy;
  34 class DicomDirSerie;
  35 class DicomDirImage;
  36 class SQItem;
  37
  38 typedef std::list<DicomDirPatient *>   ListDicomDirPatient;
  39 typedef std::vector<Document *>  VectDocument;
  40
  41 //-----------------------------------------------------------------------------
  42 /**
  43  * \ingroup DicomDir
  44  * \brief   DicomDir defines an object representing a DICOMDIR in memory
  45  *  as a tree-like structure DicomDirPatient -> DicomDirStudy -> DicomDirSerie
  46  * -> DicomDirImage
  47  *
  48  */
  49 class GDCM_EXPORT DicomDir: public Document
  50 {
  51 public:
  52    typedef void(Method)(void*);
  53
  54    DicomDir( std::string const &filename, bool parseDir = false );
  55    DicomDir();
  56
  57    ~DicomDir();
  58
  59    /// \brief   canonical Printer
  60    void Print(std::ostream &os = std::cout, std::string const & indent = "" );
  61
  62
  63    /// Informations contained in the parser
  64    virtual bool IsReadable();
  65
  66    /// Parsing
  67    void ParseDirectory();
  68
  69    // Note: the DicomDir:: namespace prefix is needed by Swig in the
  70    //       following method declarations. Refer to gdcmPython/gdcm.i
  71    //       for the reasons of this unecessary notation at C++ level.
  72    void SetStartMethod(    DicomDir::Method *method,
  73                            void *arg = NULL,
  74                            DicomDir::Method *argDelete = NULL );
  75    void SetProgressMethod( DicomDir::Method *method,
  76                            void *arg = NULL,
  77                            DicomDir::Method *argDelete = NULL );
  78    void SetEndMethod(      DicomDir::Method *method,
  79                            void *arg = NULL,
  80                            DicomDir::Method *argDelete = NULL );
  81    void SetStartMethodArgDelete( DicomDir::Method *m );
  82    void SetProgressMethodArgDelete( DicomDir::Method *m );
  83    void SetEndMethodArgDelete( DicomDir::Method *m );
  84    /// GetProgress GetProgress
  85    float GetProgress()  { return Progress; };
  86    /// AbortProgress AbortProgress
  87    void  AbortProgress() { Abort = true; };
  88    /// IsAborted IsAborted
  89    bool  IsAborted() { return Abort; };
  90
  91    /// Returns a pointer to the DicomDirMeta for this DICOMDIR.
  92    DicomDirMeta* GetMeta() { return MetaElems; };
  93
  94    // should avoid exposing internal mechanism
  95    DicomDirPatient *GetFirstPatient();
  96    DicomDirPatient *GetNextPatient();
  97
  98    /// Adding
  99    DicomDirMeta    *NewMeta();
 100    DicomDirPatient *NewPatient();
 101
 102    /// Removing
 103    void ClearPatient();
 104
 105    /// Write
 106    bool WriteDicomDir(std::string const &fileName);
 107
 108    /// Types of the DicomDirObject within the DicomDir
 109    typedef enum
 110    {
 111       GDCM_DICOMDIR_NONE,
 112       GDCM_DICOMDIR_META,
 113       GDCM_DICOMDIR_PATIENT,
 114       GDCM_DICOMDIR_STUDY,
 115       GDCM_DICOMDIR_SERIE,
 116       GDCM_DICOMDIR_IMAGE
 117    } DicomDirType;
 118
 119 protected:
 120    void CreateDicomDirChainedList(std::string const &path);
 121    void CallStartMethod();
 122    void CallProgressMethod();
 123    void CallEndMethod();
 124
 125 private:
 126    void Initialize();
 127    void CreateDicomDir();
 128
 129    bool AddPatientToEnd(DicomDirPatient *dd);
 130    bool AddStudyToEnd  (DicomDirStudy *dd);
 131    bool AddSerieToEnd  (DicomDirSerie *dd);
 132    bool AddImageToEnd  (DicomDirImage *dd);
 133
 134    void SetElements(std::string const &path, VectDocument const &list);
 135    void SetElement (std::string const &path, DicomDirType type,
 136                     Document *header);
 137    void MoveSQItem(DocEntrySet *dst,DocEntrySet *src);
 138
 139    static bool HeaderLessThan(Document *header1, Document *header2);
 140
 141 // Variables
 142
 143    /// Pointer on *the* DicomDirObject 'DicomDirMeta Elements'
 144    DicomDirMeta* MetaElems;
 145
 146    /// Chained list of DicomDirPatient (to be exploited recursively)
 147    ListDicomDirPatient Patients;
 148    ListDicomDirPatient::iterator ItPatient;
 149
 150    /// pointer to the initialisation method for any progress bar
 151    Method* StartMethod;
 152    /// pointer to the incrementation method for any progress bar
 153    Method* ProgressMethod;
 154    /// pointer to the termination method for any progress bar
 155    Method* EndMethod;
 156    /// pointer to the ??? method for any progress bar
 157    Method* StartMethodArgDelete;
 158    /// pointer to the ??? method for any progress bar
 159    Method* ProgressMethodArgDelete;
 160    /// pointer to the ??? method for any progress bar
 161    Method* EndMethodArgDelete;
 162    /// pointer to the ??? for any progress bar
 163    void* StartArg;
 164    /// pointer to the ??? for any progress bar
 165    void* ProgressArg;
 166    /// pointer to the ??? for any progress bar
 167    void* EndArg;
 168    /// value of the ??? for any progress bar
 169    float Progress;
 170    /// value of the ??? for any progress bar
 171    bool Abort;
 172 };
 173 } // end namespace gdcm
 174 //-----------------------------------------------------------------------------
 175 #endif