* Add usefull comments in Header

[gdcm.git] / src / gdcmVR.h

diff --git a/src/gdcmVR.h b/src/gdcmVR.h
index 3be7fa4c79ae2e8a8e80f0f63ef53c59df46dcc5..933e7f0f8bce82dac03c644b100439a492cb4321 100644 (file)
--- a/src/gdcmVR.h
+++ b/src/gdcmVR.h
@@ -1,28 +1,58 @@
-// gdcmVR.h
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmVR.h,v $
+  Language:  C++
+  Date:      $Date: 2004/10/28 03:10:58 $
+  Version:   $Revision: 1.14 $
+                                                                                
+  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 GDCMVR_H
 #define GDCMVR_H
 
+#include "gdcmCommon.h"
 #include <map>
 #include <string>
-#include "gdcmCommon.h"
+#include <iostream>
 
-typedef string VRKey;
-typedef string VRAtr;
-typedef map<VRKey, VRAtr> VRHT;    // Value Representation Hash Table
+namespace gdcm 
+{
 
+//-----------------------------------------------------------------------------
+typedef std::string VRKey;
+typedef std::string VRAtr;
+/// Value Representation Hash Table
+typedef std::map<VRKey, VRAtr> VRHT;
+
+//-----------------------------------------------------------------------------
 /*
- * \defgroup gdcmVR
- * \brief  Container for dicom Value Representation Hash Table
+ * Container for dicom Value Representation Hash Table
  * \note   This is a singleton
  */
-class GDCM_EXPORT gdcmVR {
-private:
-   VRHT *dicom_vr;
+class GDCM_EXPORT VR 
+{
 public:
-       gdcmVR();
-   ~gdcmVR();
-   int Count(VRKey);
+   VR(void);
+   ~VR();
+
+   void Print(std::ostream &os = std::cout);
+   int Count(VRKey const & key);
+   bool IsVROfGdcmBinaryRepresentable(VRKey const & tested);
+   bool IsVROfGdcmStringRepresentable(VRKey const & tested);
+
+private:
+   VRHT vr;
 };
+} // end namespace gdcm
 
+//-----------------------------------------------------------------------------
 #endif