]> Creatis software - gdcm.git/blobdiff - src/gdcmFile.h
Coding Style + Doxygenation
[gdcm.git] / src / gdcmFile.h
index af9382efac99beb6e325683ae3bc0eb660075105..0f75b016bd9788250b156e917e5e22017b6ff6b2 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFile.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 08:46:21 $
-  Version:   $Revision: 1.90 $
+  Date:      $Date: 2005/01/06 20:03:27 $
+  Version:   $Revision: 1.91 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -47,27 +47,27 @@ public:
      
 public:
    File( );
-   File( Headerheader );
-   File( std::string constfilename );
+   File( Header *header );
+   File( std::string const &filename );
  
    virtual ~File();
 
    void Print(std::ostream &os = std::cout); 
 
    /// Accessor to \ref Header
-   HeaderGetHeader() { return HeaderInternal; }
+   Header *GetHeader() { return HeaderInternal; }
 
    size_t GetImageDataSize();
    size_t GetImageDataRawSize();
 
-   uint8_tGetImageData();
-   uint8_tGetImageDataRaw();
-   size_t GetImageDataIntoVector(voiddestination, size_t maxSize);
+   uint8_t *GetImageData();
+   uint8_t *GetImageDataRaw();
+   size_t GetImageDataIntoVector(void *destination, size_t maxSize);
 
-   void SetImageData(uint8_tdata, size_t expectedSize);
+   void SetImageData(uint8_t *data, size_t expectedSize);
 
    // User datas
-   void SetUserData(uint8_tdata, size_t expectedSize);
+   void SetUserData(uint8_t *data, size_t expectedSize);
    uint8_t* GetUserData();
    size_t GetUserDataSize();
    // RBG datas (from file
@@ -80,19 +80,19 @@ public:
    // 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 constfileName);
-   bool WriteDcmImplVR(std::string constfileName);
-   bool WriteDcmExplVR(std::string constfileName);
-   bool WriteAcr      (std::string constfileName);
-   bool Write(std::string const& fileName);
+   bool WriteRawData  (std::string const &fileName);
+   bool WriteDcmImplVR(std::string const &fileName);
+   bool WriteDcmExplVR(std::string const &fileName);
+   bool WriteAcr      (std::string const &fileName);
+   bool Write         (std::string const &fileName);
 
-   bool SetEntryByNumber(std::string constcontent,
+   bool SetEntryByNumber(std::string const &content,
                          uint16_t group, uint16_t element);
-   bool SetEntryByNumber(uint8_tcontent, int lgth,
+   bool SetEntryByNumber(uint8_t *content, int lgth,
                          uint16_t group, uint16_t element);
-   bool ReplaceOrCreateByNumber(std::string constcontent,
+   bool ReplaceOrCreateByNumber(std::string const &content,
                                 uint16_t group, uint16_t element);
-   bool ReplaceOrCreateByNumber(uint8_tbinArea, int lgth,
+   bool ReplaceOrCreateByNumber(uint8_t *binArea, int lgth,
                                 uint16_t group, uint16_t element);
 
    uint8_t* GetLutRGBA();
@@ -127,13 +127,13 @@ protected:
    void SetWriteToNoLibido();
    void RestoreWriteOfLibido();
 
-   ValEntryCopyValEntry(uint16_t group,uint16_t element);
-   BinEntryCopyBinEntry(uint16_t group,uint16_t element);
+   ValEntry *CopyValEntry(uint16_t group,uint16_t element);
+   BinEntry *CopyBinEntry(uint16_t group,uint16_t element);
 
 private:
    void Initialise();
 
-   uint8_tGetRaw();
+   uint8_t *GetRaw();
 
 // members variables:
    /// Header to use to load the file
@@ -148,8 +148,8 @@ private:
    bool Parsed;
 
    /// Utility pixel converter
-   PixelReadConvertPixelReadConverter;
-   PixelWriteConvertPixelWriteConverter;
+   PixelReadConvert *PixelReadConverter;
+   PixelWriteConvert *PixelWriteConverter;
 
    // Utility header archive
    DocEntryArchive *Archive;