X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDictEntry.h;h=780c7afd6b2f64977cc800df6124f4b53f176fbe;hb=8ba6105c39056bba295025f4b46d2cdf24dab792;hp=5a2e8a07440e6e7d5d0d928ae148a7e91e84e726;hpb=fd37aa842b5d31ca266b6bda8a77f3201d02338d;p=gdcm.git diff --git a/src/gdcmDictEntry.h b/src/gdcmDictEntry.h index 5a2e8a07..780c7afd 100644 --- a/src/gdcmDictEntry.h +++ b/src/gdcmDictEntry.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDictEntry.h,v $ Language: C++ - Date: $Date: 2004/09/27 08:39:06 $ - Version: $Revision: 1.16 $ + Date: $Date: 2005/07/11 14:40:40 $ + Version: $Revision: 1.35 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -19,100 +19,104 @@ #ifndef GDCMDICTENTRY_H #define GDCMDICTENTRY_H -#include "gdcmCommon.h" +#include "gdcmBase.h" + +namespace gdcm +{ //----------------------------------------------------------------------------- -/* - * \defgroup gdcmDictEntry +/** * \brief - * the gdcmDictEntry in an element contained by the gdcmDict. + * the DictEntry in an element contained by the Dict. * It contains : * - the key referenced by the DICOM norm or the constructor (for private keys) - * - the corresponding name in english (it's equivalent to a label) - * - the owner group - * - etc. + * i.e. the Group number + * the Element number + * - the VR (Value Representation) + * - the VM (Value Multplicity) + * - the corresponding name in english */ -class GDCM_EXPORT gdcmDictEntry +class GDCM_EXPORT DictEntry : public Base { public: - gdcmDictEntry(uint16_t group, - uint16_t element, - std::string vr = "Unknown", - std::string fourth = "Unknown", - std::string name = "Unknown"); + DictEntry(uint16_t group, + uint16_t elem, + TagName const &vr = GDCM_UNKNOWN, + TagName const &vm = GDCM_UNKNOWN, + TagName const &name = GDCM_UNKNOWN); - static gdcmTagKey TranslateToKey(uint16_t group, uint16_t element); +// Print + void Print(std::ostream &os = std::cout, std::string const &indent = ""); - void SetVR(std::string); +// Content of DictEntry + void SetVR(TagName const &vr); + void SetVM(TagName const &vm); /// \brief tells if the V(alue) R(epresentation) is known (?!) /// @return - bool IsVRUnknown() {return vr == "??"; } + bool IsVRUnknown() { return VR == GDCM_UNKNOWN; } + + /// \brief tells if the V(alue) M(ultiplicity) is known (?!) + /// @return + bool IsVMUnknown() { return VM == GDCM_UNKNOWN; } - /// \brief Returns the Dicom Group Number of the current gdcmDictEntry + /// \brief Returns the Dicom Group Number of the current DictEntry /// @return the Dicom Group Number - uint16_t GetGroup() { return group; } + uint16_t GetGroup() { return Group; } - /// \brief Returns the Dicom Element Number of the current gdcmDictEntry + /// \brief Returns the Dicom Element Number of the current DictEntry /// @return the Dicom Element Number - uint16_t GetElement() { return element; } + uint16_t GetElement() { return Element; } /// \brief Returns the Dicom Value Representation of the current - /// gdcmDictEntry + /// DictEntry /// @return the Dicom Value Representation - std::string GetVR() { return vr; } + const TagName &GetVR() const { return VR; } - /// \brief sets the key of the current gdcmDictEntry + /// \brief sets the key of the current DictEntry /// @param k New key to be set. - void SetKey(std::string k) { key = k; } + void SetKey(TagKey const &k) { Key = k; } - /// \brief returns the Fourth field of the current gdcmDictEntry - /// \warning NOT part of the Dicom Standard. - /// May be REMOVED an any time. NEVER use it. - /// @return The Fourth field - std::string GetFourth(void) { return fourth; } + /// \brief returns the VM field of the current DictEntry + /// @return The 'Value Multiplicity' field + const TagName &GetVM() const { return VM; } - /// \brief Returns the Dicom Name of the current gdcmDictEntry + /// \brief Returns the Dicom Name of the current DictEntry /// e.g. "Patient Name" for Dicom Tag (0x0010, 0x0010) /// @return the Dicom Name - std::string GetName(void) { return name; } + const TagName &GetName() const { return Name; } - /// \brief Gets the key of the current gdcmDictEntry + /// \brief Gets the key of the current DictEntry /// @return the key. - std::string GetKey(void) { return key; } + const TagKey &GetKey() const { return Key; } + +// Key creation + static TagKey TranslateToKey(uint16_t group, uint16_t elem); private: /// \todo FIXME - /// where are the group and element used except from building up - /// a gdcmTagKey. If the answer is nowhere then there is no need - /// to store the group and element independently. + /// where are the group and elem used except from building up + /// a TagKey. If the answer is nowhere then there is no need + /// to store the group and elem independently. /// /// --> EVERYWHERE ! The alternate question would be : - /// What's gdcmTagKey used for ? + /// What's TagKey used for ? /// DicomGroup number - uint16_t group; // e.g. 0x0010 + uint16_t Group; // e.g. 0x0010 /// DicomElement number - uint16_t element; // e.g. 0x0103 + uint16_t Element; // e.g. 0x0103 /// \brief Value Representation i.e. some clue about the nature - /// of the data represented e.g. "FD" short for - /// "Floating Point Double" (see \ref gdcmVR) - std::string vr; - - /** - * \brief AVOID using the following fourth field at all costs. - * - * They are at leat two good reasons for NOT using fourth: - * - the main reason is that it is NOT part of the 'official' - * Dicom Dictionnary. - * - a second reason is that it is not defined for all the groups. + /// of the data represented e.g. + /// "FD" short for "Floating Point Double"(see \ref VR) + /// "PN" short for "Person Name" + TagName VR; + + /* * . - * Still it provides some semantics as group name abbreviation that - * can prove of some help when organizing things in an interface. - * For the time being we keep it in gdcm but it migth be removed in - * future releases it proves to be source of confusion. + * Formerly 'Group name abbreviations' * Here is a small dictionary we encountered in "nature": * - CMD Command * - META Meta Information @@ -158,14 +162,15 @@ private: * - LLO = Left Lateral Oblique * . */ - std::string fourth; + /// \brief Value Multiplicity (e.g. "1", "1-n", "6") + TagName VM; /// e.g. "Patient's Name" - std::string name; + TagName Name; - /// Redundant with (group, element) but we add it on efficiency purposes. - gdcmTagKey key; + /// Redundant with (group, elem) but we add it for efficiency purpose. + TagKey Key; }; - +} // end namespace gdcm //----------------------------------------------------------------------------- #endif