]> Creatis software - gdcm.git/blobdiff - src/gdcmDocument.h
remove some now useless stuff
[gdcm.git] / src / gdcmDocument.h
index d032a38859e42591cb6dad1aec99268f7939b050..9dbd9af164d9841e3ebadb664881729a2e92826b 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.h,v $
   Language:  C++
-  Date:      $Date: 2005/07/17 04:28:55 $
-  Version:   $Revision: 1.117 $
+  Date:      $Date: 2006/02/09 10:48:05 $
+  Version:   $Revision: 1.139 $
  
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 #include "gdcmDict.h"
 #include "gdcmElementSet.h"
 #include "gdcmException.h"
+#include "gdcmDebug.h"  // for LEGACY
+#include "gdcmCommandManager.h"
 
 #include <map>
 #include <list>
 #include <fstream>
 
-#define NO_SEQ        0x00000001  // Don't load odd groups
-#define NO_SHADOW     0x00000002  // Don't load Sequences
-#define NO_SHADOWSEQ  0x00000004  // Don't load Sequences if they belong to odd group
-                                  // (*exclusive* from NO_SEQ and NO_SHADOW)
 namespace gdcm 
 {
-class ValEntry;
-class BinEntry;
 class SeqEntry;
 class Dict;
 
@@ -45,13 +41,15 @@ class Dict;
  */
 class GDCM_EXPORT Document : public ElementSet
 {
-public:
+   gdcmTypeMacro(Document);
 
-typedef std::list<Element> ListElements;
+public:
+   typedef std::list<DicomElement> ListElements;
 
 // Loading
    //Deprecated : use SetFileName() + Load()
-   virtual bool Load( std::string const &filename ); 
+   //GDCM_LEGACY(  virtual bool Load( std::string const &filename )  ); 
+   //virtual bool Load( std::string const &filename );
    virtual bool Load( ); 
 
 // Dictionaries
@@ -61,6 +59,7 @@ typedef std::list<Element> ListElements;
    bool SetShaDict(DictKey const &dictName);
 
 // Informations contained in the gdcm::Document
+   bool IsParsable();
    virtual bool IsReadable();
    bool IsDicomV3();
    bool IsPapyrus();
@@ -72,15 +71,6 @@ typedef std::list<Element> ListElements;
 // Swap code
    /// 'Swap code' accessor (see \ref SwapCode )
    int GetSwapCode() { return SwapCode; }
-   // System access (meaning endian related !?)
-   uint16_t SwapShort(uint16_t);
-   uint32_t SwapLong(uint32_t);
-   /// \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
@@ -94,18 +84,19 @@ typedef std::list<Element> ListElements;
    bool CloseFile();
    void WriteContent( std::ofstream *fp, FileType type );
 
-// Content entries
+// Data entries
    virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
-   virtual void LoadEntryBinArea(BinEntry *entry);
+   virtual void LoadEntryBinArea(DataEntry *entry);
 
-   void LoadDocEntrySafe(DocEntry *entry);
+   //void LoadDocEntrySafe(DocEntry *entry);
+   void AddForceLoadElement(uint16_t group, uint16_t elem);
  
 // Ordering of Documents
    bool operator<(Document &document);
 
 /**
  * \brief Sets the LoadMode as a boolean string. 
- *        NO_SEQ, NO_SHADOW, NO_SHADOWSEQ
+ *        LD_NOSEQ, LD_NOSHADOW, LD_NOSHADOWSEQ
  ... (nothing more, right now)
  *        WARNING : before using NO_SHADOW, be sure *all* your files
  *        contain accurate values in the 0x0000 element (if any) 
@@ -113,7 +104,7 @@ typedef std::list<Element> ListElements;
  * @param   mode Load mode to be used    
  */
    void SetLoadMode (int mode) { if (LoadMode != mode) 
-                                     LoadMode = mode, IsDocumentModified = true; }
+                                     LoadMode=mode, IsDocumentModified = true; }
 
 protected:
 // Methods
@@ -121,13 +112,18 @@ protected:
    // to instanciate from this class Document (only gdcm::File and
    // gdcm::DicomDir are meaningfull).
    Document();
-   Document( std::string const &filename );
    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);
-   int ComputeGroup0002Length( FileType filetype );
+   
+   /// \brief skips bytes inside the source file
+   void     SkipBytes(uint32_t nBytes) { Fp->seekg((long)nBytes, std::ios::cur);} 
+   int ComputeGroup0002Length( );
 
 // Variables
    /// Refering underlying filename.
@@ -165,8 +161,11 @@ protected:
    /// are NOT loaded.
    static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
 
-   /// List of elements to Anonymize
-   ListElements AnonymizeList;
+   /// User supplied list of elements to Anonymize
+   ListElements UserAnonymizeList;
+
+   /// User supplied list of elements to force Load
+   ListElements UserForceLoadList;
 
    /// \brief Bit string integer (each one considered as a boolean)
    ///        Bit 0 : Skip Sequences,    if possible
@@ -185,19 +184,28 @@ protected:
 private:
 // Methods
    void Initialize();
-   bool DoTheLoadingDocumentJob();
+   bool DoTheLoadingDocumentJob(); 
+     
+      // 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);}
+   
    // 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);
 
-   void LoadDocEntry         (DocEntry *e);
+   void LoadDocEntry         (DocEntry *e, bool forceLoad = false);
    void FindDocEntryLength   (DocEntry *e) throw ( FormatError );
    uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
-   std::string FindDocEntryVR();
-   bool CheckDocEntryVR      (VRKey k);
-
-   std::string GetDocEntryValue  (DocEntry *entry);
-   std::string GetDocEntryUnvalue(DocEntry *entry);
+   VRKey FindDocEntryVR();
+   bool CheckDocEntryVR      (const VRKey &k);
 
    void SkipDocEntry          (DocEntry *entry);
    void SkipToNextDocEntry    (DocEntry *entry);
@@ -214,8 +222,14 @@ private:
 
    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
@@ -227,7 +241,12 @@ private:
    /// this upper bound is fixed to 1024 bytes (which might look reasonable
    /// when one considers the definition of the various VR contents).
    uint32_t MaxSizeLoadEntry;
-   
+
+   /// \brief to allow any inner method to know current tag Group number 
+   uint16_t CurrentGroup;
+   /// \brief to allow any inner method to know current tag Element number 
+   uint16_t CurrentElem; 
+     
 //  uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
 //  void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
 //                                  DocEntrySet *set );