remove useless comments

[gdcm.git] / src / gdcmFileHelper.h

diff --git a/src/gdcmFileHelper.h b/src/gdcmFileHelper.h
index 4891f801b5a88e363af23249bd745cb247fd9676..a6bc806db74ecd6f645bd0dd2bfcf87abaae1dc2 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/02 16:18:48 $
-  Version:   $Revision: 1.8 $
+  Date:      $Date: 2005/02/09 16:28:41 $
+  Version:   $Revision: 1.12 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -53,7 +53,7 @@ public:
  
    virtual ~FileHelper();
 
-   void Print(std::ostream &os = std::cout, std::string const & indent = ""); 
+   void Print(std::ostream &os = std::cout, std::string const &indent = ""); 
 
    /// Accessor to \ref File
    File *GetFile() { return FileInternal; }
@@ -82,34 +82,49 @@ 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();
+   // RBG data (from file)
+   uint8_t *GetRGBData();
    size_t GetRGBDataSize();
-   // RAW data (from file
-   uint8_t* GetRawData();
+   // RAW data (from file)
+   uint8_t *GetRawData();
    size_t GetRawDataSize();
 
    // LUT
    uint8_t* GetLutRGBA();
 
    // Write mode
-   void SetWriteModeToRaw()          { SetWriteMode(WMODE_RAW); };
-   void SetWriteModeToRGB()          { SetWriteMode(WMODE_RGB); };
-   void SetWriteMode(FileMode mode)  { WriteMode = mode; };
-   FileMode GetWriteMode()           { return WriteMode; };
+
+   /// \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 write RGB image when possible
+   ///        (as opposite to 'Grey pixels + Palettes color')
+   void SetWriteModeToRGB()           { SetWriteMode(WMODE_RGB);  };
+   /// \brief Sets the Write Mode ( )
+   void SetWriteMode(FileMode mode)   { WriteMode = mode;         };
+   /// \brief Gets the Write Mode ( )
+   FileMode GetWriteMode()            { return WriteMode;         };
 
    // Write format
+
+   /// \brief Tells the writer we want to write as Implicit VR
    void SetWriteTypeToDcmImplVR()     { SetWriteType(ImplicitVR); };
+   /// \brief Tells the writer we want to write as Explicit VR
    void SetWriteTypeToDcmExplVR()     { SetWriteType(ExplicitVR); };
-   void SetWriteTypeToAcr()           { SetWriteType(ACR); };
+   /// \brief Tells the writer we want to write as ACR-NEMA
+   void SetWriteTypeToAcr()           { SetWriteType(ACR);        };
+   /// \brief Tells the writer we want to write as LibIDO
    void SetWriteTypeToAcrLibido()     { SetWriteType(ACR_LIBIDO); };
-   void SetWriteType(FileType format) { WriteType = format; };
-   FileType GetWriteType()            { return WriteType; };
+   /// \brief Tells the writer which format want to write
+   /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
+   void SetWriteType(FileType format) { WriteType = format;       };
+   /// \brief Gets the format we want to write
+   ///   (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
+   FileType GetWriteType()            { return WriteType;         };
 
    // Write pixels of ONE image on hard drive
-   // No test is made on processor "endianity"
+   // No test is made on processor "endianness"
    // The user must call his reader correctly
    bool WriteRawData  (std::string const &fileName);
    bool WriteDcmImplVR(std::string const &fileName);
@@ -133,8 +148,9 @@ protected:
    void SetWriteToNoLibido();
    void RestoreWriteOfLibido();
 
-   ValEntry *CopyValEntry(uint16_t group,uint16_t elem);
-   BinEntry *CopyBinEntry(uint16_t group,uint16_t elem);
+   ValEntry *CopyValEntry(uint16_t group, uint16_t elem);
+   BinEntry *CopyBinEntry(uint16_t group, uint16_t elem, 
+                          const std::string &vr);
 
 private:
    void Initialize();
@@ -153,15 +169,20 @@ private:
    /// Wether already parsed or not
    bool Parsed;
 
-   /// Utility pixel converter
+   // Utility pixel converter
+   /// \brief Pointer to the PixelReadConverter
    PixelReadConvert *PixelReadConverter;
+   /// \brief Pointer to the PixelWriteConverter
    PixelWriteConvert *PixelWriteConverter;
 
    // Utility header archive
+   /// \brief Pointer to the DocEntryArchive (used while writting process)
    DocEntryArchive *Archive;
 
    // Write variables
+   /// \brief (WMODE_RAW, WMODE_RGB)
    FileMode WriteMode;
+   /// \brief (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
    FileType WriteType;
 };
 } // end namespace gdcm