]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomEntry.h
Fix mistypings
[gdcm.git] / src / gdcmDicomEntry.h
index 7149fff539dbe43ddff2c97ecf39c7863fcc6bdf..090801d10d0b6a1158c82f6c9ee101387918b4bd 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomEntry.h,v $
   Language:  C++
-  Date:      $Date: 2005/10/21 12:12:55 $
-  Version:   $Revision: 1.5 $
+  Date:      $Date: 2007/09/17 12:21:56 $
+  Version:   $Revision: 1.14 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
                                                                                 
 =========================================================================*/
 
-#ifndef GDCMDICOMENTRY_H
-#define GDCMDICOMENTRY_H
+#ifndef _GDCMDICOMENTRY_H_
+#define _GDCMDICOMENTRY_H_
 
 #include "gdcmCommon.h"
 #include "gdcmRefCounter.h"
 #include "gdcmVRKey.h"
 #include "gdcmTagKey.h"
 
-namespace gdcm 
+namespace GDCM_NAME_SPACE
 {
 //-----------------------------------------------------------------------------
 /**
  * \brief
- * the DicomEntry in an element contained by the Dict.
+ * a DicomEntry is an element contained by the Dict.
  * It contains :
- *  - the key referenced by the DICOM norm or the constructor (for private keys)
- *    i.e. the Group number
- *         the Element number
+ *  - the key referenced by the DICOM norm or the manufacturer(for private keys)
+ *    i.e. 
+ *    - - the Group number
+ *    - - the Element number
  *  - the VR (Value Representation)
  *  - the VM (Value Multiplicity)
  *  - the corresponding name in english
  */
 class GDCM_EXPORT DicomEntry : public RefCounter
 {
-   gdcmTypeMacro(DicomEntry)
+   gdcmTypeMacro(DicomEntry);
 
 public:
 // Print
@@ -54,6 +55,10 @@ public:
    /// @return the Dicom Element Number
    const uint16_t &GetElement() const { return Tag[1]; }
 
+   /// \brief  Returns the Dicom Tag Key
+   /// @return the Dicom Tag Key
+   const TagKey &GetKey() const { return Tag; }
+   
    /// \brief  Set the Dicom Value Representation 
    /// \param vr the Dicom Value Representation
    virtual void SetVR(VRKey const &vr) { VR = vr; }
@@ -67,7 +72,8 @@ public:
    const TagKey &GetKey() const { return Tag; }
 
 // Key creation
-   static TagKey TranslateToKey(uint16_t group, uint16_t elem);
+   static TagKey TranslateToKey(uint16_t group, uint16_t elem)
+                                { return TagKey(group,elem); }
 
 protected:
    DicomEntry(const uint16_t &group,const uint16_t &elt,
@@ -75,13 +81,13 @@ protected:
    ~DicomEntry();
 
 private:
-   /// Dicom \ref TagKey. Contains DicomGroup number and DicomElement number
+   /// Dicom  TagKey. Contains Dicom Group number and Dicom Element number
    TagKey Tag;
 
    /// \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)
-   ///        "PN" short for "Person Name"       
+   ///        - "FD" short for "Floating Point Double"(see  VR)
+   ///        "PN" short for "Person Name"       
    VRKey VR;
 };
 } // end namespace gdcm