Doxygenation

[gdcm.git] / src / gdcmFile.h

diff --git a/src/gdcmFile.h b/src/gdcmFile.h
index c9bb596e3170cc4658e8ac2f4ca12b28c5d3cff3..af9382efac99beb6e325683ae3bc0eb660075105 100644 (file)
--- a/src/gdcmFile.h
+++ b/src/gdcmFile.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFile.h,v $
   Language:  C++
-  Date:      $Date: 2004/12/03 11:55:38 $
-  Version:   $Revision: 1.81 $
+  Date:      $Date: 2005/01/06 08:46:21 $
+  Version:   $Revision: 1.90 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -19,42 +19,41 @@
 #ifndef GDCMFILE_H
 #define GDCMFILE_H
 
-#include "gdcmCommon.h"
-#include "gdcmHeader.h"
-#include "gdcmPixelReadConvert.h"
-#include "gdcmPixelWriteConvert.h"
-#include "gdcmDocEntryArchive.h"
+#include <iostream>
+#include "gdcmBase.h"
 
 namespace gdcm 
 {
+class Header;
+class ValEntry;
+class BinEntry;
+class PixelReadConvert;
+class PixelWriteConvert;
+class DocEntryArchive;
 //-----------------------------------------------------------------------------
 /*
  * In addition to Dicom header exploration, this class is designed
  * for accessing the image/volume content. One can also use it to
  * write Dicom/ACR-NEMA/RAW files.
  */
-class GDCM_EXPORT File
+class GDCM_EXPORT File : public Base
 {
 public:
-   enum TWriteMode
+   enum FileMode
    {
-      WMODE_DECOMPRESSED,
+      WMODE_RAW,
       WMODE_RGB
    };
      
-   enum TWriteType
-   {
-      WTYPE_IMPL_VR,
-      WTYPE_EXPL_VR,
-      WTYPE_ACR
-   };
-     
 public:
+   File( );
    File( Header* header );
    File( std::string const& filename );
  
    virtual ~File();
 
+   void Print(std::ostream &os = std::cout); 
+
    /// Accessor to \ref Header
    Header* GetHeader() { return HeaderInternal; }
 
@@ -65,7 +64,18 @@ public:
    uint8_t* GetImageDataRaw();
    size_t GetImageDataIntoVector(void* destination, size_t maxSize);
 
-   bool SetImageData (uint8_t* data, size_t expectedSize);
+   void SetImageData(uint8_t* data, size_t expectedSize);
+
+   // User datas
+   void SetUserData(uint8_t* data, size_t expectedSize);
+   uint8_t* GetUserData();
+   size_t GetUserDataSize();
+   // RBG datas (from file
+   uint8_t* GetRGBData();
+   size_t GetRGBDataSize();
+   // RAW datas (from file
+   uint8_t* GetRawData();
+   size_t GetRawDataSize();
 
    // Write pixels of ONE image on hard drive
    // No test is made on processor "endianity"
@@ -76,32 +86,35 @@ public:
    bool WriteAcr      (std::string const& fileName);
    bool Write(std::string const& fileName);
 
-   virtual bool SetEntryByNumber(std::string const& content,
-                                 uint16_t group, uint16_t element)
-   { 
-      HeaderInternal->SetEntryByNumber(content,group,element);
-      return true;
-   }
+   bool SetEntryByNumber(std::string const& content,
+                         uint16_t group, uint16_t element);
+   bool SetEntryByNumber(uint8_t* content, int lgth,
+                         uint16_t group, uint16_t element);
+   bool ReplaceOrCreateByNumber(std::string const& content,
+                                uint16_t group, uint16_t element);
+   bool ReplaceOrCreateByNumber(uint8_t* binArea, int lgth,
+                                uint16_t group, uint16_t element);
+
    uint8_t* GetLutRGBA();
 
    // Write mode
-   void SetWriteModeToDecompressed()    { SetWriteMode(WMODE_DECOMPRESSED); };
-   void SetWriteModeToRGB()             { SetWriteMode(WMODE_RGB); };
-   void SetWriteMode(unsigned int mode) { WriteMode = mode; };
-   unsigned int GetWriteMode()          { return WriteMode; };
+   void SetWriteModeToRaw() { SetWriteMode(WMODE_RAW); };
+   void SetWriteModeToRGB()          { SetWriteMode(WMODE_RGB); };
+   void SetWriteMode(FileMode mode)  { WriteMode = mode; };
+   FileMode GetWriteMode()           { return WriteMode; };
 
    // Write format
-   void SetWriteTypeToDcmImplVR()         { SetWriteType(WTYPE_EXPL_VR); };
-   void SetWriteTypeToDcmExplVR()         { SetWriteType(WTYPE_EXPL_VR); };
-   void SetWriteTypeToAcr()               { SetWriteType(WTYPE_ACR); };
-   void SetWriteType(unsigned int format) { WriteType = format; };
-   unsigned int GetWriteType()            { return WriteType; };
+   void SetWriteTypeToDcmImplVR()     { SetWriteType(ImplicitVR); };
+   void SetWriteTypeToDcmExplVR()     { SetWriteType(ExplicitVR); };
+   void SetWriteTypeToAcr()           { SetWriteType(ACR); };
+   void SetWriteTypeToAcrLibido()     { SetWriteType(ACR_LIBIDO); };
+   void SetWriteType(FileType format) { WriteType = format; };
+   FileType GetWriteType()            { return WriteType; };
 
 protected:
-   bool WriteBase(std::string const& fileName, FileType type);
    bool CheckWriteIntegrity();
 
-   void SetWriteToDecompressed();
+   void SetWriteToRaw();
    void SetWriteToRGB();
    void RestoreWrite();
 
@@ -120,12 +133,9 @@ protected:
 private:
    void Initialise();
 
-   uint8_t* GetDecompressed();
-   int ComputeDecompressedPixelDataSizeFromHeader();
+   uint8_t* GetRaw();
 
-private:
 // members variables:
-
    /// Header to use to load the file
    Header *HeaderInternal;
 
@@ -145,8 +155,8 @@ private:
    DocEntryArchive *Archive;
 
    // Write variables
-   unsigned int WriteMode;
-   unsigned int WriteType;
+   FileMode WriteMode;
+   FileType WriteType;
 };
 } // end namespace gdcm