X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDictEntry.h;h=f78d4f076ad0004cce42d37bbcc9ced56de349e7;hb=2767ee200a3dc05314954bd8bb3a0427f3fcb7d9;hp=ac0250ee6695b99a4f37cb6172453b300a4c0b1e;hpb=51cbcb8520d5fcb26ea0ceec99f58b8db9692876;p=gdcm.git

diff --git a/src/gdcmDictEntry.h b/src/gdcmDictEntry.h
index ac0250ee..f78d4f07 100644
--- 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/07 16:14:58 $
-  Version:   $Revision: 1.27 $
+  Date:      $Date: 2005/01/20 11:39:49 $
+  Version:   $Revision: 1.31 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -25,27 +25,34 @@ namespace gdcm
 {
 
 //-----------------------------------------------------------------------------
-/*
- * \defgroup DictEntry
+/**
+ * \ingroup DictEntry
  * \brief
  * 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 DictEntry : public Base
 {
 public:
    DictEntry(uint16_t group, 
-             uint16_t element,
+             uint16_t elem,
              TagName const &vr     = GDCM_UNKNOWN,
              TagName const &vm     = GDCM_UNKNOWN,
              TagName const &name   = GDCM_UNKNOWN);
 
-   static TagKey TranslateToKey(uint16_t group, uint16_t element);
+// Print
+   void Print(std::ostream &os = std::cout, std::string const &indent = "");
 
+// Key creation
+   static TagKey TranslateToKey(uint16_t group, uint16_t elem);
+
+// Content of DictEntry
    void SetVR(TagName const &vr);
    void SetVM(TagName const &vm);
 
@@ -89,9 +96,9 @@ public:
 
 private:
    /// \todo FIXME 
-   ///        where are the group and element used except from building up
+   ///        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 element independently.
+   ///        to store the group and elem independently.
    ///
    ///        --> EVERYWHERE ! The alternate question would be :
    ///                         What's TagKey used for ?
@@ -161,7 +168,7 @@ private:
    /// e.g. "Patient's Name"                    
    TagName Name;      
 
-   /// Redundant with (group, element) but we add it for efficiency purpose.
+   /// Redundant with (group, elem) but we add it for efficiency purpose.
    TagKey  Key;
 };
 } // end namespace gdcm