Some modif in comments; doxygen, etc

[gdcm.git] / src / gdcmFile.h

diff --git a/src/gdcmFile.h b/src/gdcmFile.h
index 395f7ed45b6e415164303fd9c0595f721919dfdd..dcf6f7046c794bede47eda7107b1bb39747efcb2 100644 (file)
--- a/src/gdcmFile.h
+++ b/src/gdcmFile.h
@@ -1,11 +1,12 @@
 // gdcmFile.h
-
+//-----------------------------------------------------------------------------
 #ifndef GDCMFILE_H
 #define GDCMFILE_H
 
 #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
@@ -13,31 +14,6 @@
  */
 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
-                         // from Grey Plane + Palette Color
-
-   int Parsed;               // weather already parsed
-   std::string OrigFileName; // To avoid file overwrite
-   void SwapZone(void* im, int swap, int lgr, int nb);
-   
-   bool ReadPixelData(void * destination);
-   
-   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)
-   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);
@@ -52,12 +28,13 @@ public:
 
        // 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();
@@ -68,7 +45,9 @@ public:
       // the caller might destroy it's image (without knowing it: think
       // of a complicated interface where display is done with a library
       // e.g. VTK) before calling the Write
-   int SetImageData     (void * Data, size_t ExpectedSize);
+      
+   // voir gdcmHeader::SetImageDataSize ?!?         
+   bool 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);
        
@@ -77,16 +56,50 @@ public:
        // incohérente avec l'ordre des octets en mémoire ? 
        // TODO Swig int Write();
        
-       // 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);
-   int WriteDcmExplVR(std::string fileName);
-   int WriteAcr      (std::string fileName);
-   
+   // Write pixels of ONE image on hard drive
+   // No test is made on processor "endianity"
+   // The user must call his reader correctly
+   bool WriteRawData  (std::string fileName);
+   bool WriteDcmImplVR(std::string fileName);
+   bool WriteDcmImplVR(const char * fileName);
+   bool WriteDcmExplVR(std::string fileName);
+   bool WriteAcr      (std::string fileName);
+ 
+   // Body in file gdcmParse.cxx
    bool ParsePixelData(void);
+     
+protected:
+   bool WriteBase(std::string FileName, FileType type);
+
+private:
+   void SwapZone(void* im, int swap, int lgr, int nb);
+   
+   bool ReadPixelData(void * destination);
+   
+   // For JPEG 8 Bits, body in file gdcmJpeg.cxx
+   bool gdcm_read_JPEG_file     (FILE *fp,void * image_buffer); 
+   static int gdcm_read_RLE_fragment(char **areaToRead, long lengthToDecode, 
+                                     long uncompressedSegmentSize,FILE *fp);
+   // For JPEG 12 Bits, body in file gdcmJpeg12.cxx
+   bool gdcm_read_JPEG_file12   (FILE *fp,void * image_buffer);
+   // For JPEG 2000, body in file gdcmJpeg2000.cxx
+   bool gdcm_read_JPEG2000_file (FILE *fp,void * image_buffer);
+
+   // For Run Length Encoding (TOCHECK)
+   bool gdcm_read_RLE_file      (FILE *fp,void * image_buffer); 
+
+// Variables
+   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
+                         // from Grey Plane + Palette Color
+
+   int Parsed;               // weather already parsed
+   std::string OrigFileName; // To avoid file overwrite
 };
 
+//-----------------------------------------------------------------------------
 #endif