1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntry.h,v $
6 Date: $Date: 2004/10/12 04:35:45 $
7 Version: $Revision: 1.25 $
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
22 #include "gdcmDictEntry.h"
34 //-----------------------------------------------------------------------------
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
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 key ) { Key = key; }
55 /// Returns the 'key' of the current Dicom Header Entry
56 std::string GetKey() { 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 GetName() { 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 GetVR() { return DicomDict->GetVR(); };
67 /// \brief Returns offset (since the beginning of the file, including
68 /// the File Preamble, if any) of the value of the current Dicom HeaderEntry
69 /// \warning offset of the *value*, not of the Dicom Header Entry
70 size_t GetOffset() { return Offset; };
72 /// \brief Returns the actual value length of the current Dicom Header Entry
73 /// \warning this value is not *always* the one stored in the Dicom Header
74 /// in case of well knowned bugs
75 uint32_t GetLength() { return UsableLength; };
77 /// \brief Returns the 'read length' of the current Dicom Header Entry
78 /// \warning this value is the one stored in the Dicom Header but not
79 /// mandatoryly the one thats's used (in case on SQ, or delimiters,
80 /// the usable length is set to zero)
81 uint32_t GetReadLength() { return ReadLength; };
83 /// Sets the 'Value Representation' of the current Dicom Header Entry
84 void SetVR(std::string const & v) { DicomDict->SetVR(v); };
86 /// \brief Sets both 'Read Length' and 'Usable Length' of the current
87 /// Dicom Header Entry
88 void SetLength(uint32_t l) { ReadLength = UsableLength = l;};
90 // The following 3 members, for internal use only !
92 /// \brief Sets only 'Read Length' (*not* 'Usable Length') of the current
93 /// Dicom Header Entry
94 void SetReadLength(uint32_t l) { ReadLength = l; };
96 /// \brief Sets only 'Usable Length' (*not* 'Read Length') of the current
97 /// Dicom Header Entry
98 void SetUsableLength(uint32_t l) { UsableLength = l; };
100 /// \brief Sets the offset of the Dicom Element
101 /// \warning use with caution !
102 /// @param of offset to be set
103 void SetOffset(size_t of) { Offset = of; };
105 /// Sets to TRUE the ImplicitVr flag of the current Dicom Element
106 void SetImplicitVR() { ImplicitVR = true; };
108 /// \brief Tells us if the current Dicom Element was checked as ImplicitVr
109 /// @return true if the current Dicom Element was checked as ImplicitVr
110 bool IsImplicitVR() { return ImplicitVR; };
112 /// \brief Tells us if the VR of the current Dicom Element is Unknown
113 /// @return true if the VR is unknown
114 bool IsVRUnknown() { return DicomDict->IsVRUnknown(); };
116 /// \brief Sets the DicEntry of the current Dicom Element
117 /// @param newEntry pointer to the DictEntry
118 void SetDictEntry(DictEntry *newEntry) { DicomDict = newEntry; };
120 /// \brief Gets the DicEntry of the current Dicom Element
121 /// @return The DicEntry of the current Dicom Element
122 DictEntry * GetDictEntry() { return DicomDict; };
124 /// \brief Sets the print level for the Dicom Header Elements
125 /// \note 0 for Light Print; 1 for 'medium' Print, 2 for Heavy
126 void SetPrintLevel(int level) { PrintLevel = level; };
128 /// \brief Gets the print level for the Dicom Header Elements
129 int GetPrintLevel() { return PrintLevel; };
131 virtual void Print (std::ostream & os = std::cout);
132 virtual void Write(FILE *fp, FileType filetype);
134 uint32_t GetFullLength();
136 void Copy(DocEntry *doc);
138 bool IsItemDelimitor();
139 bool IsSequenceDelimitor();
142 // FIXME: In fact we should be more specific and use :
143 // friend DocEntry * Header::ReadNextElement(void);
149 /// \brief pointer to the underlying Dicom dictionary element
150 DictEntry *DicomDict;
152 /// \brief Updated from ReadLength, by FixFoungLentgh() for fixing a bug
153 /// in the header or helping the parser going on
154 uint32_t UsableLength;
156 /// \brief Length actually read on disk (before FixFoundLength). ReadLength
157 /// will be updated only when FixFoundLength actually fixes a bug in the
158 /// header, not when it performs a trick to help the Parser going on.
161 /// \brief Even when reading explicit vr files, some elements happen to
162 /// be implicit. Flag them here since we can't use the entry->vr without
163 /// breaking the underlying dictionary.
166 /// Offset from the begining of file for direct user access
169 /// How many details are to be printed (value : 0,1,2)
172 /// \brief Generalized key (i.e. a BaseTagKey prepending a TagKey)
176 } // end namespace gdcm
177 //-----------------------------------------------------------------------------