Coding Style + Doxygenation

[gdcm.git] / src / gdcmBinEntry.h

diff --git a/src/gdcmBinEntry.h b/src/gdcmBinEntry.h
index 76569f538ea14bf74ce432f776209131558b2f87..c0ff6fdb06be6887f4030b8d037a872e20fa3ec9 100644 (file)
--- a/src/gdcmBinEntry.h
+++ b/src/gdcmBinEntry.h
@@ -1,42 +1,62 @@
-// gdcmBinEntry.h
-//-----------------------------------------------------------------------------
-#ifndef GDCMBinEntry_H
-#define GDCMBinEntry_H
-
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmBinEntry.h,v $
+  Language:  C++
+  Date:      $Date: 2005/01/06 20:03:26 $
+  Version:   $Revision: 1.29 $
+                                                                                
+  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.
+                                                                                
+=========================================================================*/
+
+#ifndef GDCMBINENTRY_H
+#define GDCMBINENTRY_H
+
+#include "gdcmValEntry.h"
 #include <iostream>
-#include <stdio.h>
+
+namespace gdcm 
+{
 
 //-----------------------------------------------------------------------------
 /**
- * \ingroup gdcmBinEntry
+ * \ingroup BinEntry
  * \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 'string value'.
  */
-class GDCM_EXPORT gdcmBinEntry  : public gdcmValEntry {
-
+class GDCM_EXPORT BinEntry  : public ValEntry
+{
 public:
+   BinEntry( DictEntry *e );
+   BinEntry( DocEntry *d ); 
 
-protected:
-
-private:
-
-// Variables
-
+   ~BinEntry();
    
-   /// \brief unsecure memory area to hold 'non string' values 
-   /// (ie : Lookup Tables, overlays, icons)   
-   void *voidArea;
-
-
-
-
-
-
+   void Print( std::ostream &os = std::cout );
+   void WriteContent( std::ofstream *fp, FileType ft);
 
+   /// \brief Returns the area value of the current Dicom Header Entry
+   ///  when it's not string-translatable (e.g : a LUT table)         
+   uint8_t *GetBinArea()  { return BinArea; }
+   void  SetBinArea( uint8_t *area, bool self = true );
 
+   /// Sets the value (string) of the current Dicom Document Entry
+   virtual void SetValue(std::string const &val) { SetValueOnly(val); };
+private:
+   /// \brief unsecure memory area to hold 'non string' values 
+   ///       (ie : Lookup Tables, overlays, icons)   
+   uint8_t *BinArea;
+   bool SelfArea;
 };
-
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif