src/gdcmDicomDir.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDicomDir.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/20 11:09:23 $
   7   Version:   $Revision: 1.49 $
   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  *  as a tree-like structure DicomDirPatient -> DicomDirStudy -> DicomDirSerie
  47  * -> DicomDirImage
  48  *
  49  */
  50 class GDCM_EXPORT DicomDir: public Document
  51 {
  52 public:
  53    typedef void(Method)(void*);
  54
  55    DicomDir( std::string const &filename, bool parseDir = false );
  56    DicomDir();
  57
  58    ~DicomDir();
  59
  60    /// \brief   canonical Printer
  61    void Print(std::ostream &os = std::cout, std::string const & indent = "" );
  62
  63
  64    /// Informations contained in the parser
  65    virtual bool IsReadable();
  66
  67    /// Parsing
  68    void ParseDirectory();
  69
  70    // Note: the DicomDir:: namespace prefix is needed by Swig in the
  71    //       following method declarations. Refer to gdcmPython/gdcm.i
  72    //       for the reasons of this unecessary notation at C++ level.
  73    void SetStartMethod(    DicomDir::Method *method,
  74                            void *arg = NULL,
  75                            DicomDir::Method *argDelete = NULL );
  76    void SetProgressMethod( DicomDir::Method *method,
  77                            void *arg = NULL,
  78                            DicomDir::Method *argDelete = NULL );
  79    void SetEndMethod(      DicomDir::Method *method,
  80                            void *arg = NULL,
  81                            DicomDir::Method *argDelete = NULL );
  82    void SetStartMethodArgDelete( DicomDir::Method *m );
  83    void SetProgressMethodArgDelete( DicomDir::Method *m );
  84    void SetEndMethodArgDelete( DicomDir::Method *m );
  85    /// GetProgress GetProgress
  86    float GetProgress()  { return Progress; };
  87    /// AbortProgress AbortProgress
  88    void  AbortProgress() { Abort = true; };
  89    /// IsAborted IsAborted
  90    bool  IsAborted() { return Abort; };
  91
  92    /// Returns a pointer to the DicomDirMeta for this DICOMDIR.
  93    DicomDirMeta* GetMeta() { return MetaElems; };
  94
  95    // should avoid exposing internal mechanism
  96    DicomDirPatient *GetFirstPatient();
  97    DicomDirPatient *GetNextPatient();
  98
  99    /// Adding
 100    DicomDirMeta    *NewMeta();
 101    DicomDirPatient *NewPatient();
 102
 103    /// Write
 104    bool WriteDicomDir(std::string const &fileName);
 105
 106    /// Types of the DicomDirObject within the DicomDir
 107    typedef enum
 108    {
 109       GDCM_DICOMDIR_NONE,
 110       GDCM_DICOMDIR_META,
 111       GDCM_DICOMDIR_PATIENT,
 112       GDCM_DICOMDIR_STUDY,
 113       GDCM_DICOMDIR_SERIE,
 114       GDCM_DICOMDIR_IMAGE
 115    } DicomDirType;
 116
 117 protected:
 118    void CreateDicomDirChainedList(std::string const &path);
 119    void CallStartMethod();
 120    void CallProgressMethod();
 121    void CallEndMethod();
 122
 123 private:
 124    void Initialize();
 125    void CreateDicomDir();
 126
 127    bool AddPatientToEnd(DicomDirPatient *dd);
 128    bool AddStudyToEnd  (DicomDirStudy *dd);
 129    bool AddSerieToEnd  (DicomDirSerie *dd);
 130    bool AddImageToEnd  (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    ListDicomDirPatient::iterator ItPatient;
 147
 148    /// pointer to the initialisation method for any progress bar
 149    Method* StartMethod;
 150    /// pointer to the incrementation method for any progress bar
 151    Method* ProgressMethod;
 152    /// pointer to the termination method for any progress bar
 153    Method* EndMethod;
 154    /// pointer to the ??? method for any progress bar
 155    Method* StartMethodArgDelete;
 156    /// pointer to the ??? method for any progress bar
 157    Method* ProgressMethodArgDelete;
 158    /// pointer to the ??? method for any progress bar
 159    Method* EndMethodArgDelete;
 160    /// pointer to the ??? for any progress bar
 161    void* StartArg;
 162    /// pointer to the ??? for any progress bar
 163    void* ProgressArg;
 164    /// pointer to the ??? for any progress bar
 165    void* EndArg;
 166    /// value of the ??? for any progress bar
 167    float Progress;
 168    /// value of the ??? for any progress bar
 169    bool Abort;
 170 };
 171 } // end namespace gdcm
 172 //-----------------------------------------------------------------------------
 173 #endif