Program: gdcm
Module: $RCSfile: gdcmDictEntry.h,v $
Language: C++
- Date: $Date: 2004/07/02 13:55:27 $
- Version: $Revision: 1.15 $
+ Date: $Date: 2005/01/05 15:38:28 $
+ Version: $Revision: 1.22 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
- http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+ http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
#ifndef GDCMDICTENTRY_H
#define GDCMDICTENTRY_H
-#include "gdcmCommon.h"
+#include "gdcmBase.h"
+
+namespace gdcm
+{
//-----------------------------------------------------------------------------
/*
- * \defgroup gdcmDictEntry
+ * \defgroup DictEntry
* \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.
*/
-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 element,
+ TagName const & vr = GDCM_UNKNOWN,
+ TagName const & fourth = GDCM_UNKNOWN,
+ TagName const & name = GDCM_UNKNOWN);
- static gdcmTagKey TranslateToKey(uint16_t group, uint16_t element);
+ static TagKey TranslateToKey(uint16_t group, uint16_t element);
- void SetVR(std::string);
+ void SetVR(TagName const & vr);
/// \brief tells if the V(alue) R(epresentation) is known (?!)
/// @return
- bool IsVRUnknown() {return vr == "??"; }
+ bool IsVRUnknown() { return VR == "??"; }
- /// \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(TagName const & k) { Key = k; }
- /// \brief returns the Fourth field of the current gdcmDictEntry
+ /// \brief returns the Fourth field of the current DictEntry
/// \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; }
+ const TagName & GetFourth() const { return Fourth; }
- /// \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 TagName & GetKey() const { return Key; }
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
+ /// a TagKey. If the answer is nowhere then there is no need
/// to store the group and element 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;
+ /// "Floating Point Double" (see \ref VR)
+ TagName VR;
/**
* \brief AVOID using the following fourth field at all costs.
*
- * They are at leat two good reasons for NOT using fourth:
+ * They are at least 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.
* - LLO = Left Lateral Oblique
* .
*/
- std::string fourth;
+ TagName Fourth;
/// 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, element) but we add it for efficiency purpose.
+ TagKey Key;
};
-
+} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif