Coding Style + Doxygenation

[gdcm.git] / src / gdcmValEntry.h

diff --git a/src/gdcmValEntry.h b/src/gdcmValEntry.h
index 9a5912ba1e5cc739e5073fa67ebeb0cdff912f47..fa2aec8fb1cd4a071a43133433985ba7aec7e295 100644 (file)
--- a/src/gdcmValEntry.h
+++ b/src/gdcmValEntry.h
@@ -1,52 +1,69 @@
-// gdcmValEntry.h
-//-----------------------------------------------------------------------------
-#ifndef GDCMValEntry_H
-#define GDCMValEntry_H
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmValEntry.h,v $
+  Language:  C++
+  Date:      $Date: 2005/01/06 20:03:28 $
+  Version:   $Revision: 1.34 $
+                                                                                
+  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.html 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.
+                                                                                
+=========================================================================*/
 
-#include <iostream>
-#include <stdio.h>
+#ifndef GDCMVALENTRY_H
+#define GDCMVALENTRY_H
 
 #include "gdcmDocEntry.h"
 
+#include <iostream>
+
+namespace gdcm 
+{
 //-----------------------------------------------------------------------------
 /**
- * \ingroup gdcmValEntry
+ * \ingroup ValEntry
  * \brief   The dicom header of a Dicom file contains a set of such entries
  *          (when successfuly parsed against a given Dicom dictionary)
  */
-class GDCM_EXPORT gdcmValEntry  : public gdcmDocEntry {
-
+class GDCM_EXPORT ValEntry  : public DocEntry
+{
 public:
-
-   gdcmValEntry(gdcmDictEntry* e);
-       gdcmValEntry(gdcmDocEntry* d); 
-   ~gdcmValEntry(void);
+   ValEntry(DictEntry *e);
+   ValEntry(DocEntry *d); 
+   ~ValEntry();
 
    /// \brief Returns the 'Value' (e.g. "Dupond Marcel") converted into a
-   /// 'string', if it's stored as an integer in the header of the
+   /// 'string', event if it's stored as an integer in the header of the
    /// current Dicom Document Entry
-   inline std::string  GetValue(void)     { return value; };
+   std::string const &GetValue() const { return Value; };
     
-   /// Sets the value (string) of the current Dicom Document Entry
-   inline void SetValue(std::string val)  { value = val;  };
-   
+   /// Sets the value (string) of the current Dicom Document Entry.
+   /// The size is updated
+   virtual void SetValue(std::string const &val);
+
    virtual void Print(std::ostream &os = std::cout); 
-           
-protected:
 
-   /// \brief for 'non string' values. Will be move to gdcmBinEntry, later
-       void* voidArea;  // clean it out later
+   virtual void WriteContent(std::ofstream *fp, FileType filetype);
+
+protected:
+   /// Sets the value (string) of the current Dicom Document Entry
+   void SetValueOnly(std::string const &val) { Value = val; }; 
    
 private:
-
-// Variables
+// Members :
   
-   /// \brief Document Entry value, stored 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 VR) is independently used
+   ///        in order to interpret (decode) this field.
+   std::string Value;
 };
+} // end namespace gdcm
 
 //-----------------------------------------------------------------------------
 #endif