2005-01-13 Jean-Pierre Roux <jpr@creatis.univ-lyon1.fr>

[gdcm.git] / src / gdcmDocument.h

diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h
index 59fbb270abcb178775bd2ccd66696f295400530c..0a74dcf478119edf2ecf9499beae90015d364142 100644 (file)
--- a/src/gdcmDocument.h
+++ b/src/gdcmDocument.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/11 17:19:39 $
-  Version:   $Revision: 1.81 $
+  Date:      $Date: 2005/01/13 09:23:27 $
+  Version:   $Revision: 1.86 $
  
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -121,7 +121,10 @@ public:
 
    void LoadDocEntrySafe(DocEntry *entry);
    TagDocEntryHT *BuildFlatHashTable();
-      
+
+   /// Return the Transfer Syntax as a string
+   std::string GetTransferSyntaxName();
+
 protected:
 // Methods
    // Constructor and destructor are protected to forbid end user 
@@ -143,9 +146,18 @@ protected:
    /// Refering underlying filename.
    std::string Filename;
 
-   /// \brief SWap code (e.g. Big Endian, Little Endian, Bad Big Endian,
-   /// Bad Little Endian) according to the processor Endianity and
-   /// what is written on disc.
+   /// \brief Swap code gives an information on the byte order of a 
+   ///  supposed to be an int32, as it's read on disc 
+   /// (depending on the image Transfer Syntax *and* on the processor endianess)
+   /// as opposed as it should in memory to be dealt as an int32.
+   /// For instance :
+   /// - a 'Little Endian' image, read with a little endian processor
+   /// will have a SwapCode= 1234 (the order is OK; nothing to do)
+   /// - a 'Little Endian' image, read with a big endian procesor
+   /// will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be
+   /// swapped)
+   /// note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and
+   /// the well knowed 'Bad Big Endian' and 'Bad Little Endian' codes
    int SwapCode;
 
    ///\brief whether we already parsed group 0002
@@ -221,8 +233,8 @@ private:
    void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
                                    DocEntrySet* set );
 
-   void HandleBrokenEndian(uint16_t  group, uint16_t  elem);
-   void HandleOutOfGroup0002(uint16_t group);
+   void HandleBrokenEndian(uint16_t &group, uint16_t &elem);
+   void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
 
 // Variables
    /// Public dictionary used to parse this header