]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomDir.h
Fix mistypings
[gdcm.git] / src / gdcmDicomDir.h
index 40bf6100ed1d9079c92ddefbe5fc75a2273b8fc7..eb2ac4d7a38a5ac17ea6744353145470c14d9c48 100644 (file)
-// gdcmDicomDir.h
-//-----------------------------------------------------------------------------
-#ifndef GDCMDICOMDIR_H
-#define GDCMDICOMDIR_H
-
-#include "gdcmHeader.h"
-#include "gdcmCommon.h"
-#include "gdcmDicomDirPatient.h"
-#include "gdcmDicomDirMeta.h"
-#include "gdcmDicomDirElement.h"
+/*=========================================================================
+  
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDicomDir.h,v $
+  Language:  C++
+  Date:      $Date: 2007/09/17 12:16:02 $
+  Version:   $Revision: 1.82 $
+  
+  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 "gdcmDebug.h"
 
 #include <list>
 #include <vector>
 
+namespace GDCM_NAME_SPACE 
+{
 //-----------------------------------------------------------------------------
-typedef std::list<gdcmDicomDirPatient *>   ListDicomDirPatient;
-typedef std::vector<gdcmHeader *>  ListHeader;
+class DicomDirPatient;
+class DicomDirMeta;
+class DicomDirElement;
+class DicomDirStudy;
+class DicomDirSerie;
+class DicomDirVisit;
+class DicomDirImage;
+class DicomDirPrivate;
+class SQItem;
+
+typedef std::list<DicomDirPatient *> ListDicomDirPatient;
+typedef std::vector<Document *> VectDocument;
 
-typedef GDCM_EXPORT void(gdcmMethod)(void * = NULL);
 //-----------------------------------------------------------------------------
-
 /**
- * \ingroup gdcmDicomDir
- * \brief    gdcmDicomDir defines an object representing a DICOMDIR in memory.
+ * \brief   DicomDir defines an object representing a DICOMDIR in memory
+ *  as a tree-like structure :
  *
+ *        ->DicomDirPatient 
+ *           -> DicomDirStudy 
+ *           -> DicomDirVisit 
+ *              -> DicomDirSerie
+ *                 -> DicomDirImage
+ *                 -> DicomDirPrivate (for Siemens CSA non image)
  */
-class GDCM_EXPORT gdcmDicomDir: public gdcmDocument
+class GDCM_EXPORT DicomDir: public Document
 {
+   gdcmTypeMacro(DicomDir);
+
 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(void);
-
-   /**
-    * \ingroup gdcmDicomDir
-    * \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 gdcmDicomDir
-    * \brief   canonical Printer 
-    * \sa    SetPrintLevel
-  */     
-   virtual void Print(std::ostream &os = std::cout);
-
-// Informations contained in the parser
-   virtual bool IsReadable(void);
-
-/// \brief   returns a pointer to the gdcmDicomDirMeta for this DICOMDIR. 
-   inline gdcmDicomDirMeta   *GetDicomDirMeta()      
-      {return metaElems;};
-
- /// \brief   returns the PATIENT chained List for this DICOMDIR.    
-   inline ListDicomDirPatient &GetDicomDirPatients() 
-      {return patients;};
-
-// Parsing
-   void ParseDirectory(void);
+/// \brief Constructs a DicomDir with a RefCounter
+   static DicomDir *New() {return new DicomDir();}
+
+//   GDCM_LEGACY( bool Load(std::string const &filename) )
+   bool Load( );
+   void Print(std::ostream &os = std::cout, std::string const &indent = "" );
+
+   /// Sets the root Directory name to parse, recursively
+   void SetDirectoryName(std::string const &dirName)
+        { ParseDir = true; if (Filename != dirName)
+                               Filename = dirName, IsDocumentModified = true;}
+   /// Accessor to Filename
+   virtual void SetFileName(std::string const &fileName)
+                   { ParseDir = false; if (Filename != fileName)
+                              Filename = fileName, IsDocumentModified = true;}
+
+   // Informations contained in the parser
+   virtual bool IsReadable();
+
+   // Meta
+   DicomDirMeta *NewMeta();
+   /// Returns a pointer to the DicomDirMeta for this DICOMDIR. 
+   DicomDirMeta *GetMeta() { return MetaElems; }
+
+   // Patients
+   DicomDirPatient *NewPatient();
+   void ClearPatient();
+
+   DicomDirPatient *GetFirstPatient();
+   DicomDirPatient *GetNextPatient();
+   /// returns the number of Patients currently held in the gdcm::DicomDir
+   int              GetNumberOfPatients() { return Patients.size();}
    
-   void SetStartMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL);
-   void SetStartMethodArgDelete(gdcmMethod *);
-   void SetProgressMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL);
-   void SetProgressMethodArgDelete(gdcmMethod *);
-   void SetEndMethod(gdcmMethod *,void * =NULL,gdcmMethod * =NULL);
-   void SetEndMethodArgDelete(gdcmMethod *);
-
-/// \brief GetProgress GetProgress
-   inline float GetProgress(void)  
-      {return(progress);};
-
-/// \brief AbortProgress AbortProgress
-   inline void  AbortProgress(void)
-      {abort=true;      };
-
-/// \brief IsAborted IsAborted
-      inline bool  IsAborted(void)
-      {return(abort);   };
-   
-// Adding
-  gdcmDicomDirMeta *    NewMeta(void);
-  gdcmDicomDirPatient * NewPatient(void);
+   // Parsing
+   void ParseDirectory();
+
+   /// GetProgress GetProgress
+   float GetProgress() const { return Progress; }
+   /// AbortProgress AbortProgress
+   void  AbortProgress() { Abort = true; }
+   /// IsAborted IsAborted
+   bool  IsAborted() { return Abort; }
+
+   // Write
+   bool Write(std::string const &fileName);
+
+   bool Anonymize();
 
