ENH: Try to sync gdcm CVS and gdcm 1.2. ~2000 lines of changes, please be gentle...

[gdcm.git] / src / gdcmPixelWriteConvert.h

diff --git a/src/gdcmPixelWriteConvert.h b/src/gdcmPixelWriteConvert.h
index 7239238ea96944be1934725adc4a7ce8af9b15b8..01c20c2ae68a241bdbccb0103c26b76f932ac1d0 100644 (file)
--- a/src/gdcmPixelWriteConvert.h
+++ b/src/gdcmPixelWriteConvert.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmPixelWriteConvert.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/11 15:15:38 $
-  Version:   $Revision: 1.6 $
+  Date:      $Date: 2006/02/16 20:06:15 $
+  Version:   $Revision: 1.8 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -27,28 +27,36 @@ namespace gdcm
 {
 /**
  * \brief Utility container for gathering the various forms the pixel data
- *        migth take during the user demanded processes.
+ *        migth take during the user requiered processes.
+ * \warning None of the methods may be called by end user (they have no
+ *          meaning outside the class FileHelper)
  */
 class GDCM_EXPORT PixelWriteConvert : public Base
 {
-public:
+friend class FileHelper;
+
+private:
    PixelWriteConvert();
    virtual ~PixelWriteConvert();
 
    // Set/Get of images and their size
-   void SetReadData(uint8_t *data,size_t size);
+   void SetReadData(uint8_t *data, size_t size);
+   /// \brief returns ReadData
    uint8_t *GetReadData() { return ReadData; }
+   /// \brief returns ReadDataSize
    size_t   GetReadDataSize() { return ReadDataSize; }
 
-   void SetUserData(uint8_t *data,size_t size);
+   /// \brief Set UserData
+   void SetUserData(uint8_t *data, size_t size);
+   /// \brief returns UserData
    uint8_t *GetUserData() { return UserData; }
+   /// \brief returns UserDataSize
    size_t   GetUserDataSize() { return UserDataSize; }
 
    // Get the used image and its size
    uint8_t *GetData();
    size_t   GetDataSize();
 
-private:
 // Variables
    /// Pixel data represented as RGB after LUT color interpretation.
    uint8_t *ReadData;