* Improvement #2 : the CommandManager is now a static class so,

[gdcm.git] / src / gdcmFileHelper.h

diff --git a/src/gdcmFileHelper.h b/src/gdcmFileHelper.h
index 9c7e2d659b63e0189c2518d6e3bc049cbc7562d7..b5f50adc5c939dc8434aa0b92c4f85087b0d2fab 100644 (file)
--- a/src/gdcmFileHelper.h
+++ b/src/gdcmFileHelper.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFileHelper.h,v $
   Language:  C++
-  Date:      $Date: 2005/10/18 18:39:49 $
-  Version:   $Revision: 1.25 $
+  Date:      $Date: 2005/11/28 16:31:23 $
+  Version:   $Revision: 1.35 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -20,7 +20,7 @@
 #define GDCMFILEHELPER_H
 
 #include "gdcmDebug.h"
-#include "gdcmBase.h"
+#include "gdcmRefCounter.h"
 
 
 namespace gdcm 
@@ -40,8 +40,10 @@ typedef void (*VOID_FUNCTION_PUINT8_PFILE_POINTER)(uint8_t *, File *);
  * for accessing the image/volume content. One can also use it to
  * write Dicom/ACR-NEMA/RAW files.
  */
-class GDCM_EXPORT FileHelper : public Base
+class GDCM_EXPORT FileHelper : public RefCounter
 {
+   gdcmTypeMacro(FileHelper);
+
 public:
    enum FileMode
    {
@@ -50,12 +52,11 @@ public:
    };
      
 public:
-   FileHelper( );
-   FileHelper( File *header );
-   GDCM_LEGACY(FileHelper( std::string const &filename ));
+/// \brief Constructs a FileHelper with a RefCounter
+   static FileHelper *New() {return new FileHelper();}
+/// \brief Constructs a FileHelper with a RefCounter from a fileHelper  
+   static FileHelper *New(File *header) {return new FileHelper(header);}
    
-   virtual ~FileHelper();
-
    void Print(std::ostream &os = std::cout, std::string const &indent = ""); 
 
    /// Accessor to \ref File
@@ -65,7 +66,7 @@ public:
    void SetLoadMode(int loadMode);
    void SetFileName(std::string const &fileName);
    bool Load();
-   /// to allow user to modify pixel order (e.g. Mirror, TopDown,...)
+   /// to allow user to modify pixel order (e.g. Mirror, UpsideDown,...)
    void SetUserFunction( VOID_FUNCTION_PUINT8_PFILE_POINTER userFunc ) 
                         { UserFunction = userFunc; }   
    // File methods
@@ -130,12 +131,13 @@ public:
    void SetWriteTypeToAcr()           { SetWriteType(ACR);        }
    /// \brief Tells the writer we want to write as LibIDO
    void SetWriteTypeToAcrLibido()     { SetWriteType(ACR_LIBIDO); }
-   void SetWriteTypeToJPEG()     { SetWriteType(JPEG); }
+   /// \brief Tells the writer we want to write as JPEG   
+   void SetWriteTypeToJPEG()          { SetWriteType(JPEG);       }
    /// \brief Tells the writer which format we want to write
    /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
    void SetWriteType(FileType format) { WriteType = format;       }
    /// \brief Gets the format we talled the write we wanted to write
-   ///   (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
+   /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
    FileType GetWriteType()            { return WriteType;         }
 
    // Write pixels of ONE image on hard drive
@@ -146,8 +148,18 @@ public:
    bool WriteDcmExplVR(std::string const &fileName);
    bool WriteAcr      (std::string const &fileName);
    bool Write         (std::string const &fileName);
-
+   /// \brief if user knows he didn't modify the pixels (e.g. he just anonymized 
+   ///        the file), he is allowed to ask to keep the original
+   ///        'Media Storage SOP Class UID' and 'Image Type'   
+   void SetKeepMediaStorageSOPClassUID (bool v) 
+                              { KeepMediaStorageSOPClassUID = v; }
+   // no GetKeepMediaStorageSOPClassUID() method, on purpose!
+   
 protected:
+   FileHelper( );
+   FileHelper( File *header );
+   ~FileHelper();
+
    bool CheckWriteIntegrity();
 
    void SetWriteToRaw();
@@ -155,6 +167,7 @@ protected:
    void RestoreWrite();
 
    void SetWriteFileTypeToACR();
+   void SetWriteFileTypeToJPEG();
    void SetWriteFileTypeToExplicitVR();
    void SetWriteFileTypeToImplicitVR();
    void RestoreWriteFileType();
@@ -166,9 +179,9 @@ protected:
    DataEntry *CopyDataEntry(uint16_t group, uint16_t elem, 
                                const TagName &vr = GDCM_VRUNKNOWN);
    void CheckMandatoryElements();
-   void CheckMandatoryEntry(uint16_t group,uint16_t elem,std::string value);
-   void SetMandatoryEntry(uint16_t group,uint16_t elem,std::string value);
-   void CopyMandatoryEntry(uint16_t group,uint16_t elem,std::string value);
+   void CheckMandatoryEntry(uint16_t group, uint16_t elem, std::string value);
+   void SetMandatoryEntry(uint16_t group, uint16_t elem, std::string value);
+   void CopyMandatoryEntry(uint16_t group, uint16_t elem, std::string value);
    void RestoreWriteMandatory();
 
 private:
@@ -180,11 +193,6 @@ private:
    /// gdcm::File to use to load the file
    File *FileInternal;
 
-   /// \brief Whether the underlying \ref gdcm::File was loaded by
-   ///  the constructor or passed to the constructor. 
-   ///  When false the destructor is in charge of deletion.
-   bool SelfHeader;
-   
    /// Whether already parsed or not
    bool Parsed;
 
@@ -201,15 +209,22 @@ private:
    // Write variables
    /// \brief (WMODE_RAW, WMODE_RGB)
    FileMode WriteMode;
+   
    /// \brief (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
    FileType WriteType;
-   /// Pointer to a user supplied function to allow modification of pixel order
-   /// (i.e. : Mirror, TopDown, 90°Rotation, ...)
+   
+   /// \brief Pointer to a user supplied function to allow modification 
+   /// of pixel order (e.g. : Mirror, UpsideDown, 90°Rotation, ...)
    /// use as : void userSuppliedFunction(uint8_t *im, gdcm::File *f)
    /// NB : the "uint8_t *" type of first param is just for prototyping.
    /// User will Cast it according what he founds with f->GetPixelType()
    /// See vtkgdcmSerieViewer for an example
    VOID_FUNCTION_PUINT8_PFILE_POINTER UserFunction;
+   
+   /// \brief if user knows he didn't modify the pixels (e.g. he just 
+   /// anonymized the file), he is allowed to ask to keep the original
+   /// 'Media Storage SOP Class UID' and 'Image Type'  
+   bool KeepMediaStorageSOPClassUID;
 };
 } // end namespace gdcm