* FIX: src/* fix the doxygen warnings.

[gdcm.git] / src / gdcmDocument.h

diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h
index 6b730260e576388e2eae7034af73b8f5c9b9a4f4..68126078783d7b8072efc1d33c08f939e2e89a28 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: 2004/10/18 12:49:22 $
-  Version:   $Revision: 1.52 $
+  Date:      $Date: 2004/11/16 10:25:53 $
+  Version:   $Revision: 1.60 $
  
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -36,9 +36,29 @@ class SeqEntry;
 
 #include <map>
 #include <list>
+#include <fstream>
+
 namespace gdcm 
 {
 
+enum TransferSyntaxType {
+  ImplicitVRLittleEndian = 0,
+  ExplicitVRLittleEndian,
+  DeflatedExplicitVRLittleEndian,
+  ExplicitVRBigEndian,
+  JPEGBaselineProcess1,
+  JPEGExtendedProcess2_4,
+  JPEGExtendedProcess3_5,
+  JPEGSpectralSelectionProcess6_8,
+  JPEGFullProgressionProcess10_12,
+  JPEGLosslessProcess14,
+  JPEGLosslessProcess14_1,
+  JPEG2000Lossless,
+  JPEG2000,
+  RLELossless,
+  UnknownTS
+};
+
 //-----------------------------------------------------------------------------
 /**
  * \brief Derived by both Header and DicomDir
@@ -75,7 +95,7 @@ protected:
    int SwapCode;
 
    /// File Pointer, opened during Header parsing.
-   FILE* Fp;
+   std::ifstream* Fp;
 
    /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
    FileType Filetype;  
@@ -117,45 +137,35 @@ public:
 
 // Informations contained in the parser
    virtual bool IsReadable();
-   bool IsGivenTransferSyntax(std::string const & syntaxToCheck);
-   bool IsImplicitVRLittleEndianTransferSyntax();
-   bool IsExplicitVRLittleEndianTransferSyntax();
-   bool IsDeflatedExplicitVRLittleEndianTransferSyntax();
-   bool IsExplicitVRBigEndianTransferSyntax();
-   bool IsRLELossLessTransferSyntax();
-   bool IsJPEGBaseLineProcess1TransferSyntax();
-   bool IsJPEGExtendedProcess2_4TransferSyntax();
-   bool IsJPEGExtendedProcess3_5TransferSyntax();
-   bool IsJPEGSpectralSelectionProcess6_8TransferSyntax();
+   TransferSyntaxType GetTransferSyntax();
    bool IsJPEGLossless();
    bool IsJPEG2000();
-   bool IsJPEGTransferSyntax();
-   bool IsEncapsulateTransferSyntax();
+   bool IsJPEG();
+   bool IsEncapsulate();
    bool IsDicomV3();
 
    FileType GetFileType();
 
-   FILE* OpenFile();
+   std::ifstream * OpenFile();
    bool CloseFile();
 
-   void Write( FILE* fp, FileType type );
+   void Write( std::ofstream* fp, FileType type );
 
    ValEntry* ReplaceOrCreateByNumber(std::string const & value,
-                                         uint16_t group, uint16_t elem,
-                                         std::string const & VR ="unkn");
+                                     uint16_t group, uint16_t elem,
+                                     TagName const & vr = "unkn");
    
    BinEntry* ReplaceOrCreateByNumber(uint8_t* binArea, int lgth,
-                                         uint16_t group, uint16_t elem,
-                                         std::string const & VR="unkn");
+                                     uint16_t group, uint16_t elem,
+                                     TagName const & vr = "unkn");
 
    SeqEntry* ReplaceOrCreateByNumber(uint16_t group, uint16_t elem);
 
    bool ReplaceIfExistByNumber ( std::string const & value,
-                                 uint16_t group,
-                                 uint16_t elem );
+                                 uint16_t group, uint16_t elem );
    
-   virtual void* LoadEntryBinArea(uint16_t group, uint16_t elem);
-   virtual void* LoadEntryBinArea(BinEntry* entry);
+   virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
+   virtual void LoadEntryBinArea(BinEntry* entry);
       
    // System access (meaning endian related !?)
    uint16_t SwapShort(uint16_t);   // needed by File
@@ -183,8 +193,8 @@ public:
    virtual std::string GetEntryVRByNumber(uint16_t group, uint16_t elem);
    virtual int     GetEntryLengthByNumber(uint16_t group, uint16_t elem);
 //protected:
-   virtual bool SetEntryByName  (std::string const & content, 
-                                 std::string const & tagName);
+   virtual bool SetEntryByName  ( std::string const & content, 
+                                  TagName const & tagName );
    virtual bool SetEntryByNumber(std::string const & content,
                                  uint16_t group, uint16_t element);
    virtual bool SetEntryByNumber(uint8_t* content, int lgth,
@@ -192,7 +202,7 @@ public:
    virtual bool SetEntryLengthByNumber(uint32_t length,
                                        uint16_t group, uint16_t element);
 
-   virtual size_t GetEntryOffsetByNumber (uint16_t group, uint16_t elem);
+   virtual size_t GetEntryOffsetByNumber(uint16_t group, uint16_t elem);
    virtual void* GetEntryBinAreaByNumber(uint16_t group, uint16_t elem);   
    virtual bool  SetEntryBinAreaByNumber(uint8_t* a, uint16_t group,
                                                    uint16_t elem);
@@ -201,7 +211,7 @@ public:
 
    // Header entry
    DocEntry* GetDocEntryByNumber(uint16_t group, uint16_t element); 
-   DocEntry* GetDocEntryByName  (std::string const & tagName);
+   DocEntry* GetDocEntryByName  (TagName const & tagName);
 
    ValEntry* GetValEntryByNumber(uint16_t group, uint16_t element); 
    //BinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element); 
@@ -251,14 +261,14 @@ private:
    void BuildFlatHashTableRecurse( TagDocEntryHT& builtHT,
                                    DocEntrySet* set );
 
-
+   void HandleBrokenEndian(uint16_t  group, uint16_t  elem);
 public:
 // Accessors:
    /// Accessor to \ref PrintLevel
    void SetPrintLevel(int level) { PrintLevel = level; }
 
    /// Accessor to \ref Filename
-   const std::string &GetFileName() { return Filename; }
+   const std::string &GetFileName() const { return Filename; }
 
    /// Accessor to \ref Filename
    void SetFileName(std::string const & fileName) { Filename = fileName; }
@@ -267,7 +277,7 @@ public:
    int GetSwapCode() { return SwapCode; }
    
    /// File pointer
-   FILE * GetFP() { return Fp; }
+   std::ifstream * GetFP() { return Fp; }
 
    bool operator<(Document &document);