ENH: Some cosmetic cleanup of gdcmFile, main changes are: lgrTotal -> ImageDataSize...

[gdcm.git] / src / gdcmVR.cxx

diff --git a/src/gdcmVR.cxx b/src/gdcmVR.cxx
index 3d2ea9c2deb7fd3a4002446e611f27c286f42805..dbe4d2d5f109ccd79e5afc26bce7f7b0d74ea5c4 100644 (file)
--- a/src/gdcmVR.cxx
+++ b/src/gdcmVR.cxx
@@ -1,15 +1,36 @@
-// gdcmVR.cxx
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmVR.cxx,v $
+  Language:  C++
+  Date:      $Date: 2004/06/20 18:08:48 $
+  Version:   $Revision: 1.13 $
+                                                                                
+  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.
+                                                                                
+=========================================================================*/
+
 #include <fstream>
 
+#include <iostream>
+
 #include "gdcmVR.h"
 #include "gdcmUtil.h"
+#include "gdcmDictSet.h"
+#include "gdcmDebug.h"
 
-#ifndef PUB_DICT_PATH
-#  define PUB_DICT_PATH     "../Dicts/"
-#endif
-#define DICT_VR "dicomVR.dic"
-
-gdcmVR::gdcmVR(void) {
+//-----------------------------------------------------------------------------
+/**
+ * \brief Constructor
+ */
+gdcmVR::gdcmVR(void) 
+{
    std::string filename=gdcmDictSet::BuildDictPath() + std::string(DICT_VR);
    std::ifstream from(filename.c_str());
    dbg.Error(!from, "gdcmVR::gdcmVR: can't open dictionary",filename.c_str());
@@ -18,7 +39,8 @@ gdcmVR::gdcmVR(void) {
    std::string key;
    std::string name;
 
-   while (!from.eof()) {
+   while (!from.eof()) 
+   {
       eatwhite(from);
       from.getline(buff, 1024, ' ');
       key = buff;
@@ -37,10 +59,94 @@ gdcmVR::gdcmVR(void) {
    from.close();
 }
 
+/**
+ * \brief Destructor
+ */
 gdcmVR::~gdcmVR() {
    vr.clear();
 }
 
-int gdcmVR::Count(VRKey key) {
+//-----------------------------------------------------------------------------
+// Print
+/**
+ * \brief   Print all 
+ * @param   os The output stream to be written to.
+ */
+void gdcmVR::Print(std::ostream &os) 
+{
+   std::ostringstream s;
+
+   for (VRHT::iterator it = vr.begin(); it != vr.end(); ++it)
+   {
+      s << "VR : "<<it->first<<" = "<<it->second<<std::endl;
+   }
+   os << s.str();
+}
+
+//-----------------------------------------------------------------------------
+// Public
+/**
+ * \brief   Get the count for an element
+ * @param   key key to count
+ */
+int gdcmVR::Count(VRKey key) 
+{
    return vr.count(key);
 }
+
+/**
+ * \brief   Simple predicate that checks wether the given argument
+ *          corresponds to the Value Representation of a \ref gdcmBinEntry .
+ *          This predicate is the negation of
+ *          \ref gdcmVR::IsVROfGdcmStringRepresentable .
+ * @param   tested value represenation to check for.
+ */
+bool gdcmVR::IsVROfGdcmBinaryRepresentable(VRKey tested)
+{
+   if ( ! Count(tested) )
+   {
+      dbg.Verbose(0, "gdcmVR::IsVROfGdcmBinaryRepresentable: tested not a VR!");
+      return false;
+   }
+
+   if ( IsVROfGdcmStringRepresentable(tested) )
+   {
+      dbg.Verbose(0, "gdcmVR::IsVROfGdcmBinaryRepresentable: binary VR !");
+      return false;
+   }
+
+   return true;
+}
+
+/**
+ * \brief   Simple predicate that checks wether the given argument
+ *          corresponds to the Value Representation of a \ref gdcmValEntry
+ *          but NOT a \ref gdcmBinEntry.
+ * @param   tested value represenation to check for.
+ */
+bool gdcmVR::IsVROfGdcmStringRepresentable(VRKey tested)
+{
+   if ( ! Count(tested) )
+   {
+      dbg.Verbose(0, "gdcmVR::IsVROfGdcmStringRepresentable: tested not a VR!");
+      return false;
+   }
+
+   if (tested == "AE" || tested == "AS" || tested == "DA" || tested == "PN" ||
+       tested == "UI" || tested == "TM" || tested == "SH" || tested == "LO" ||
+       tested == "CS" || tested == "IS" || tested == "LO" || tested == "LT" ||
+       tested == "SH" || tested == "ST" || tested == "DS" || tested == "SL" ||
+       tested == "SS" || tested == "UL" || tested == "US" )
+   {
+      return true;
+   }
+   return false;
+}
+
+//-----------------------------------------------------------------------------
+// Protected
+
+//-----------------------------------------------------------------------------
+// Private
+
+//-----------------------------------------------------------------------------