STYLE: Cleanup

[gdcm.git] / src / gdcmDictEntry.h

diff --git a/src/gdcmDictEntry.h b/src/gdcmDictEntry.h
index ac0250ee6695b99a4f37cb6172453b300a4c0b1e..780c7afd6b2f64977cc800df6124f4b53f176fbe 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/07 16:14:58 $
-  Version:   $Revision: 1.27 $
+  Date:      $Date: 2005/07/11 14:40:40 $
+  Version:   $Revision: 1.35 $
                                                                                 
   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,30 @@ namespace gdcm
 {
 
 //-----------------------------------------------------------------------------
-/*
- * \defgroup 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 = "");
 
+// Content of DictEntry
    void SetVR(TagName const &vr);
    void SetVM(TagName const &vm);
 
@@ -72,7 +75,7 @@ public:
  
    /// \brief   sets the key of the current DictEntry
    /// @param k New key to be set.
-   void SetKey(TagName const &k)  { Key = k; }
+   void SetKey(TagKey const &k)  { Key = k; }
  
    /// \brief   returns the VM field of the current DictEntry
    /// @return  The 'Value Multiplicity' field
@@ -85,13 +88,16 @@ public:
  
    /// \brief  Gets the key of the current DictEntry
    /// @return the key.
-   const TagName &GetKey() const { return Key; }
+   const TagKey &GetKey() const { return Key; }
+
+// Key creation
+   static TagKey TranslateToKey(uint16_t group, uint16_t elem);
 
 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 ?
@@ -103,8 +109,9 @@ private:
    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)
+   ///        of the data represented e.g. 
+   ///        "FD" short for "Floating Point Double"(see \ref VR)
+   ///        "PN" short for "Person Name"       
    TagName VR;
 
    /*
@@ -155,13 +162,13 @@ private:
     *  - LLO = Left  Lateral Oblique  
     *  .
     */
-  /// \brief Value Multiplicity (e.g. "1", "1-n", "6")
+   /// \brief Value Multiplicity (e.g. "1", "1-n", "6")
    TagName VM; 
 
    /// 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