]> Creatis software - gdcm.git/blobdiff - src/gdcmDocument.h
BUG: map<>::mapped_type is not part of the STL. Should fix issue on VS* compiler
[gdcm.git] / src / gdcmDocument.h
index 09ca0c4a89e7d5251e3114cd3ac50d44e2e24277..31a030cee597607cd01b573da91645edfece10f5 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.h,v $
   Language:  C++
-  Date:      $Date: 2005/11/05 13:23:30 $
-  Version:   $Revision: 1.129 $
+  Date:      $Date: 2007/10/08 15:20:17 $
+  Version:   $Revision: 1.148 $
  
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
  
 =========================================================================*/
 
-#ifndef GDCMDOCUMENT_H
-#define GDCMDOCUMENT_H
+#ifndef _GDCMDOCUMENT_H_
+#define _GDCMDOCUMENT_H_
 
 #include "gdcmVR.h"
 #include "gdcmDict.h"
 #include "gdcmElementSet.h"
 #include "gdcmException.h"
+#include "gdcmDebug.h"  // for LEGACY
+#include "gdcmCommandManager.h"
 
 #include <map>
 #include <list>
 #include <fstream>
 
-namespace gdcm 
+namespace GDCM_NAME_SPACE 
 {
 class SeqEntry;
 class Dict;
@@ -46,7 +48,9 @@ public:
 
 // Loading
    //Deprecated : use SetFileName() + Load()
-   virtual bool Load( std::string const &filename ); 
+//#ifndef GDCM_LEGACY_REMOVE 
+//   virtual bool Load( std::string const &filename ); 
+//#endif
    virtual bool Load( ); 
 
 // Dictionaries
@@ -56,6 +60,7 @@ public:
    bool SetShaDict(DictKey const &dictName);
 
 // Informations contained in the gdcm::Document
+   bool IsParsable();
    virtual bool IsReadable();
    bool IsDicomV3();
    bool IsPapyrus();
@@ -65,36 +70,26 @@ public:
    std::string GetTransferSyntaxName();
 
 // Swap code
-   /// 'Swap code' accessor (see \ref SwapCode )
+   /// 'Swap code' accessor (see  SwapCode )
    int GetSwapCode() { return SwapCode; }
-   // System access (meaning endian related !?)
-   uint16_t SwapShort(uint16_t);
-   uint32_t SwapLong(uint32_t);
-   double SwapDouble(double);
-   /// \brief  Unswaps back the bytes of 2-bytes long integer 
-   ///         so they agree with the processor order.
-   uint16_t UnswapShort(uint16_t a) { return SwapShort(a);}
-   /// \brief  Unswaps back the bytes of 4-byte long integer 
-   ///         so they agree with the processor order.
-   uint32_t UnswapLong(uint32_t a) { return SwapLong(a);}
    
 // File I/O
-   /// Accessor to \ref Filename
+   /// Accessor to  Filename
    const std::string &GetFileName() const { return Filename; }
-   /// Accessor to \ref Filename
+   /// Accessor to  Filename
    virtual void SetFileName(std::string const &fileName) 
                    { if (Filename != fileName)
                         Filename = fileName, IsDocumentModified = true; }
 
    std::ifstream *OpenFile();
    bool CloseFile();
-   void WriteContent( std::ofstream *fp, FileType type );
+   void WriteContent( std::ofstream *fp, FileType type, bool insideMetaElements, bool insideSequence );
 
-// Content entries
+// Data entries
    virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
    virtual void LoadEntryBinArea(DataEntry *entry);
 
-   void LoadDocEntrySafe(DocEntry *entry);
+   void SetMaxSizeLoadEntry(long);
    void AddForceLoadElement(uint16_t group, uint16_t elem);
  
 // Ordering of Documents
@@ -119,10 +114,16 @@ protected:
    // gdcm::DicomDir are meaningfull).
    Document();
    virtual ~Document();
-   
+
+   virtual void CallStartMethod();
+   virtual void CallProgressMethod();
+   virtual void CallEndMethod();
+      
    uint16_t ReadInt16() throw ( FormatError );
    uint32_t ReadInt32() throw ( FormatError );
-   void     SkipBytes(uint32_t);
+   
+   /// \brief skips bytes inside the source file
+   void     SkipBytes(uint32_t nBytes) { Fp->seekg((long)nBytes, std::ios::cur);} 
    int ComputeGroup0002Length( );
 
 // Variables
@@ -185,9 +186,22 @@ private:
 // Methods
    void Initialize();
    bool DoTheLoadingDocumentJob();
+     
+      // System access (meaning endian related !?)
+   void ReadBegBuffer(size_t l) throw ( FormatError );
+   uint16_t SwapShort(uint16_t);
+   uint32_t SwapLong(uint32_t);
+   double SwapDouble(double);
+   /// \brief  Unswaps back the bytes of 2-bytes long integer 
+   ///         so they agree with the processor order.
+   uint16_t UnswapShort(uint16_t a) { return SwapShort(a);}
+   /// \brief  Unswaps back the bytes of 4-byte long integer 
+   ///         so they agree with the processor order.
+   uint32_t UnswapLong(uint32_t a) { return SwapLong(a);}
+   
    // Read
    void ParseDES(DocEntrySet *set, long offset, long l_max, bool delim_mode);
-   void ParseSQ (SeqEntry *seq,    long offset, long l_max, bool delim_mode);
+   bool ParseSQ (SeqEntry *seq,    long offset, long l_max, bool delim_mode);
 
    void LoadDocEntry         (DocEntry *e, bool forceLoad = false);
    void FindDocEntryLength   (DocEntry *e) throw ( FormatError );
@@ -203,16 +217,23 @@ private:
 
    bool CheckSwap();
    void SwitchByteSwapCode();
-   void SetMaxSizeLoadEntry(long);
 
    // DocEntry related utilities
    DocEntry *ReadNextDocEntry();
-
+   uint16_t GetInt16();
+   uint32_t GetInt32();
+   
    void HandleBrokenEndian  (uint16_t &group, uint16_t &elem);
    void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
    DocEntry *Backtrack(DocEntry *docEntry);
 
+
 // Variables
+protected:
+   /// value of the ??? for any progress bar
+   float Progress;
+   mutable bool Abort;
+   
    /// Public dictionary used to parse this header
    Dict *RefPubDict;
    /// \brief Optional "shadow dictionary" (private elements) used to parse
@@ -234,6 +255,17 @@ private:
 //  void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
 //                                  DocEntrySet *set );
 
+private:
+   /// \brief buffer to avoid some freads
+   char BegBuffer[8];
+   char *PtrBegBuffer;
+   /// \brief to avoid time consuming ftellg
+   size_t CurrentOffsetPosition;
+   /// \brief to indicate if last supposed to be UN DataElement is not
+   ///        (according to a private Dicom dictionary) 
+   bool changeFromUN;
+   /// \brief whether an unexpected EOF was encountered
+   bool UnexpectedEOF;
 };
 
 } // end namespace gdcm