-// Write
-   void WriteEntries(FILE *_fp);   
-   bool Write(std::string fileName);
+   virtual void Copy(DocEntrySet *set);
 
-/// Types of the gdcmObject within the gdcmDicomDir
+   /// Types of the DicomDirObject within the DicomDir
    typedef enum
    {
       GDCM_DICOMDIR_NONE,
@@ -99,63 +116,49 @@ public:
       GDCM_DICOMDIR_PATIENT,
       GDCM_DICOMDIR_STUDY,
       GDCM_DICOMDIR_SERIE,
+      GDCM_DICOMDIR_VISIT,
       GDCM_DICOMDIR_IMAGE,
-   } gdcmDicomDirType;
-   
+      GDCM_DICOMDIR_PRIVATE
+   } DicomDirType;
+
 protected:
-   void CreateDicomDirChainedList(std::string path);
+   DicomDir();
+   ~DicomDir();
+//   GDCM_LEGACY( DicomDir(std::string const &filename, bool parseDir = false) )
 
-   void CallStartMethod(void);
-   void CallProgressMethod(void);
-   void CallEndMethod(void);
+   void CreateDicomDirChainedList(std::string const &path);
 
 private:
-   void CreateDicomDir(void);
-//   void AddObjectToEnd(gdcmDicomDirType type, gdcmSQItem *s);
-   void AddDicomDirMeta   ();
-   void AddDicomDirPatientToEnd(gdcmSQItem *s);
-   void AddDicomDirStudyToEnd  (gdcmSQItem *s);
-   void AddDicomDirSerieToEnd  (gdcmSQItem *s);
-   void AddDicomDirImageToEnd  (gdcmSQItem *s);
-
-   void SetElements(std::string &path,ListHeader &list);
-   void SetElement (std::string &path,gdcmDicomDirType type,gdcmHeader *header);
+   void Initialize();
+   void CreateDicomDir();
+   bool DoTheLoadingJob();
+   bool AddPatientToEnd(DicomDirPatient *dd);   
+   bool AddStudyToEnd  (DicomDirStudy   *dd);
+   bool AddSerieToEnd  (DicomDirSerie   *dd);
+   bool AddVisitToEnd  (DicomDirVisit   *dd);
+   bool AddImageToEnd  (DicomDirImage   *dd);
+   bool AddPrivateToEnd(DicomDirPrivate *dd);
    
-   void UpdateDirectoryRecordSequenceLength(void);
+   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);
 
-   static bool HeaderLessThan(gdcmHeader *header1,gdcmHeader *header2);
-   
 // Variables
 
-/// \brief pointer on *the* gdcmObject 'DicomDirMeta Elements'
-   gdcmDicomDirMeta *metaElems;
-
-/// \brief 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
-   gdcmMethod *endMethod;
-/// pointer to the ??? method for any progress bar   
-   gdcmMethod *startMethodArgDelete;
-/// pointer to the ??? method for any progress bar
-   gdcmMethod *progressMethodArgDelete;
-/// pointer to the ??? method for any progress bar
-   gdcmMethod *endMethodArgDelete;
-/// pointer to the ??? for any progress bar   
-   void *startArg;
-/// pointer to the ??? for any progress bar
-   void *progressArg;
-/// pointer to the ??? for any progress bar   
-   void *endArg;
-/// value of the ??? for any progress bar
-   float progress;
-/// value of the ??? for any progress bar   
-   bool abort;
-};
+   /// Pointer on *the* DicomDirObject 'DicomDirMeta Elements'
+   DicomDirMeta *MetaElems;
+
+   /// Chained list of DicomDirPatient (to be exploited hierarchicaly) 
+   ListDicomDirPatient Patients;
+   ListDicomDirPatient::iterator ItPatient;
 
+   /// value of the ??? for any progress bar   
+   bool ParseDir;
+
+};
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif