2 //-----------------------------------------------------------------------------
3 #ifndef GDCMDICTENTRY_H
4 #define GDCMDICTENTRY_H
6 #include "gdcmCommon.h"
8 //-----------------------------------------------------------------------------
10 * \defgroup gdcmDictEntry
12 * the gdcmDictEntry in an element contained by the gdcmDict.
14 * - the key referenced by the DICOM norm or the constructor (for private keys)
15 * - the corresponding name in english (it's equivalent to a label)
19 class GDCM_EXPORT gdcmDictEntry
22 gdcmDictEntry(guint16 group,
24 std::string vr = "Unknown",
25 std::string fourth = "Unknown",
26 std::string name = "Unknown");
28 static TagKey TranslateToKey(guint16 group, guint16 element);
30 void SetVR(std::string);
33 * \ingroup gdcmDictEntry
34 * \brief tells if the V(alue) R(epresentation) is known (?!)
38 inline bool IsVRUnknown() {return vr == "??"; }
41 * \ingroup gdcmDictEntry
42 * \brief returns the Dicom Group Number of the current gdcmDictEntry
43 * return the Dicom Group Number
45 inline guint16 GetGroup(void) { return group; }
48 * \ingroup gdcmDictEntry
49 * \brief returns the Dicom Element Number of the current gdcmDictEntry
50 * return the Dicom Element Number
52 inline guint16 GetElement(void) { return element; }
55 * \ingroup gdcmDictEntry
56 * \brief returns the Dicom Value Representation of the current gdcmDictEntry
57 * return the Dicom Value Representation
59 inline std::string GetVR(void) { return vr; }
62 * \ingroup gdcmDictEntry
63 * \brief sets the key of the current gdcmDictEntry
64 * @param k New key to be set.
66 inline void SetKey(std::string k) { key = k; }
69 * \ingroup gdcmDictEntry
70 * \brief returns the Fourth field of the current gdcmDictEntry
71 * \warning NOT part of the Dicom Standard
72 * \ May be REMOVED an any time
74 * return the Fourth field
76 inline std::string GetFourth(void) { return fourth; }
79 * \ingroup gdcmDictEntry
80 * \brief returns the Dicom Name of the current gdcmDictEntry
81 * \ e.g. "Patient Name" for Dicom Tag (0x0010, 0x0010)
82 * return the Dicom Name
84 inline std::string GetName(void) { return name; }
87 * \ingroup gdcmDictEntry
88 * \brief Gets the key of the current gdcmDictEntry
91 inline std::string GetKey(void) { return key; }
94 // FIXME : were are the group and element used except from building up
95 // a TagKey. If the answer is nowhere then there is no need
96 // to store the group and element independently.
97 guint16 group; // e.g. 0x0010
98 guint16 element; // e.g. 0x0103
99 std::string vr; // Value Representation i.e. some clue about the nature
100 // of the data represented e.g. "FD" short for
101 // "Floating Point Double"
102 // CLEANME: find the official dicom name for this field !
103 std::string fourth; // Fourth field containing some semantics.
105 std::string name; // e.g. "Patient_Name"
106 TagKey key; // Redundant with (group, element) but we add it
107 // on efficiency purposes.
109 // DCMTK has many fields for handling a DictEntry (see below). What are the
110 // relevant ones for gdcmlib ?
111 // struct DBI_SimpleEntry {
112 // Uint16 upperGroup;
113 // Uint16 upperElement;
115 // const char* tagName;
118 // const char* standardVersion;
119 // DcmDictRangeRestriction groupRestriction;
120 // DcmDictRangeRestriction elementRestriction;
124 //-----------------------------------------------------------------------------