src/gdcmDicomDir.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDicomDir.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/06 20:03:26 $
   7   Version:   $Revision: 1.43 $
   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 /**
  44  * \ingroup DicomDir
  45  * \brief    DicomDir defines an object representing a DICOMDIR in memory.
  46  *
  47  */
  48 class GDCM_EXPORT DicomDir: public Document
  49 {
  50 public:
  51    typedef void(Method)(void*);
  52
  53    DicomDir( std::string const &filename, bool parseDir = false );
  54    DicomDir();
  55
  56    ~DicomDir();
  57
  58    /// \brief   canonical Printer
  59    void Print(std::ostream &os = std::cout);
  60
  61    /// Informations contained in the parser
  62    virtual bool IsReadable();
  63
  64    /// Returns a pointer to the DicomDirMeta for this DICOMDIR.
  65    DicomDirMeta* GetDicomDirMeta() { return MetaElems; };
  66
  67    /// Returns the PATIENT chained List for this DICOMDIR.
  68    ListDicomDirPatient const & GetDicomDirPatients() const { return Patients; };
  69
  70    /// Parsing
  71    void ParseDirectory();
  72
  73    // Note: the DicomDir:: namespace prefix is needed by Swig in the
  74    //       following method declarations. Refer to gdcmPython/gdcm.i
  75    //       for the reasons of this unecessary notation at C++ level.
  76    void SetStartMethod(    DicomDir::Method *m,
  77                            void* = NULL,
  78                            DicomDir::Method *m = NULL );
  79    void SetProgressMethod( DicomDir::Method *m,
  80                            void* = NULL,
  81                            DicomDir::Method *m = NULL );
  82    void SetEndMethod(      DicomDir::Method *m,
  83                            void* = NULL,
  84                            DicomDir::Method *m = NULL );
  85    void SetStartMethodArgDelete( DicomDir::Method *m );
  86    void SetProgressMethodArgDelete( DicomDir::Method *m );
  87    void SetEndMethodArgDelete( DicomDir::Method *m );
  88
  89    /// GetProgress GetProgress
  90    float GetProgress()  { return Progress; };
  91
  92    /// AbortProgress AbortProgress
  93    void  AbortProgress() { Abort = true; };
  94
  95    /// IsAborted IsAborted
  96    bool  IsAborted() { return Abort; };
  97
  98    /// Adding
  99    DicomDirMeta    *NewMeta();
 100    DicomDirPatient *NewPatient();
 101
 102    /// Write
 103    bool WriteDicomDir(std::string const &fileName);
 104
 105    /// Types of the DicomDirObject within the DicomDir
 106    typedef enum
 107    {
 108       GDCM_DICOMDIR_NONE,
 109       GDCM_DICOMDIR_META,
 110       GDCM_DICOMDIR_PATIENT,
 111       GDCM_DICOMDIR_STUDY,
 112       GDCM_DICOMDIR_SERIE,
 113       GDCM_DICOMDIR_IMAGE
 114    } DicomDirType;
 115
 116 protected:
 117    void CreateDicomDirChainedList(std::string const &path);
 118    void CallStartMethod();
 119    void CallProgressMethod();
 120    void CallEndMethod();
 121
 122 private:
 123    void Initialize();
 124    void CreateDicomDir();
 125
 126    bool AddDicomDirMeta();
 127    bool AddDicomDirPatientToEnd(DicomDirPatient *dd);
 128    bool AddDicomDirStudyToEnd  (DicomDirStudy *dd);
 129    bool AddDicomDirSerieToEnd  (DicomDirSerie *dd);
 130    bool AddDicomDirImageToEnd  (DicomDirImage *dd);
 131
 132    void SetElements(std::string const &path, VectDocument const &list);
 133    void SetElement (std::string const &path, DicomDirType type,
 134                     Document *header);
 135    void MoveSQItem(SQItem *dst,SQItem *src);
 136
 137    static bool HeaderLessThan(Document *header1, Document *header2);
 138
 139 // Variables
 140
 141    /// Pointer on *the* DicomDirObject 'DicomDirMeta Elements'
 142    DicomDirMeta* MetaElems;
 143
 144    /// Chained list of DicomDirPatient (to be exploited recursively)
 145    ListDicomDirPatient Patients;
 146
 147    /// pointer to the initialisation method for any progress bar
 148    Method* StartMethod;
 149    /// pointer to the incrementation method for any progress bar
 150    Method* ProgressMethod;
 151    /// pointer to the termination method for any progress bar
 152    Method* EndMethod;
 153    /// pointer to the ??? method for any progress bar
 154    Method* StartMethodArgDelete;
 155    /// pointer to the ??? method for any progress bar
 156    Method* ProgressMethodArgDelete;
 157    /// pointer to the ??? method for any progress bar
 158    Method* EndMethodArgDelete;
 159    /// pointer to the ??? for any progress bar
 160    void* StartArg;
 161    /// pointer to the ??? for any progress bar
 162    void* ProgressArg;
 163    /// pointer to the ??? for any progress bar
 164    void* EndArg;
 165    /// value of the ??? for any progress bar
 166    float Progress;
 167    /// value of the ??? for any progress bar
 168    bool Abort;
 169 };
 170 } // end namespace gdcm
 171 //-----------------------------------------------------------------------------
 172 #endif