* src/*.h : add comments

[gdcm.git] / src / gdcmFile.h

diff --git a/src/gdcmFile.h b/src/gdcmFile.h
index 9d2f21855b024c4c1bc6bb7cb2a0cc696bf2174c..395f7ed45b6e415164303fd9c0595f721919dfdd 100644 (file)
--- a/src/gdcmFile.h
+++ b/src/gdcmFile.h
@@ -6,14 +6,17 @@
 #include "gdcmCommon.h"
 #include "gdcmHeader.h"
 
-////////////////////////////////////////////////////////////////////////////
-// In addition to Dicom header exploration, this class is designed
-// for accessing the image/volume content. One can also use it to
-// write Dicom files.
-
-class GDCM_EXPORT gdcmFile: public gdcmHeader
+/*
+ * In addition to Dicom header exploration, this class is designed
+ * for accessing the image/volume content. One can also use it to
+ * write Dicom files.
+ */
+class GDCM_EXPORT gdcmFile
 {
 private:
+   gdcmHeader *Header;   // Header to use to load the file
+   bool SelfHeader;
+
    void* PixelData;
    size_t lgrTotaleRaw;  // Area length to receive the pixels
    size_t lgrTotale;     // Area length to receive the RGB pixels
@@ -25,31 +28,36 @@ private:
    
    bool ReadPixelData(void * destination);
    
-   int gdcm_read_JPEG_file     (void * image_buffer); // For JPEG 8 Bits
-   int gdcm_read_JPEG_file12   (void * image_buffer); // For JPEG 12 Bits
-   int gdcm_read_JPEG2000_file (void * image_buffer); // For JPEG 2000 (TODO)
+   bool gdcm_read_JPEG_file     (FILE *fp,void * image_buffer); // For JPEG 8 Bits
+   bool gdcm_read_JPEG_file12   (FILE *fp,void * image_buffer); // For JPEG 12 Bits
+   bool gdcm_read_JPEG2000_file (FILE *fp,void * image_buffer); // For JPEG 2000 (TODO)
 
 // For Run Length Encoding (TOCHECK)
-   int gdcm_read_RLE_file      (void * image_buffer); 
+   bool gdcm_read_RLE_file      (FILE *fp,void * image_buffer); 
 
-     
 protected:
    int WriteBase(std::string FileName, FileType type);
+
 public:
+   gdcmFile(gdcmHeader *header);
    gdcmFile(std::string & filename);
    gdcmFile(const char * filename);
+   virtual ~gdcmFile(void);
        
+   gdcmHeader *GetHeader(void);
+
        // For promotion (performs a deepcopy of pointed header object)
        // TODO Swig gdcmFile(gdcmHeader* header);
        // TODO Swig ~gdcmFile();
 
        // On writing purposes. When instance was created through
        // gdcmFile(std::string filename) then the filename argument MUST be
-        // different from the constructor's one (no overwriting allowed).
+   // different from the constructor's one (no overwriting allowed).
        // TODO Swig int SetFileName(std::string filename);
 
    void   SetPixelDataSizeFromHeader(void);
    size_t GetImageDataSize();
+   size_t GetImageDataSizeRaw();
    void * GetImageData();
    size_t GetImageDataIntoVector(void* destination, size_t MaxSize);
    void * GetImageDataRaw();
@@ -63,7 +71,6 @@ public:
    int SetImageData     (void * Data, size_t ExpectedSize);
       // When the caller is aware we simply point to the data:
       // TODO int SetImageDataNoCopy (void * Data, size_t ExpectedSize);
-   void SetImageDataSize (size_t ExpectedSize);
        
        // Push to disk.
        // A NE PAS OUBLIER : que fait-on en cas de Transfert Syntax (dans l'entete)
@@ -73,7 +80,6 @@ public:
        // Ecrit sur disque les pixels d'UNE image
        // Aucun test n'est fait sur l'"Endiannerie" du processeur.
        // Ca sera à l'utilisateur d'appeler son Reader correctement
-               
    int WriteRawData  (std::string fileName);
    int WriteDcmImplVR(std::string fileName);
    int WriteDcmImplVR(const char * fileName);