X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntry.h;h=b77f294355f4539ed220c1a7402273de02747d0b;hb=5b89bede4607999aeb8d5b45311e7ee82f9471ef;hp=4ee6f7f5e73c0cd1958bb05e83f3558b5f5670eb;hpb=d71e2e62b38383d9b960760f6d81c4d545d59fba;p=gdcm.git diff --git a/src/gdcmDocEntry.h b/src/gdcmDocEntry.h index 4ee6f7f5..b77f2943 100644 --- a/src/gdcmDocEntry.h +++ b/src/gdcmDocEntry.h @@ -3,12 +3,12 @@ Program: gdcm Module: $RCSfile: gdcmDocEntry.h,v $ Language: C++ - Date: $Date: 2004/06/24 11:44:35 $ - Version: $Revision: 1.12 $ + Date: $Date: 2005/02/02 16:18:48 $ + Version: $Revision: 1.45 $ 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. + 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 @@ -16,164 +16,143 @@ =========================================================================*/ -#ifndef GDCMDocEntry_H -#define GDCMDocEntry_H - -#include -#include +#ifndef GDCMDOCENTRY_H +#define GDCMDOCENTRY_H +#include "gdcmBase.h" #include "gdcmDictEntry.h" -class gdcmHeader; -class gdcmValEntry; -class gdcmBinEntry; -class gdcmSeqEntry; +#include +#include + +namespace gdcm +{ +class File; +class ValEntry; +class BinEntry; +class SeqEntry; //----------------------------------------------------------------------------- /** - * \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 { +class GDCM_EXPORT DocEntry : public Base +{ public: - gdcmDocEntry(gdcmDictEntry*); - - /// Returns the Dicom Group number of the current Dicom Header Entry - guint16 GetGroup(void) { return entry->GetGroup(); }; + DocEntry(DictEntry*); + virtual ~DocEntry() {}; + + virtual void Print (std::ostream &os = std::cout, std::string const &indent = ""); + virtual void WriteContent(std::ofstream *fp, FileType filetype); + + /// \brief Gets the DicEntry of the current Dicom entry + /// @return The DicEntry of the current Dicom entry + DictEntry * GetDictEntry() { return DicomDict; }; + + /// Returns the Dicom Group number of the current Dicom entry + uint16_t GetGroup() { return DicomDict->GetGroup(); }; - /// Returns the Dicom Element number of the current Dicom Header Entry - guint16 GetElement(void) { return entry->GetElement();}; - - /// Returns the 'key' of the current Dicom Header Entry - std::string GetKey(void) { return entry->GetKey(); }; + /// Returns the Dicom Element number of the current Dicom entry + uint16_t GetElement() { return DicomDict->GetElement();}; + + /// Set the 'key' of the current Dicom entry + void SetKey( TagKey const &key ) { Key = key; } + /// Returns the 'key' of the current Dicom entry + std::string const &GetKey() const { return Key; } /// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom /// Dictionnary of the current Dicom Header Entry - std::string GetName(void) { return entry->GetName(); }; + std::string const &GetName() const { return DicomDict->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 GetVR(void) { return entry->GetVR(); }; + /// "SL" : Signed Long), found in the Dicom header or in the Dicom + /// Dictionnary, of the current Dicom entry + std::string const &GetVR() const { return DicomDict->GetVR(); }; + + /// \brief Returns the 'Value Multiplicity' (e.g. "1", "1-n", "6"), + /// found in the Dicom entry or in the Dicom Dictionnary + /// of the current Dicom entry + std::string const &GetVM() const { return DicomDict->GetVM(); }; + + /// Sets the 'Value Multiplicity' of the current Dicom entry + void SetVM( TagName const &v) { DicomDict->SetVM(v); }; /// \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 - size_t GetOffset(void) { return Offset; }; + /// the File Preamble, if any) of the value of the current Dicom entry + /// \warning offset of the *value*, not of the Dicom 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 - 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 + /// \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 on SQ, or delimiters, /// the usable length is set to zero) - guint32 GetReadLength(void) { return ReadLength; }; - - /// Sets the 'Value Representation' of the current Dicom Header Entry - void SetVR(std::string v) { entry->SetVR(v); }; + uint32_t GetReadLength() { return ReadLength; }; /// \brief Sets both 'Read Length' and 'Usable Length' of the current - /// Dicom Header Entry - 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 - void SetReadLength(guint32 l) { ReadLength = l; }; + /// Dicom entry + 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 knowned bugs + uint32_t GetLength() { return Length; }; - /// \brief Sets only 'Usable Length' (*not* 'Read Length') of the current - /// Dicom Header Entry - void SetUsableLength(guint32 l) { UsableLength = l; }; - - /// \brief Sets the offset of the Dicom Element + uint32_t GetFullLength(); + +// The following 3 members, for internal use only ! + /// \brief Sets the offset of the Dicom entry /// \warning use with caution ! /// @param of offset to be set - 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 - void gdcmDocEntry::SetImplicitVR(void) { 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 gdcmDocEntry::IsImplicitVR(void) { return ImplicitVR; }; + /// \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() { return ImplicitVR; }; - /// \brief Tells us if the VR of the current Dicom Element is Unknown - /// @return true if the VR is unkonwn - bool gdcmDocEntry::IsVRUnknown(void) { return entry->IsVRUnknown(); }; + /// \brief Tells us if the VR of the current Dicom entry 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 gdcmDocEntry::SetDictEntry(gdcmDictEntry *NewEntry) - { entry = NewEntry; }; + /// \brief Tells us if the VM of the current Dicom entry is Unknown + /// @return true if the VM is unknown + bool IsVMUnknown() { return DicomDict->IsVMUnknown(); }; - /// \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); + bool IsItemDelimitor(); + bool IsSequenceDelimitor(); - 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 - int GetDepthLevel(void) {return(SQDepthLevel);} - - /// \brief Sets the depth level of a Dicom header entry embedded in - /// a SeQuence - 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; + virtual void Copy(DocEntry *e); protected: -// Variables - /// \brief pointer to the underlying Dicom dictionary element - gdcmDictEntry *entry; + DictEntry *DicomDict; - /// \brief Updated from ReadLength, by FixFoungLentgh() for fixing a bug - /// in the header or helping the parser going on - guint32 UsableLength; + /// \brief Correspond 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. - guint32 ReadLength; + /// \brief Length to read in the file to obtain data + 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 /// 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; - /// How many details are to be printed (value : 0,1,2) - int printLevel; - - /// Gives the depth level of elements inside SeQuences - int SQDepthLevel; -}; + /// \brief Generalized key of this DocEntry (for details on + /// the generalized key refer to \ref TagKey documentation). + TagKey Key; +private: +}; +} // end namespace gdcm //----------------------------------------------------------------------------- #endif