Add comments not to confuse unaware users any longer

[gdcm.git] / src / gdcmFileHelper.h

diff --git a/src/gdcmFileHelper.h b/src/gdcmFileHelper.h
index 18ab4bb9adc04d0c031ed024111de704f822783f..9056534e0feec536c973fda59562c48d1877ea10 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/02/04 14:49:01 $
-  Version:   $Revision: 1.10 $
+  Date:      $Date: 2005/03/09 09:45:33 $
+  Version:   $Revision: 1.16 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -82,13 +82,13 @@ public:
 
    // User data
    void SetUserData(uint8_t *data, size_t expectedSize);
-   uint8_t* GetUserData();
+   uint8_t *GetUserData();
    size_t GetUserDataSize();
    // RBG data (from file)
-   uint8_t* GetRGBData();
+   uint8_t *GetRGBData();
    size_t GetRGBDataSize();
    // RAW data (from file)
-   uint8_t* GetRawData();
+   uint8_t *GetRawData();
    size_t GetRawDataSize();
 
    // LUT
@@ -96,10 +96,11 @@ public:
 
    // Write mode
 
-   /// \brief Tells the writer we want to write a Raw File (no header)
-  void SetWriteModeToRaw()           { SetWriteMode(WMODE_RAW);  };
+   /// \brief Tells the writer we want to keep 'Grey pixels + Palettes color'
+   ///        when possible (as opposed to convert 'Palettes color' to RGB)
+  void SetWriteModeToRaw()            { SetWriteMode(WMODE_RAW);  };
    /// \brief Tells the writer we want to write RGB image when possible
-   ///        (as opposite to 'Grey pixels + Palettes color')
+   ///        (as opposed to 'Grey pixels + Palettes color')
    void SetWriteModeToRGB()           { SetWriteMode(WMODE_RGB);  };
    /// \brief Sets the Write Mode ( )
    void SetWriteMode(FileMode mode)   { WriteMode = mode;         };
@@ -116,10 +117,10 @@ public:
    void SetWriteTypeToAcr()           { SetWriteType(ACR);        };
    /// \brief Tells the writer we want to write as LibIDO
    void SetWriteTypeToAcrLibido()     { SetWriteType(ACR_LIBIDO); };
-   /// \brief Tells the writer which format want to write
+   /// \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 want to write
+   /// \brief Gets the format we talled the write we wanted to write
    ///   (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
    FileType GetWriteType()            { return WriteType;         };
 
@@ -149,7 +150,10 @@ protected:
    void RestoreWriteOfLibido();
 
    ValEntry *CopyValEntry(uint16_t group, uint16_t elem);
-   BinEntry *CopyBinEntry(uint16_t group, uint16_t elem);
+   BinEntry *CopyBinEntry(uint16_t group, uint16_t elem, 
+                          const std::string &vr);
+   void CheckMandatoryElements();
+   void RestoreWriteMandatory();
 
 private:
    void Initialize();
@@ -161,8 +165,8 @@ private:
    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.
+   ///  the constructor or passed to the constructor. 
+   ///  When false the destructor is in charge of deletion.
    bool SelfHeader;
    
    /// Wether already parsed or not