ENH: Minor tweak so that user find documentation easily

[gdcm.git] / src / gdcmValEntry.h

diff --git a/src/gdcmValEntry.h b/src/gdcmValEntry.h
index 132fe262a5cf231976cb91762d9d74e18da6d48b..4abc7eff65faf86ac98fe9d291fe4d64663c9b7b 100644 (file)
--- a/src/gdcmValEntry.h
+++ b/src/gdcmValEntry.h
@@ -1,51 +1,62 @@
-// gdcmValEntry.h
-//-----------------------------------------------------------------------------
-#ifndef GDCMValEntry_H
-#define GDCMValEntry_H
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmValEntry.h,v $
+  Language:  C++
+  Date:      $Date: 2004/09/13 12:10:53 $
+  Version:   $Revision: 1.22 $
+                                                                                
+  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.htm 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 GDCMVALENTRY_H
+#define GDCMVALENTRY_H
 
 #include <iostream>
 #include <stdio.h>
 
 #include "gdcmDocEntry.h"
+
 //-----------------------------------------------------------------------------
 /**
- * \ingroup gdcmBinEntry
+ * \ingroup gdcmValEntry
  * \brief   The dicom header of a Dicom file contains a set of such entries
  *          (when successfuly parsed against a given Dicom dictionary)
- *          This one contains a 'non string' value
  */
-class GDCM_EXPORT gdcmValEntry  : public gdcmDocEntry {
-
+class GDCM_EXPORT gdcmValEntry  : public gdcmDocEntry
+{
 public:
-
-
-   gdcmValEntry(void); 
-   ~gdcmValEntry(void);
+   gdcmValEntry(gdcmDictEntry* e);
+   gdcmValEntry(gdcmDocEntry* d); 
+   virtual ~gdcmValEntry();
 
    /// \brief Returns the 'Value' (e.g. "Dupond Marcel") converted into a
-   /// 'string', if it's stored as an integer in the Dicom Header of the
-   /// current Dicom Header Entry
-   inline std::string  GetValue(void)     { return value; };
+   /// 'string', if it's stored as an integer in the header of the
+   /// current Dicom Document Entry
+   std::string GetValue() { return Value; };
     
-   /// Sets the value (string) of the current Dicom Header Entry
-   inline void SetValue(std::string val)  { value = val;  };
-         
-protected:
+   /// Sets the value (string) of the current Dicom Document Entry
+   void SetValue(std::string const & val) { Value = val; };
 
-private:
+   virtual void Print(std::ostream &os = std::cout); 
+   virtual void Write(FILE *fp, FileType filetype);
 
-// Variables
+protected:
+   
+private:
+// Members :
   
-   /// \brief Header Entry value, stores as a std::string (VR will be used,
-   /// later, to decode)
-   std::string  value;
-
-
-
-
-
-
-
+   /// \brief Document Entry value, internaly represented as a std::string
+   ///        The Value Representation (\ref gdcmVR) is independently used
+   ///        in order to interpret (decode) this field.
+   std::string  Value;
 };
 
 //-----------------------------------------------------------------------------