First stage of name normalisation : gdcm::File replace by gdcm::FileHelper

[gdcm.git] / src / gdcmDocument.h

diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h
index 8d4425fa1b4f01f1eabee0f7e9738fd0f1c58e19..a1c445f729b2b9181e24eeffe3747cd556b13b2e 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 23:06:35 $
-  Version:   $Revision: 1.83 $
+  Date:      $Date: 2005/01/20 16:17:00 $
+  Version:   $Revision: 1.95 $
  
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -48,13 +48,11 @@ public:
    FileType GetFileType();
 
    std::string GetTransferSyntax();
-
-   bool IsDicomV3();
-
+ 
    RLEFramesInfo *GetRLEInfo() { return RLEInfo; }
    JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; }
 
-// Dictionnaries
+// Dictionaries
    virtual void PrintPubDict (std::ostream &os = std::cout);
    virtual void PrintShaDict (std::ostream &os = std::cout);
 
@@ -67,10 +65,10 @@ public:
    /// 'Swap code' accessor (see \ref SwapCode )
    int GetSwapCode() { return SwapCode; }
    // System access (meaning endian related !?)
-   uint16_t SwapShort(uint16_t);   // needed by File
-   uint32_t SwapLong(uint32_t);    // needed by File
-   uint16_t UnswapShort(uint16_t); // needed by File
-   uint32_t UnswapLong(uint32_t);  // needed by File
+   uint16_t SwapShort(uint16_t);   // needed by Document
+   uint32_t SwapLong(uint32_t);    // needed by Document
+   uint16_t UnswapShort(uint16_t); // needed by Document
+   uint32_t UnswapLong(uint32_t);  // needed by Document
    
 // Ordering of Documents
    bool operator<(Document &document);
@@ -88,10 +86,14 @@ public:
 
 // Content entries
 
+// Oops ! Python is gonna cry : 
+// 4 methods with same name and different parameters ...
+// Only C++ is aware!
+
    virtual bool SetEntry(std::string const &content,
-                         uint16_t group, uint16_t element);
+                         uint16_t group, uint16_t elem);
    virtual bool SetEntry(uint8_t *content, int lgth,
-                         uint16_t group, uint16_t element);
+                         uint16_t group, uint16_t elem);
    virtual bool SetEntry(std::string const &content, ValEntry *entry);
    virtual bool SetEntry(uint8_t *content, int lgth, BinEntry *entry);
 
@@ -101,10 +103,6 @@ public:
    virtual std::string GetEntryVR(uint16_t group, uint16_t elem);
    virtual int GetEntryLength(uint16_t group, uint16_t elem);
 
-   DocEntry *GetDocEntry(uint16_t group, uint16_t element); 
-   ValEntry *GetValEntry(uint16_t group, uint16_t element); 
-   BinEntry *GetBinEntry(uint16_t group, uint16_t element); 
-
    ValEntry *ReplaceOrCreate(std::string const &value,
                              uint16_t group, uint16_t elem,
                              TagName const &vr = GDCM_UNKNOWN);
@@ -115,16 +113,20 @@ public:
 
    bool ReplaceIfExist(std::string const &value,
                        uint16_t group, uint16_t elem );
+
+   bool CheckIfEntryExist(uint16_t group, uint16_t elem );
    
    virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
    virtual void LoadEntryBinArea(BinEntry *entry);
 
    void LoadDocEntrySafe(DocEntry *entry);
-   TagDocEntryHT *BuildFlatHashTable();
+   /*TagDocEntryHT *BuildFlatHashTable();*/
 
    /// Return the Transfer Syntax as a string
    std::string GetTransferSyntaxName();
 
+   bool IsDicomV3();
+
 protected:
 // Methods
    // Constructor and destructor are protected to forbid end user 
@@ -138,7 +140,6 @@ protected:
    void ComputeRLEInfo();
    void ComputeJPEGFragmentInfo();
    // Entry
-   bool CheckIfEntryExist(uint16_t group, uint16_t elem );
 
    int ComputeGroup0002Length( FileType filetype );
 
@@ -146,9 +147,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 known 'Bad Big Endian' and 'Bad Little Endian' codes
    int SwapCode;
 
    ///\brief whether we already parsed group 0002
@@ -172,9 +182,6 @@ protected:
 
    /// \brief Elements whose value is longer than  MAX_SIZE_PRINT_ELEMENT_VALUE
    /// are NOT printed.
-   /// \todo Currently not used since collides with #define in
-   ///       class DocEntry . See also
-   ///       method ref Document::SetMaxSizePrintEntry()
    static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
 
    /// Store the RLE frames info obtained during parsing of pixels.
@@ -211,7 +218,7 @@ private:
    bool     ReadTag(uint16_t, uint16_t);
    uint32_t ReadTagLength(uint16_t, uint16_t);
 
-   void Initialise();
+   void Initialize();
    bool CheckSwap();
    void SwitchByteSwapCode();
    void SetMaxSizeLoadEntry(long);
@@ -221,11 +228,11 @@ private:
    DocEntry *ReadNextDocEntry();
 
    uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
-   void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
-                                   DocEntrySet* set );
+/*   void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
+                                   DocEntrySet* set );*/
 
    void HandleBrokenEndian(uint16_t &group, uint16_t &elem);
-   void HandleOutOfGroup0002(uint16_t group);
+   void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
 
 // Variables
    /// Public dictionary used to parse this header
@@ -247,7 +254,7 @@ private:
    uint32_t MaxSizePrintEntry;   
 
 private:
-   friend class File;
+   friend class FileHelper;
 };
 } // end namespace gdcm