]> Creatis software - gdcm.git/blobdiff - src/gdcmDocument.h
Move as private some methods, in order not to confuse the users
[gdcm.git] / src / gdcmDocument.h
index 840410516f3f7d41de19f17f22da3cc8e3b7ab57..e72c8bb5aad1b642f655c34376253d47989b6405 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.h,v $
   Language:  C++
-  Date:      $Date: 2005/04/26 16:18:23 $
-  Version:   $Revision: 1.109 $
+  Date:      $Date: 2005/11/14 14:23:44 $
+  Version:   $Revision: 1.130 $
  
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 #include <list>
 #include <fstream>
 
-#define NO_SEQ    0x0000001
-#define NO_SHADOW 0x00000002
-
 namespace gdcm 
 {
-class ValEntry;
-class BinEntry;
 class SeqEntry;
 class Dict;
 
@@ -44,12 +39,15 @@ class Dict;
  */
 class GDCM_EXPORT Document : public ElementSet
 {
-public:
+   gdcmTypeMacro(Document);
 
-typedef std::list<Element> ListElements;
+public:
+   typedef std::list<DicomElement> ListElements;
 
 // Loading
-   virtual void Load( std::string const &filename ); 
+   //Deprecated : use SetFileName() + Load()
+   virtual bool Load( std::string const &filename ); 
+   virtual bool Load( ); 
 
 // Dictionaries
    Dict *GetPubDict();
@@ -69,21 +67,14 @@ 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
    const std::string &GetFileName() const { return Filename; }
    /// Accessor to \ref Filename
-   void SetFileName(std::string const &fileName) { Filename = fileName; }
+   virtual void SetFileName(std::string const &fileName) 
+                   { if (Filename != fileName)
+                        Filename = fileName, IsDocumentModified = true; }
 
    std::ifstream *OpenFile();
    bool CloseFile();
@@ -91,16 +82,25 @@ typedef std::list<Element> ListElements;
 
 // Content 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 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, ... (nothing more, right now)
-   void SetLoadMode (int mode) { LoadMode = mode; }
+/**
+ * \brief Sets the LoadMode as a boolean string. 
+ *        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) 
+ *        of *each* Shadow Group. The parser will fail if the size is wrong !
+ * @param   mode Load mode to be used    
+ */
+   void SetLoadMode (int mode) { if (LoadMode != mode) 
+                                     LoadMode=mode, IsDocumentModified = true; }
 
 protected:
 // Methods
@@ -108,13 +108,12 @@ protected:
    // to instanciate from this class Document (only gdcm::File and
    // gdcm::DicomDir are meaningfull).
    Document();
-   Document( std::string const &filename );
    virtual ~Document();
    
    uint16_t ReadInt16() throw ( FormatError );
    uint32_t ReadInt32() throw ( FormatError );
    void     SkipBytes(uint32_t);
-   int ComputeGroup0002Length( FileType filetype );
+   int ComputeGroup0002Length( );
 
 // Variables
    /// Refering underlying filename.
@@ -152,36 +151,51 @@ 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
    ///        Bit 1 : Skip Shadow Groups if possible
-   ///        Some more to add
+   ///        Probabely, some more to add
    int LoadMode;
    
-   /// Whether the gdcm::Document is already parsed/loaded
-   /// False from the creation of the gdcm::Document untill 
+   /// \brief Whether the gdcm::Document is already parsed/loaded :
+   /// False from the creation of the gdcm::Document untill 
    ///   gdcm::Document:Load()
-   bool IsDocumentAlreadyLoaded;
+   bool IsDocumentAlreadyLoaded; // FIXME : probabely useless now
+
+   /// Whether the gdcm::Document was modified since the last Load()
+   bool IsDocumentModified;
 
 private:
 // Methods
    void Initialize();
-
+   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);
@@ -198,6 +212,7 @@ private:
 
    void HandleBrokenEndian  (uint16_t &group, uint16_t &elem);
    void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
+   DocEntry *Backtrack(DocEntry *docEntry);
 
 // Variables
    /// Public dictionary used to parse this header
@@ -211,7 +226,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 );