gdcmDicomDir.h

Go to the documentation of this file.

/*=========================================================================
  
  Program:   gdcm
  Module:    $RCSfile: gdcmDicomDir.h,v $
  Language:  C++
  Date:      $Date: 2005/02/07 14:48:34 $
  Version:   $Revision: 1.55 $
  
  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.html 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 "gdcmDocument.h"

#include <list>
#include <vector>

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;

//-----------------------------------------------------------------------------
class GDCM_EXPORT DicomDir: public Document
{
public:
   typedef void(Method)(void*);

   DicomDir( std::string const &filename, bool parseDir = false );
   DicomDir(); 
                   
   ~DicomDir();

   void Print(std::ostream &os = std::cout, std::string const &indent = "" );

   // Informations contained in the parser
   virtual bool IsReadable();

   // Meta
   DicomDirMeta    *NewMeta();
   DicomDirMeta* GetMeta() { return MetaElems; };

   // Patients
   DicomDirPatient *NewPatient();
   void ClearPatient();

   DicomDirPatient *GetFirstPatient();
   DicomDirPatient *GetNextPatient();

   // 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 *method,
                           void *arg = NULL,
                           DicomDir::Method *argDelete = NULL );
   void SetProgressMethod( DicomDir::Method *method, 
                           void *arg = NULL,
                           DicomDir::Method *argDelete = NULL );
   void SetEndMethod(      DicomDir::Method *method,
                           void *arg = NULL, 
                           DicomDir::Method *argDelete = NULL );
   void SetStartMethodArgDelete( DicomDir::Method *m );
   void SetProgressMethodArgDelete( DicomDir::Method *m );
   void SetEndMethodArgDelete( DicomDir::Method *m );

   float GetProgress()  { return Progress; };
   void  AbortProgress() { Abort = true; };
   bool  IsAborted() { return Abort; };

   // Write
   bool WriteDicomDir(std::string const &fileName);

   typedef enum
   {
      GDCM_DICOMDIR_NONE,
      GDCM_DICOMDIR_META,
      GDCM_DICOMDIR_PATIENT,
      GDCM_DICOMDIR_STUDY,
      GDCM_DICOMDIR_SERIE,
      GDCM_DICOMDIR_IMAGE
   } DicomDirType;
   
protected:
   void CreateDicomDirChainedList(std::string const &path);
   void CallStartMethod();
   void CallProgressMethod();
   void CallEndMethod();

private:
   void Initialize();
   void CreateDicomDir();

   bool AddPatientToEnd(DicomDirPatient *dd);
   bool AddStudyToEnd  (DicomDirStudy *dd);
   bool AddSerieToEnd  (DicomDirSerie *dd);
   bool AddImageToEnd  (DicomDirImage *dd);

   void SetElements(std::string const &path, VectDocument const &list);
   void SetElement (std::string const &path, DicomDirType type,
                    Document *header);
   void MoveSQItem(DocEntrySet *dst,DocEntrySet *src);

   static bool HeaderLessThan(Document *header1, Document *header2);
   
// Variables

   DicomDirMeta* MetaElems;

   ListDicomDirPatient Patients;
   ListDicomDirPatient::iterator ItPatient;

   Method *StartMethod;
   Method *ProgressMethod;
   Method *EndMethod;
   Method *StartMethodArgDelete;
   Method* ProgressMethodArgDelete;
   Method *EndMethodArgDelete;
   void *StartArg;
   void *ProgressArg;
   void *EndArg;
   float Progress;
   bool Abort;
};
} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif

---