]> Creatis software - gdcm.git/blobdiff - src/gdcmDocument.h
Add warning about Load Mode
[gdcm.git] / src / gdcmDocument.h
index 45388b1aeb1a6e75b3ffc605e7025a067a518d78..00a74ffc4bc499b58a17520f9ee8c563d3010f49 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/26 17:17:31 $
-  Version:   $Revision: 1.102 $
+  Date:      $Date: 2005/06/02 13:42:18 $
+  Version:   $Revision: 1.111 $
  
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -28,6 +28,9 @@
 #include <list>
 #include <fstream>
 
+#define NO_SEQ    0x0000001
+#define NO_SHADOW 0x00000002
+
 namespace gdcm 
 {
 class ValEntry;
@@ -42,34 +45,40 @@ class Dict;
 class GDCM_EXPORT Document : public ElementSet
 {
 public:
-// Informations contained in the gdcm::Document
-   virtual bool IsReadable();
-   FileType GetFileType();
 
-   std::string GetTransferSyntax();
+typedef std::list<Element> ListElements;
 
-// Dictionaries
-   virtual void PrintPubDict (std::ostream &os = std::cout);
-   virtual void PrintShaDict (std::ostream &os = std::cout);
+// Loading
+   virtual bool Load( std::string const &filename ); 
 
-   Dict* GetPubDict();
-   Dict* GetShaDict();
-   bool SetShaDict(Dict* dict);
+// Dictionaries
+   Dict *GetPubDict();
+   Dict *GetShaDict();
+   bool SetShaDict(Dict *dict);
    bool SetShaDict(DictKey const &dictName);
 
+// Informations contained in the gdcm::Document
+   virtual bool IsReadable();
+   bool IsDicomV3();
+   bool IsPapyrus();
+   FileType GetFileType();
+   std::string GetTransferSyntax();
+   /// Return the Transfer Syntax as a string
+   std::string GetTransferSyntaxName();
+
 // Swap code
    /// 'Swap code' accessor (see \ref SwapCode )
    int GetSwapCode() { return SwapCode; }
    // System access (meaning endian related !?)
-   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
+   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);}
    
-// Ordering of Documents
-   bool operator<(Document &document);
-
-public:
 // File I/O
    /// Accessor to \ref Filename
    const std::string &GetFileName() const { return Filename; }
@@ -81,17 +90,23 @@ public:
    void WriteContent( std::ofstream *fp, FileType type );
 
 // Content entries
-
    virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
    virtual void LoadEntryBinArea(BinEntry *entry);
 
    void LoadDocEntrySafe(DocEntry *entry);
+// Ordering of Documents
+   bool operator<(Document &document);
 
-   /// Return the Transfer Syntax as a string
-   std::string GetTransferSyntaxName();
-
-   bool IsDicomV3();
-   bool IsPapyrus();
+/**
+ * \brief \brief Sets the LoadMode as a boolean string. 
+ *        NO_SEQ, NO_SHADOW, ... (nothing more, right now)
+ *        WARNING : before using NO_SHADOW, be sure *all* your files
+ *        contain accurate values in the 0x0000 element 
+ *        of each Shadow Group. The paser will fail if the size is wrong !
+ * @param   mode Load mode to be used    
+ */
+   void SetLoadMode (int mode) { LoadMode = mode; }
 
 protected:
 // Methods
@@ -105,7 +120,6 @@ protected:
    uint16_t ReadInt16() throw ( FormatError );
    uint32_t ReadInt32() throw ( FormatError );
    void     SkipBytes(uint32_t);
-
    int ComputeGroup0002Length( FileType filetype );
 
 // Variables
@@ -143,15 +157,28 @@ protected:
    /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
    /// are NOT loaded.
    static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
-   /// \brief Elements whose value is longer than  MAX_SIZE_PRINT_ELEMENT_VALUE
-   /// are NOT printed.
-   static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
+
+   /// List of elements to Anonymize
+   ListElements AnonymizeList;
+
+   /// \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
+   int LoadMode;
+   
+   /// Whether the gdcm::Document is already parsed/loaded
+   /// - False from the creation of the gdcm::Document untill 
+   ///   gdcm::Document:Load()
+   bool IsDocumentAlreadyLoaded;
 
 private:
 // Methods
+   void Initialize();
+
    // 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 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 FindDocEntryLength   (DocEntry *e) throw ( FormatError );
@@ -162,18 +189,15 @@ private:
    std::string GetDocEntryValue  (DocEntry *entry);
    std::string GetDocEntryUnvalue(DocEntry *entry);
 
-
    void SkipDocEntry          (DocEntry *entry);
    void SkipToNextDocEntry    (DocEntry *entry);
 
-   void FixDocEntryFoundLength(DocEntry *entry,uint32_t l);
+   void FixDocEntryFoundLength(DocEntry *entry, uint32_t l);
    bool IsDocEntryAnInteger   (DocEntry *entry);
 
-   void Initialize();
    bool CheckSwap();
    void SwitchByteSwapCode();
    void SetMaxSizeLoadEntry(long);
-   void SetMaxSizePrintEntry(long);
 
    // DocEntry related utilities
    DocEntry *ReadNextDocEntry();
@@ -194,14 +218,10 @@ private:
    /// when one considers the definition of the various VR contents).
    uint32_t MaxSizeLoadEntry;
    
-   /// \brief Size threshold above which an element value will NOT be *printed*
-   /// in order no to polute the screen output. By default, this upper bound
-   /// is fixed to 64 bytes.
-   uint32_t MaxSizePrintEntry;   
-
 //  uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
 //  void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
-//                                   DocEntrySet *set );
+//                                  DocEntrySet *set );
+
 };
 
 } // end namespace gdcm