Program: gdcm
Module: $RCSfile: gdcmDocument.h,v $
Language: C++
- Date: $Date: 2005/02/06 14:39:35 $
- Version: $Revision: 1.105 $
+ Date: $Date: 2005/11/21 16:28:06 $
+ Version: $Revision: 1.136 $
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 "gdcmCommon.h"
+#include "gdcmDebug.h" // for LEGACY
#include <map>
#include <list>
namespace gdcm
{
-class ValEntry;
-class BinEntry;
class SeqEntry;
class Dict;
*/
class GDCM_EXPORT Document : public ElementSet
{
+ gdcmTypeMacro(Document);
+
public:
+ typedef std::list<DicomElement> ListElements;
-typedef std::list<Element> ListElements;
+// Loading
+ //Deprecated : use SetFileName() + Load()
+ //GDCM_LEGACY( virtual bool Load( std::string const &filename ) );
+ //virtual bool Load( std::string const &filename );
+ virtual bool Load( );
// Dictionaries
Dict *GetPubDict();
bool SetShaDict(DictKey const &dictName);
// Informations contained in the gdcm::Document
+ bool IsParsable();
virtual bool IsReadable();
bool IsDicomV3();
bool IsPapyrus();
// 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();
// 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.
+ * 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
// Constructor and destructor are protected to forbid end user
// 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.
/// \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 element 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
+ /// Probabely, some more to add
+ int LoadMode;
+
+ /// \brief Whether the gdcm::Document is already parsed/loaded :
+ /// False from the creation of the gdcm::Document untill
+ /// gdcm::Document:Load()
+ 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 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);
- void FixDocEntryFoundLength(DocEntry *entry,uint32_t l);
+ void FixDocEntryFoundLength(DocEntry *entry, uint32_t l);
bool IsDocEntryAnInteger (DocEntry *entry);
bool CheckSwap();
void SwitchByteSwapCode();
void SetMaxSizeLoadEntry(long);
- void SetMaxSizePrintEntry(long);
// DocEntry related utilities
DocEntry *ReadNextDocEntry();
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
/// 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 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;
-
+ /// \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 );
+// DocEntrySet *set );
};
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff