X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntry.h;h=a756fa7d3d20bd4ca5488f63a35484819dc1b21c;hb=80075429b6ab9db9e885b9bb9ae1427530c7bef8;hp=52707ee18d17733f724079e26467456cb5160133;hpb=f5c7e83afd484a025285c64a09a89bd227087245;p=gdcm.git diff --git a/src/gdcmDocEntry.h b/src/gdcmDocEntry.h index 52707ee1..a756fa7d 100644 --- a/src/gdcmDocEntry.h +++ b/src/gdcmDocEntry.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDocEntry.h,v $ Language: C++ - Date: $Date: 2004/12/16 13:46:37 $ - Version: $Revision: 1.33 $ + Date: $Date: 2007/09/17 12:16:02 $ + Version: $Revision: 1.71 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -16,20 +16,18 @@ =========================================================================*/ -#ifndef GDCMDOCENTRY_H -#define GDCMDOCENTRY_H +#ifndef _GDCMDOCENTRY_H_ +#define _GDCMDOCENTRY_H_ -#include "gdcmBase.h" +#include "gdcmRefCounter.h" #include "gdcmDictEntry.h" #include #include -namespace gdcm +namespace GDCM_NAME_SPACE { -class Header; -class ValEntry; -class BinEntry; +class File; class SeqEntry; //----------------------------------------------------------------------------- @@ -37,119 +35,136 @@ class SeqEntry; * \brief The dicom header of a Dicom file contains a set of such entries * (when successfuly parsed against a given Dicom dictionary) */ -class GDCM_EXPORT DocEntry : public Base +class GDCM_EXPORT DocEntry : public RefCounter { + gdcmTypeMacro(DocEntry); + public: - DocEntry(DictEntry*); - virtual ~DocEntry() {}; + virtual void Print (std::ostream &os = std::cout, std::string const &indent = ""); + virtual void WriteContent(std::ofstream *fp, FileType filetype, + bool insideMetaElements, bool insideSequence); - /// Returns the Dicom Group number of the current Dicom Header Entry - uint16_t GetGroup() { return DicomDict->GetGroup(); }; + /// \brief Gets the DicEntry of the current Dicom entry + /// @return The DicEntry of the current Dicom entry + DictEntry * GetDictEntry() { return DicomDict; } - /// Returns the Dicom Element number of the current Dicom Header Entry - uint16_t GetElement() { return DicomDict->GetElement();}; + /// Returns the Dicom Group number of the current Dicom entry + uint16_t const &GetGroup() const { return Key[0]; } + //const uint16_t &GetGroup() const { return DicomDict->GetGroup(); } - /// Returns the 'key' of the current Dicom Header Entry - void SetKey( TagKey const & key ) { Key = key; } + /// Returns the Dicom Element number of the current Dicom entry + uint16_t const &GetElement() const { return Key[1];} + //const uint16_t &GetElement() const { return DicomDict->GetElement();} - /// Returns the 'key' of the current Dicom Header Entry - std::string const & GetKey() const { return Key; } + /// Returns the 'key' of the current Dicom entry + TagKey const &GetKey() const { return Key; } + //TagKey GetKey() const { return DicomDict->GetKey(); } /// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom /// Dictionnary of the current Dicom Header Entry - std::string const & GetName() const { return DicomDict->GetName(); }; + std::string const &GetName(); /// \brief Returns the 'Value Representation' (e.g. "PN" : Person Name, - /// "SL" : Signed Long), found in the Dicom Header or in the Dicom - /// Dictionnary, of the current Dicom Header Entry - std::string const & GetVR() const { return DicomDict->GetVR(); }; - - /// \brief Returns offset (since the beginning of the file, including - /// the File Preamble, if any) of the value of the current Dicom HeaderEntry - /// \warning offset of the *value*, not of the Dicom Header Entry - size_t GetOffset() { return Offset; }; - - /// \brief Returns the actual value length of the current Dicom Header Entry - /// \warning this value is not *always* the one stored in the Dicom Header - /// in case of well knowned bugs - uint32_t GetLength() { return UsableLength; }; + /// "SL" : Signed Long), found in the Dicom header or in the Dicom + /// Dictionnary, of the current Dicom entry + VRKey const &GetVR() const { return VR; } + //VRKey const &GetVR() const { return DicomDict->GetVR(); } + + /// \brief Returns the 'Value Multiplicity' (e.g. "1", "6", "1-n", "3-n"), + /// found in the Dicom entry or in the Dicom Dictionnary + /// of the current Dicom entry + std::string const &GetVM(); + + /// Sets the 'Value Multiplicity' of the current Dicom entry + //void SetVM( TagName const &v) { DicomDict->SetVM(v); } + void SetVM( TagName &) { std::cout << "-----------------FIXME : SetVM "; } - /// \brief Returns the 'read length' of the current Dicom Header Entry - /// \warning this value is the one stored in the Dicom Header but not - /// mandatoryly the one thats's used (in case on SQ, or delimiters, - /// the usable length is set to zero) - uint32_t GetReadLength() { return ReadLength; }; + /// \brief Returns offset (since the beginning of the file, including + /// the File Preamble, if any) of the value of the current Dicom entry + /// \warning offset of the *value*, not of the Dicom entry + const size_t &GetOffset() const { return Offset; } - /// Sets the 'Value Representation' of the current Dicom Header Entry - void SetVR( TagName const & v) { DicomDict->SetVR(v); }; + /// \brief Sets only 'Read Length' (*not* 'Usable Length') of the current + /// Dicom entry + void SetReadLength(uint32_t l) { ReadLength = l; } + /// \brief Returns the 'read length' of the current Dicom entry + /// \warning this value is the one stored in the Dicom header but not + /// mandatoryly the one thats's used (in case of SQ, or delimiters, + /// the usable length is set to zero) + const uint32_t &GetReadLength() const { return ReadLength; } /// \brief Sets both 'Read Length' and 'Usable Length' of the current - /// Dicom Header Entry - void SetLength(uint32_t l) { ReadLength = UsableLength = l; }; - - // The following 3 members, for internal use only ! - - /// \brief Sets only 'Read Length' (*not* 'Usable Length') of the current - /// Dicom Header Entry - void SetReadLength(uint32_t l) { ReadLength = l; }; + /// Dicom entry + virtual void SetLength(uint32_t l) { Length = l; } + /// \brief Returns the actual value length of the current Dicom entry + /// \warning this value is not *always* the one stored in the Dicom header + /// in case of well known bugs + const uint32_t &GetLength() const { return Length; } - /// \brief Sets only 'Usable Length' (*not* 'Read Length') of the current - /// Dicom Header Entry - void SetUsableLength(uint32_t l) { UsableLength = l; }; - - /// \brief Sets the offset of the Dicom Element + uint32_t GetFullLength(); + virtual uint32_t ComputeFullLength() = 0; + +// The following members, for internal use only ! + + /// \brief Sets the offset of the Dicom entry /// \warning use with caution ! /// @param of offset to be set - void SetOffset(size_t of) { Offset = of; }; + void SetOffset(size_t of) { Offset = of; } - /// Sets to TRUE the ImplicitVr flag of the current Dicom Element - void SetImplicitVR() { ImplicitVR = true; }; + /// Sets to TRUE the ImplicitVr flag of the current Dicom entry + void SetImplicitVR() { ImplicitVR = true; } - /// \brief Tells us if the current Dicom Element was checked as ImplicitVr - /// @return true if the current Dicom Element was checked as ImplicitVr - bool IsImplicitVR() { return ImplicitVR; }; - - /// \brief Tells us if the VR of the current Dicom Element is Unknown - /// @return true if the VR is unknown - bool IsVRUnknown() { return DicomDict->IsVRUnknown(); }; - - /// \brief Sets the DicEntry of the current Dicom Element - /// @param newEntry pointer to the DictEntry - void SetDictEntry(DictEntry *newEntry) { DicomDict = newEntry; }; + /// Sets the 'Value Representation' of the current Dicom entry + /// @param vr VR to be set + void SetVR( VRKey const &vr) { VR = vr; } - /// \brief Gets the DicEntry of the current Dicom Element - /// @return The DicEntry of the current Dicom Element - DictEntry * GetDictEntry() { return DicomDict; }; - - virtual void WriteContent(std::ofstream *fp, FileType filetype); - - uint32_t GetFullLength(); + /// Sets the 'Value Representation' of the current Dicom entry + /// @param key TagKey to be set + void SetTag( TagKey const &key) { Key = key; } + +// -----------end of members to be used with caution - void Copy(DocEntry *doc); - - bool IsItemDelimitor(); - bool IsSequenceDelimitor(); - - virtual void Print (std::ostream & os = std::cout); + /// \brief Tells us if the current Dicom entry was checked as ImplicitVr + /// @return true if the current Dicom entry was checked as ImplicitVr + bool IsImplicitVR() const { return ImplicitVR; } -private: - // FIXME: In fact we should be more specific and use : - // friend DocEntry * Header::ReadNextElement(void); - friend class Header; + /// \brief Tells us if the VR of the current Dicom entry is Unknown + /// @return true if the VR is unknown +// bool IsVRUnknown() const { return DicomDict->IsVRUnknown(); } + bool IsVRUnknown() const { return VR == GDCM_VRUNKNOWN; } + + /// \brief Tells us if the VM of the current Dicom entry is Unknown + /// @return true if the VM is unknown +// bool IsVMUnknown() const { return DicomDict->IsVMUnknown(); } + bool IsVMUnknown() { return GetVM() == GDCM_UNKNOWN; } + +/// \brief tells us if entry is the last one of a 'no length' SequenceItem +/// (fffe,e00d) + bool IsItemDelimitor() + {return (GetGroup() == 0xfffe && GetElement() == 0xe00d);} +///\brief tells us if entry is the last one of a 'no length' Sequence +/// (fffe,e0dd) + bool IsItemStarter(){ if (GetGroup() != 0xfffe) return false; + return (GetElement() == 0xe000); } + /// \brief tells us if entry is the last one of a 'no length' Sequence + /// (fffe,e0dd) + bool IsSequenceDelimitor() { return (GetGroup() == 0xfffe && GetElement() == 0xe0dd);} + + virtual void Copy(DocEntry *doc); protected: -// Variables + // DocEntry(DictEntry*); + DocEntry(uint16_t group, uint16_t elem, VRKey const &vr); + virtual ~DocEntry(); /// \brief pointer to the underlying Dicom dictionary element DictEntry *DicomDict; - - /// \brief Updated from ReadLength, by FixFoungLentgh() for fixing a bug - /// in the header or helping the parser going on - uint32_t UsableLength; + + /// \brief Corresponds to the real length of the data + /// This length might always be even + uint32_t Length; - /// \brief Length actually read on disk (before FixFoundLength). ReadLength - /// will be updated only when FixFoundLength actually fixes a bug in the - /// header, not when it performs a trick to help the Parser going on. + /// \brief Length to read in the file to obtain data uint32_t ReadLength; /// \brief Even when reading explicit vr files, some elements happen to @@ -157,12 +172,17 @@ protected: /// breaking the underlying dictionary. bool ImplicitVR; - /// Offset from the begining of file for direct user access + /// Offset from the beginning of file for direct user access size_t Offset; - /// \brief Generalized key of this DocEntry (for details on - /// the generalized key refer to \ref TagKey documentation). - TagKey Key; + /// \brief Value Representation (to avoid accessing Dicom Dict every time!) + VRKey VR; // JPRx + + /// \brief Dicom TagKey. Contains Dicom Group number and Dicom Element number + /// (to avoid accessing Dicom Dict every time !) // JPRx + TagKey Key; // JPRx +private: + }; } // end namespace gdcm //-----------------------------------------------------------------------------