/*========================================================================= Program: gdcm Module: $RCSfile: gdcmDocEntry.h,v $ Language: C++ Date: $Date: 2004/06/23 13:02:36 $ Version: $Revision: 1.11 $ 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.htm 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 #include #include "gdcmDictEntry.h" class gdcmHeader; class gdcmValEntry; class gdcmBinEntry; class gdcmSeqEntry; //----------------------------------------------------------------------------- /** * \ingroup gdcmDocEntry * \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 { public: gdcmDocEntry(gdcmDictEntry*); /// Returns the Dicom Group number of the current Dicom Header Entry inline guint16 GetGroup(void) { return entry->GetGroup(); }; /// Returns the Dicom Element number of the current Dicom Header Entry inline guint16 GetElement(void) { return entry->GetElement();}; /// Returns the 'key' of the current Dicom Header Entry inline std::string GetKey(void) { return entry->GetKey(); }; /// \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(); }; /// \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(); }; /// \brief Returns offset (since the beginning of the file, including /// the File Pramble, 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; }; /// \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 inline guint32 GetLength(void) { 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; }; /// Sets the 'Value Representation' of the current Dicom Header Entry inline void SetVR(std::string v) { entry->SetVR(v); }; /// \brief Sets both 'Read Length' and 'Usable Length' of the current /// Dicom Header Entry inline void SetLength(guint32 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; }; /// \brief Sets only 'Usable Length' (*not* 'Read Length') of the current /// Dicom Header Entry inline void SetUsableLength(guint32 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; }; /// Sets to TRUE the ImplicitVr flag of the current Dicom Element inline void gdcmDocEntry::SetImplicitVR(void) { 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; }; /// \brief Tells us if the VR of the current Dicom Element is Unknown /// @return true if the VR is unkonwn inline bool gdcmDocEntry::IsVRUnknown(void) { return entry->IsVRUnknown(); }; /// \brief Sets the DicEntry of the current Dicom Element /// @param NewEntry pointer to the DictEntry inline void gdcmDocEntry::SetDictEntry(gdcmDictEntry *NewEntry) { entry = NewEntry; }; /// \brief Gets the DicEntry of the current Dicom Element /// @return The DicEntry of the current Dicom Element gdcmDictEntry * gdcmDocEntry::GetDictEntry(void) { return entry; }; /// \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; }; /// \brief Gets the print level for the Dicom Header Elements int GetPrintLevel(void) { return(printLevel); }; virtual void Print (std::ostream & os = std::cout); virtual void Write(FILE *fp, FileType filetype); guint32 GetFullLength(void); void Copy(gdcmDocEntry *doc); bool isItemDelimitor(); bool isSequenceDelimitor(); /// \brief Gets the depth level of a Dicom header entry embedded in /// a SeQuence inline int GetDepthLevel(void) {return(SQDepthLevel);} /// \brief Sets the depth level of a Dicom header entry embedded in /// a SeQuence inline void SetDepthLevel(int depth) {SQDepthLevel = depth;} private: // FIXME: In fact we should be more specific and use : // friend gdcmDocEntry * gdcmHeader::ReadNextElement(void); friend class gdcmHeader; protected: // Variables /// \brief pointer to the underlying Dicom dictionary element gdcmDictEntry *entry; /// \brief Updated from ReadLength, by FixFoungLentgh() for fixing a bug /// in the header or helping the parser going on guint32 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; /// \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 /// breaking the underlying dictionary. bool ImplicitVR; /// Offset from the begining of file for direct user access 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; }; //----------------------------------------------------------------------------- #endif