1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntry.h,v $
6 Date: $Date: 2005/07/11 14:40:40 $
7 Version: $Revision: 1.47 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See Doc/License.txt or
11 http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
19 #ifndef GDCMDOCENTRY_H
20 #define GDCMDOCENTRY_H
23 #include "gdcmDictEntry.h"
35 //-----------------------------------------------------------------------------
37 * \brief The dicom header of a Dicom file contains a set of such entries
38 * (when successfuly parsed against a given Dicom dictionary)
40 class GDCM_EXPORT DocEntry : public Base
44 /// \brief Canonical Destructor
45 virtual ~DocEntry() {};
47 virtual void Print (std::ostream &os = std::cout, std::string const &indent = "");
48 virtual void WriteContent(std::ofstream *fp, FileType filetype);
50 /// \brief Gets the DicEntry of the current Dicom entry
51 /// @return The DicEntry of the current Dicom entry
52 DictEntry * GetDictEntry() { return DicomDict; };
54 /// Returns the Dicom Group number of the current Dicom entry
55 uint16_t GetGroup() { return DicomDict->GetGroup(); };
57 /// Returns the Dicom Element number of the current Dicom entry
58 uint16_t GetElement() { return DicomDict->GetElement();};
60 /// Set the 'key' of the current Dicom entry
61 void SetKey( TagKey const &key ) { Key = key; }
63 /// Returns the 'key' of the current Dicom entry
64 TagKey const &GetKey() const { return Key; }
66 /// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom
67 /// Dictionnary of the current Dicom Header Entry
68 std::string const &GetName() const { return DicomDict->GetName(); };
70 /// \brief Returns the 'Value Representation' (e.g. "PN" : Person Name,
71 /// "SL" : Signed Long), found in the Dicom header or in the Dicom
72 /// Dictionnary, of the current Dicom entry
73 std::string const &GetVR() const { return DicomDict->GetVR(); };
75 /// \brief Returns the 'Value Multiplicity' (e.g. "1", "1-n", "6"),
76 /// found in the Dicom entry or in the Dicom Dictionnary
77 /// of the current Dicom entry
78 std::string const &GetVM() const { return DicomDict->GetVM(); };
80 /// Sets the 'Value Multiplicity' of the current Dicom entry
81 void SetVM( TagName const &v) { DicomDict->SetVM(v); };
83 /// \brief Returns offset (since the beginning of the file, including
84 /// the File Preamble, if any) of the value of the current Dicom entry
85 /// \warning offset of the *value*, not of the Dicom entry
86 size_t GetOffset() { return Offset; };
88 /// \brief Sets only 'Read Length' (*not* 'Usable Length') of the current
90 void SetReadLength(uint32_t l) { ReadLength = l; };
91 /// \brief Returns the 'read length' of the current Dicom entry
92 /// \warning this value is the one stored in the Dicom header but not
93 /// mandatoryly the one thats's used (in case on SQ, or delimiters,
94 /// the usable length is set to zero)
95 uint32_t GetReadLength() { return ReadLength; };
97 /// \brief Sets both 'Read Length' and 'Usable Length' of the current
99 void SetLength(uint32_t l) { Length = l; };
100 /// \brief Returns the actual value length of the current Dicom entry
101 /// \warning this value is not *always* the one stored in the Dicom header
102 /// in case of well knowned bugs
103 uint32_t GetLength() { return Length; };
105 uint32_t GetFullLength();
107 // The following 3 members, for internal use only !
108 /// \brief Sets the offset of the Dicom entry
109 /// \warning use with caution !
110 /// @param of offset to be set
111 void SetOffset(size_t of) { Offset = of; };
113 /// Sets to TRUE the ImplicitVr flag of the current Dicom entry
114 void SetImplicitVR() { ImplicitVR = true; };
116 /// \brief Tells us if the current Dicom entry was checked as ImplicitVr
117 /// @return true if the current Dicom entry was checked as ImplicitVr
118 bool IsImplicitVR() { return ImplicitVR; };
120 /// \brief Tells us if the VR of the current Dicom entry is Unknown
121 /// @return true if the VR is unknown
122 bool IsVRUnknown() { return DicomDict->IsVRUnknown(); };
124 /// \brief Tells us if the VM of the current Dicom entry is Unknown
125 /// @return true if the VM is unknown
126 bool IsVMUnknown() { return DicomDict->IsVMUnknown(); };
128 bool IsItemDelimitor();
129 bool IsSequenceDelimitor();
131 virtual void Copy(DocEntry *e);
134 /// \brief pointer to the underlying Dicom dictionary element
135 DictEntry *DicomDict;
137 /// \brief Correspond to the real length of the data
138 /// This length might always be even
141 /// \brief Length to read in the file to obtain data
144 /// \brief Even when reading explicit vr files, some elements happen to
145 /// be implicit. Flag them here since we can't use the entry->vr without
146 /// breaking the underlying dictionary.
149 /// Offset from the beginning of file for direct user access
152 /// \brief Generalized key of this DocEntry (for details on
153 /// the generalized key refer to \ref TagKey documentation).
158 } // end namespace gdcm
159 //-----------------------------------------------------------------------------