X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntry.h;h=4acd164dbd421bede02f35adfb20948721d81cd3;hb=61573d5dba81e5c8a7ce347adebbb941e6583d77;hp=5f1094baf2cfdbd1d6f2597194ec6bc28d452e7b;hpb=00be59e3db4bb1efcb3ac7980822863d1f7b92e5;p=gdcm.git diff --git a/src/gdcmDocEntry.h b/src/gdcmDocEntry.h index 5f1094ba..4acd164d 100644 --- a/src/gdcmDocEntry.h +++ b/src/gdcmDocEntry.h @@ -1,13 +1,31 @@ -// gdcmDocEntry.h -//----------------------------------------------------------------------------- -#ifndef GDCMDocEntry_H -#define GDCMDocEntry_H +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDocEntry.h,v $ + Language: C++ + Date: $Date: 2004/10/08 04:52:55 $ + Version: $Revision: 1.24 $ + + Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de + l'Image). All rights reserved. See Doc/License.txt or + http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details. + + This software is distributed WITHOUT ANY WARRANTY; without even + the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE. See the above copyright notices for more information. + +=========================================================================*/ + +#ifndef GDCMDOCENTRY_H +#define GDCMDOCENTRY_H +#include "gdcmDictEntry.h" #include -#include -#include "gdcmDictEntry.h" class gdcmHeader; +class gdcmValEntry; +class gdcmBinEntry; +class gdcmSeqEntry; //----------------------------------------------------------------------------- /** @@ -15,119 +33,126 @@ class gdcmHeader; * \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 gdcmDocEntry { +class GDCM_EXPORT gdcmDocEntry +{ public: gdcmDocEntry(gdcmDictEntry*); + virtual ~gdcmDocEntry() {}; /// Returns the Dicom Group number of the current Dicom Header Entry - inline guint16 GetGroup(void) { return entry->GetGroup(); }; + uint16_t GetGroup() { return DictEntry->GetGroup(); }; /// Returns the Dicom Element number of the current Dicom Header Entry - inline guint16 GetElement(void) { return entry->GetElement();}; + uint16_t GetElement() { return DictEntry->GetElement();}; /// Returns the 'key' of the current Dicom Header Entry - inline std::string GetKey(void) { return entry->GetKey(); }; + void SetKey( gdcmTagKey key ) { Key = key; } + + /// Returns the 'key' of the current Dicom Header Entry + std::string GetKey() { return Key; } /// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom /// Dictionnary of the current Dicom Header Entry - inline std::string GetName(void) { return entry->GetName(); }; + std::string GetName() { return DictEntry->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 - inline std::string GetVR(void) { return entry->GetVR(); }; + std::string GetVR() { return DictEntry->GetVR(); }; /// \brief Returns offset (since the beginning of the file, including - /// the File Pramble, if any) of the value of the current Dicom HeaderEntry + /// the File Preamble, if any) of the value of the current Dicom HeaderEntry /// \warning offset of the *value*, not of the Dicom Header Entry - inline size_t GetOffset(void) { return Offset; }; + size_t GetOffset() { return Offset; }; /// \brief Returns the actual value length of the current Dicom Header Entry - /// \warning this value is not *allways* the one stored in the Dicom Header + /// \warning this value is not *always* the one stored in the Dicom Header /// in case of well knowned bugs - inline guint32 GetLength(void) { return UsableLength; }; + uint32_t GetLength() { return UsableLength; }; /// \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) - inline guint32 GetReadLength(void) { return ReadLength; }; + uint32_t GetReadLength() { return ReadLength; }; /// Sets the 'Value Representation' of the current Dicom Header Entry - inline void SetVR(std::string v) { entry->SetVR(v); }; + void SetVR(std::string const & v) { DictEntry->SetVR(v); }; /// \brief Sets both 'Read Length' and 'Usable Length' of the current /// Dicom Header Entry - inline void SetLength(guint32 l) { ReadLength=UsableLength=l;}; + 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 - inline void SetReadLength(guint32 l) { ReadLength = l; }; + void SetReadLength(uint32_t l) { ReadLength = l; }; /// \brief Sets only 'Usable Length' (*not* 'Read Length') of the current /// Dicom Header Entry - inline void SetUsableLength(guint32 l) { UsableLength = l; }; + void SetUsableLength(uint32_t l) { UsableLength = l; }; /// \brief Sets the offset of the Dicom Element /// \warning use with caution ! /// @param of offset to be set - inline void gdcmDocEntry::SetOffset(size_t of) { Offset = of; }; + void SetOffset(size_t of) { Offset = of; }; /// Sets to TRUE the ImplicitVr flag of the current Dicom Element - inline void gdcmDocEntry::SetImplicitVR(void) { ImplicitVR = true; }; + 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 - inline bool gdcmDocEntry::IsImplicitVR(void) { return ImplicitVR; }; + bool IsImplicitVR() { return ImplicitVR; }; - /// \brief Tells us if the VR of the current Dicom Element is Unkonwn - /// @return true if the VR is unkonwn - inline bool gdcmDocEntry::IsVRUnknown(void) - { return entry->IsVRUnknown(); }; + /// \brief Tells us if the VR of the current Dicom Element is Unknown + /// @return true if the VR is unknown + bool IsVRUnknown() { return DictEntry->IsVRUnknown(); }; /// \brief Sets the DicEntry of the current Dicom Element - /// @param NewEntry pointer to the DictEntry - inline void gdcmDocEntry::SetDictEntry(gdcmDictEntry *NewEntry) - { entry = NewEntry; }; + /// @param newEntry pointer to the DictEntry + void SetDictEntry(gdcmDictEntry *newEntry) { DictEntry = newEntry; }; /// \brief Gets the DicEntry of the current Dicom Element /// @return The DicEntry of the current Dicom Element - gdcmDictEntry * gdcmDocEntry::GetDictEntry(void) { return entry; }; + gdcmDictEntry * GetDictEntry() { return DictEntry; }; /// \brief Sets the print level for the Dicom Header Elements /// \note 0 for Light Print; 1 for 'medium' Print, 2 for Heavy - void SetPrintLevel(int level) { printLevel = level; }; + void SetPrintLevel(int level) { PrintLevel = level; }; - void Print (std::ostream & os = std::cout); - - /// Gets the depth level of a Dicom Header Entry embedded in a SeQuence - inline int GetSQDepthLevel(void) { return (SQDepthLevel); }; - - guint32 GetFullLength(void); + /// \brief Gets the print level for the Dicom Header Elements + int GetPrintLevel() { return PrintLevel; }; + + virtual void Print (std::ostream & os = std::cout); + virtual void Write(FILE *fp, FileType filetype); + + uint32_t GetFullLength(); void Copy(gdcmDocEntry *doc); - + + bool IsItemDelimitor(); + bool IsSequenceDelimitor(); + private: // FIXME: In fact we should be more specific and use : // friend gdcmDocEntry * gdcmHeader::ReadNextElement(void); - friend class gdcmHeader; + friend class gdcmHeader; - /// Sets the depth level of a Dicom Header Entry embedded in a SeQuence - inline void SetSQDepthLevel(int depthLevel) { SQDepthLevel = depthLevel; }; - +protected: // Variables - gdcmDictEntry *entry; + /// \brief pointer to the underlying Dicom dictionary element + gdcmDictEntry *DictEntry; + /// \brief Updated from ReadLength, by FixFoungLentgh() for fixing a bug /// in the header or helping the parser going on - guint32 UsableLength; + uint32_t UsableLength; /// \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. - guint32 ReadLength; + uint32_t ReadLength; /// \brief Even when reading explicit vr files, some elements happen to /// be implicit. Flag them here since we can't use the entry->vr without @@ -138,10 +163,11 @@ private: size_t Offset; /// How many details are to be printed (value : 0,1,2) - int printLevel; - - /// Gives the depth level of elements inside SeQuences - int SQDepthLevel; + int PrintLevel; + + /// \brief Generalized key (i.e. a gdcmBaseTagKey prepending a gdcmTagKey) + /// of this gdcmDocEntry + gdcmTagKey Key; }; //-----------------------------------------------------------------------------