Doxygenation

[gdcm.git] / src / gdcmDictEntry.h

diff --git a/src/gdcmDictEntry.h b/src/gdcmDictEntry.h
index ab4b95f4827b8d96ea011eedc97e245e3e3d84e0..ac0250ee6695b99a4f37cb6172453b300a4c0b1e 100644 (file)
--- a/src/gdcmDictEntry.h
+++ b/src/gdcmDictEntry.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDictEntry.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/06 20:03:27 $
-  Version:   $Revision: 1.24 $
+  Date:      $Date: 2005/01/07 16:14:58 $
+  Version:   $Revision: 1.27 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -41,17 +41,22 @@ public:
    DictEntry(uint16_t group, 
              uint16_t element,
              TagName const &vr     = GDCM_UNKNOWN,
-             TagName const &fourth = GDCM_UNKNOWN,
+             TagName const &vm     = GDCM_UNKNOWN,
              TagName const &name   = GDCM_UNKNOWN);
 
    static TagKey TranslateToKey(uint16_t group, uint16_t element);
 
    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 == 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 DictEntry
    /// @return the Dicom Group Number
    uint16_t GetGroup() { return Group; }
@@ -69,11 +74,9 @@ public:
    /// @param k New key to be set.
    void SetKey(TagName const &k)  { Key = k; }
  
-   /// \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
-   const TagName &GetFourth() const { 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 DictEntry
    ///         e.g. "Patient Name" for Dicom Tag (0x0010, 0x0010) 
@@ -104,18 +107,9 @@ private:
    ///        "Floating Point Double" (see \ref VR)
    TagName VR;
 
-   /**
-    * \brief AVOID using the following fourth field at all costs.
-    * 
-    *  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.
+   /*
     *  .
-    *  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 
@@ -161,7 +155,8 @@ private:
     *  - LLO = Left  Lateral Oblique  
     *  .
     */
-   TagName Fourth; 
+  /// \brief Value Multiplicity (e.g. "1", "1-n", "6")
+   TagName VM; 
 
    /// e.g. "Patient's Name"                    
    TagName Name;