X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDictEntry.cxx;h=8001f2d990cb47604808c18b20593c7425f9522c;hb=b49d7069fe20162182a1840fd06afd3351f50b3d;hp=3e9b109e14cc6bc80bd31866554c08cbfb6357b1;hpb=55f3727f18aa712ea6d349de40b6a22ba2b6516d;p=gdcm.git

diff --git a/src/gdcmDictEntry.cxx b/src/gdcmDictEntry.cxx
index 3e9b109e..8001f2d9 100644
--- a/src/gdcmDictEntry.cxx
+++ b/src/gdcmDictEntry.cxx
@@ -1,23 +1,67 @@
-// gdcmDict.cxx
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDictEntry.cxx,v $
+  Language:  C++
+  Date:      $Date: 2004/06/20 18:08:47 $
+  Version:   $Revision: 1.21 $
+                                                                                
+  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"
+
+#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(guint16 InGroup, guint16 InElement,
-                             string  InVr, string InFourth, string InName) 
+                             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) {
+//-----------------------------------------------------------------------------
+// Print
+
+//-----------------------------------------------------------------------------
+// Public
+/**
+ * \brief   concatenates 2 guint16 (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
+ */
+TagKey gdcmDictEntry::TranslateToKey(guint16 group, guint16 element)
+{
 	char trash[10];
 	TagKey key;
-	// CLEAN ME: better call the iostream<< with the hex manipulator on.
+	// 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);
@@ -26,21 +70,26 @@ TagKey gdcmDictEntry::TranslateToKey(guint16 group, guint16 element) {
 }
 
 /**
- * \ingroup     gdcmDictEntry
- * \brief       If-and only if-the vr is unset then overwrite it.
- * @param NewVr New vr to be set.
+ * \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(string NewVr) {
-	if ( IsVrUnknown() )
+void gdcmDictEntry::SetVR(std::string NewVr) 
+{
+	if ( IsVRUnknown() )
 		vr = NewVr;
-	else {
+	else 
+   {
 		dbg.Error(true, "gdcmDictEntry::SetVR",
 		          "Overwriting vr might compromise a dictionary");
 	}
 }
 
-bool gdcmDictEntry::IsVrUnknown() {
-	if ( vr == "Unknown" )
-		return true;
-	return false;
-}
+//-----------------------------------------------------------------------------
+// Protected
+
+//-----------------------------------------------------------------------------
+// Private
+
+//-----------------------------------------------------------------------------
+