ENH: Refactor some code

[gdcm.git] / src / gdcmDictEntry.cxx

diff --git a/src/gdcmDictEntry.cxx b/src/gdcmDictEntry.cxx
index 3e9b109e14cc6bc80bd31866554c08cbfb6357b1..bb4e748bd7b8e153ddf08c8434c9aaedf6f4f406 100644 (file)
--- a/src/gdcmDictEntry.cxx
+++ b/src/gdcmDictEntry.cxx
@@ -1,46 +1,95 @@
-// gdcmDict.cxx
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDictEntry.cxx,v $
+  Language:  C++
+  Date:      $Date: 2004/07/02 13:55:27 $
+  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.
+                                                                                
+=========================================================================*/
 
-#include "gdcm.h"
-#include "gdcmUtil.h"
+#include "gdcmDictEntry.h"
+#include "gdcmDebug.h"
 
-gdcmDictEntry::gdcmDictEntry(guint16 InGroup, guint16 InElement,
-                             string  InVr, string InFourth, string InName) 
+#include <stdio.h>    // FIXME For sprintf
+
+//-----------------------------------------------------------------------------
+// Constructor / Destructor
+/**
+ * \brief   Constructor
+ * @param   InGroup    DICOM-Group Number
+ * @param   InElement  DICOM-Element Number
+ * @param   InVr       Value Representatiion
+ * @param   InFourth  // DO NOT use any longer; 
+ *                       NOT part of the Dicom Standard
+ * @param   InName    description of the element
+*/
+
+gdcmDictEntry::gdcmDictEntry(uint16_t InGroup, uint16_t InElement,
+                             std::string  InVr, std::string InFourth,
+                             std::string  InName)
 {
-       group           = InGroup;
-       element         = InElement;
-       vr              = InVr;
-       fourth          = InFourth;
-       name            = InName;
-       key             = TranslateToKey(group, element);
+   group   = InGroup;
+   element = InElement;
+   vr      = InVr;
+   fourth  = InFourth;
+   name    = InName;
+   key     = TranslateToKey(group, element); /// \todo Frog MEMORY LEAK.
 }
 
-TagKey gdcmDictEntry::TranslateToKey(guint16 group, guint16 element) {
-       char trash[10];
-       TagKey key;
-       // CLEAN ME: better call the iostream<< with the hex manipulator on.
-       // This requires some reading of the stdlibC++ sources to make the
-       // proper call (or copy).
-       sprintf(trash, "%04x|%04x", group , element);
-       key = trash;  // Convertion through assignement
-       return key;
-}
+//-----------------------------------------------------------------------------
+// Print
 
+//-----------------------------------------------------------------------------
+// Public
 /**
- * \ingroup     gdcmDictEntry
- * \brief       If-and only if-the vr is unset then overwrite it.
- * @param NewVr New vr to be set.
+ * \brief   concatenates 2 uint16_t (supposed to be a Dicom group number 
+ *                                             and a Dicom element number)
+ * @param  group the Dicom group   number used to build the tag
+ * @param  element the Dicom element number used to build the tag
+ * @return the built tag
  */
-void gdcmDictEntry::SetVR(string NewVr) {
-       if ( IsVrUnknown() )
-               vr = NewVr;
-       else {
-               dbg.Error(true, "gdcmDictEntry::SetVR",
-                         "Overwriting vr might compromise a dictionary");
-       }
+gdcmTagKey gdcmDictEntry::TranslateToKey(uint16_t group, uint16_t element)
+{
+   char trash[10];
+   gdcmTagKey key;
+   // CLEANME: better call the iostream<< with the hex manipulator on.
+   // This requires some reading of the stdlibC++ sources to make the
+   // proper call (or copy).
+   sprintf(trash, "%04x|%04x", group , element);
+   key = trash;  // Convertion through assignement
+   return key;
 }
 
-bool gdcmDictEntry::IsVrUnknown() {
-       if ( vr == "Unknown" )
-               return true;
-       return false;
+/**
+ * \brief       If-and only if-the V(alue) R(epresentation)
+ * \            is unset then overwrite it.
+ * @param NewVr New V(alue) R(epresentation) to be set.
+ */
+void gdcmDictEntry::SetVR(std::string NewVr) 
+{
+   if ( IsVRUnknown() )
+      vr = NewVr;
+   else 
+   {
+      dbg.Error(true, "gdcmDictEntry::SetVR",
+                       "Overwriting vr might compromise a dictionary");
+   }
 }
+
+//-----------------------------------------------------------------------------
+// Protected
+
+//-----------------------------------------------------------------------------
+// Private
+
+//-----------------------------------------------------------------------------
+