-// gdcmDictEntry.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmDictEntry.h,v $
+ Language: C++
+ Date: $Date: 2004/10/12 04:35:45 $
+ Version: $Revision: 1.18 $
+
+ 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.html for details.
+
+ This software is distributed WITHOUT ANY WARRANTY; without even
+ the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ PURPOSE. See the above copyright notices for more information.
+
+=========================================================================*/
+
#ifndef GDCMDICTENTRY_H
#define GDCMDICTENTRY_H
#include "gdcmCommon.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:
- gdcmDictEntry(guint16 group,
- guint16 element,
+ DictEntry(uint16_t group,
+ uint16_t element,
std::string vr = "Unknown",
std::string fourth = "Unknown",
std::string name = "Unknown");
-
- static TagKey TranslateToKey(guint16 group, guint16 element);
- void SetVR(std::string);
+ static TagKey TranslateToKey(uint16_t group, uint16_t element);
- /**
- * \ingroup gdcmDictEntry
- * \brief tells if the V(alue) R(epresentation) is known (?!)
- *
- * @return
- */
- inline bool IsVRUnknown() {return vr == "??"; }
+ void SetVR(std::string const & vr);
- /**
- * \ingroup gdcmDictEntry
- * \brief returns the Dicom Group Number of the current gdcmDictEntry
- * return the Dicom Group Number
- */
- inline guint16 GetGroup(void) { return group; }
+ /// \brief tells if the V(alue) R(epresentation) is known (?!)
+ /// @return
+ bool IsVRUnknown() { return VR == "??"; }
+
+ /// \brief Returns the Dicom Group Number of the current DictEntry
+ /// @return the Dicom Group Number
+ uint16_t GetGroup() { return Group; }
- /**
- * \ingroup gdcmDictEntry
- * \brief returns the Dicom Element Number of the current gdcmDictEntry
- * return the Dicom Element Number
- */
- inline guint16 GetElement(void) { return element; }
+ /// \brief Returns the Dicom Element Number of the current DictEntry
+ /// @return the Dicom Element Number
+ uint16_t GetElement() { return Element; }
- /**
- * \ingroup gdcmDictEntry
- * \brief returns the Dicom Value Representation of the current gdcmDictEntry
- * return the Dicom Value Representation
- */
- inline std::string GetVR(void) { return vr; }
+ /// \brief Returns the Dicom Value Representation of the current
+ /// DictEntry
+ /// @return the Dicom Value Representation
+ std::string GetVR() { return VR; }
- /**
- * \ingroup gdcmDictEntry
- * \brief sets the key of the current gdcmDictEntry
- * @param k New key to be set.
- */
- inline void SetKey(std::string k) { key = k; }
+ /// \brief sets the key of the current DictEntry
+ /// @param k New key to be set.
+ void SetKey(std::string const & k) { Key = k; }
- /**
- * \ingroup gdcmDictEntry
- * \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
- */
- inline std::string GetFourth(void) { return fourth; }
+ /// \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() { return Fourth; }
- /**
- * \ingroup gdcmDictEntry
- * \brief returns the Dicom Name of the current gdcmDictEntry
- * \ e.g. "Patient Name" for Dicom Tag (0x0010, 0x0010)
- * return the Dicom Name
- */
- inline std::string GetName(void) { return name; }
+ /// \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() { return Name; }
- /**
- * \ingroup gdcmDictEntry
- * \brief Gets the key of the current gdcmDictEntry
- * @return the key .
- */
- inline std::string GetKey(void) { return key; }
+ /// \brief Gets the key of the current DictEntry
+ /// @return the key.
+ std::string GetKey() { return Key; }
private:
- // FIXME : where are the group and element used except from building up
- // 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 TagKey used for ?
+ /// \todo FIXME
+ /// where are the group and element used except from building up
+ /// 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 TagKey used for ?
/// DicomGroup number
- guint16 group; // e.g. 0x0010
+ uint16_t Group; // e.g. 0x0010
+
/// DicomElement number
- guint16 element; // e.g. 0x0103
- /**
- * \ingroup gdcmDictEntry
- * \brief Value Representation i.e. some clue about the nature
- * of the data represented
- * e.g. "FD" short for "Floating Point Double"
- */
- std::string vr;
-
+ 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 VR)
+ std::string 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;
+ std::string Fourth;
/// e.g. "Patient's Name"
- std::string name;
+ std::string Name;
- /// Redundant with (group, element) but we add it on efficiency purposes.
- TagKey key;
-
- // DCMTK has many fields for handling a DictEntry (see below). What are the
- // relevant ones for gdcmlib ?
- // struct DBI_SimpleEntry {
- // Uint16 upperGroup;
- // Uint16 upperElement;
- // DcmEVR evr;
- // const char* tagName;
- // int vmMin;
- // int vmMax;
- // const char* standardVersion;
- // DcmDictRangeRestriction groupRestriction;
- // DcmDictRangeRestriction elementRestriction;
- // };
+ /// Redundant with (group, element) but we add it for efficiency purpose.
+ TagKey Key;
};
-
+} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff