1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntry.h,v $
6 Date: $Date: 2005/01/07 16:14:58 $
7 Version: $Revision: 1.36 $
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 virtual ~DocEntry() {};
46 /// Returns the Dicom Group number of the current Dicom Header Entry
47 uint16_t GetGroup() { return DicomDict->GetGroup(); };
49 /// Returns the Dicom Element number of the current Dicom Header Entry
50 uint16_t GetElement() { return DicomDict->GetElement();};
52 /// Returns the 'key' of the current Dicom Header Entry
53 void SetKey( TagKey const &key ) { Key = key; }
55 /// Returns the 'key' of the current Dicom Header Entry
56 std::string const &GetKey() const { return Key; }
58 /// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom
59 /// Dictionnary of the current Dicom Header Entry
60 std::string const &GetName() const { return DicomDict->GetName(); };
62 /// \brief Returns the 'Value Representation' (e.g. "PN" : Person Name,
63 /// "SL" : Signed Long), found in the Dicom Header or in the Dicom
64 /// Dictionnary, of the current Dicom Header Entry
65 std::string const &GetVR() const { return DicomDict->GetVR(); };
67 /// \brief Returns the 'Value Multiplicity' (e.g. "1", "1-n", "6"),
68 /// found in the Dicom Header or in the Dicom Dictionnary
69 /// of the current Dicom Header Entry
70 std::string const &GetVM() const { return DicomDict->GetVM(); };
72 /// Sets the 'Value Representation' of the current Dicom Header Entry
73 void SetVR( TagName const &v) { DicomDict->SetVR(v); };
75 /// Sets the 'Value Multiplicity' of the current Dicom Header Entry
76 void SetVM( TagName const &v) { DicomDict->SetVM(v); };
78 /// \brief Returns offset (since the beginning of the file, including
79 /// the File Preamble, if any) of the value of the current Dicom HeaderEntry
80 /// \warning offset of the *value*, not of the Dicom Header Entry
81 size_t GetOffset() { return Offset; };
83 /// \brief Returns the actual value length of the current Dicom Header Entry
84 /// \warning this value is not *always* the one stored in the Dicom Header
85 /// in case of well knowned bugs
86 uint32_t GetLength() { return UsableLength; };
88 /// \brief Returns the 'read length' of the current Dicom Header Entry
89 /// \warning this value is the one stored in the Dicom Header but not
90 /// mandatoryly the one thats's used (in case on SQ, or delimiters,
91 /// the usable length is set to zero)
92 uint32_t GetReadLength() { return ReadLength; };
94 /// \brief Sets both 'Read Length' and 'Usable Length' of the current
95 /// Dicom Header Entry
96 void SetLength(uint32_t l) { ReadLength = UsableLength = l; };
98 // The following 3 members, for internal use only !
100 /// \brief Sets only 'Read Length' (*not* 'Usable Length') of the current
101 /// Dicom Header Entry
102 void SetReadLength(uint32_t l) { ReadLength = l; };
104 /// \brief Sets only 'Usable Length' (*not* 'Read Length') of the current
105 /// Dicom Header Entry
106 void SetUsableLength(uint32_t l) { UsableLength = l; };
108 /// \brief Sets the offset of the Dicom Element
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 Element
114 void SetImplicitVR() { ImplicitVR = true; };
116 /// \brief Tells us if the current Dicom Element was checked as ImplicitVr
117 /// @return true if the current Dicom Element was checked as ImplicitVr
118 bool IsImplicitVR() { return ImplicitVR; };
120 /// \brief Tells us if the VR of the current Dicom Element 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 Element is Unknown
125 /// @return true if the VM is unknown
126 bool IsVMUnknown() { return DicomDict->IsVMUnknown(); };
128 /// \brief Sets the DicEntry of the current Dicom Element
129 /// @param newEntry pointer to the DictEntry
130 void SetDictEntry(DictEntry *newEntry) { DicomDict = newEntry; };
132 /// \brief Gets the DicEntry of the current Dicom Element
133 /// @return The DicEntry of the current Dicom Element
134 DictEntry * GetDictEntry() { return DicomDict; };
136 virtual void WriteContent(std::ofstream *fp, FileType filetype);
138 uint32_t GetFullLength();
140 void Copy(DocEntry *doc);
142 bool IsItemDelimitor();
143 bool IsSequenceDelimitor();
145 virtual void Print (std::ostream &os = std::cout);
148 // FIXME: In fact we should be more specific and use :
149 // friend DocEntry * Header::ReadNextElement(void);
155 /// \brief pointer to the underlying Dicom dictionary element
156 DictEntry *DicomDict;
158 /// \brief Updated from ReadLength, by FixFoungLentgh() for fixing a bug
159 /// in the header or helping the parser going on
160 uint32_t UsableLength;
162 /// \brief Length actually read on disk (before FixFoundLength). ReadLength
163 /// will be updated only when FixFoundLength actually fixes a bug in the
164 /// header, not when it performs a trick to help the Parser going on.
167 /// \brief Even when reading explicit vr files, some elements happen to
168 /// be implicit. Flag them here since we can't use the entry->vr without
169 /// breaking the underlying dictionary.
172 /// Offset from the begining of file for direct user access
175 /// \brief Generalized key of this DocEntry (for details on
176 /// the generalized key refer to \ref TagKey documentation).
179 } // end namespace gdcm
180 //-----------------------------------------------------------------------------