X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDictEntry.cxx;h=da623a2ef1dd79b6226bd3e1edb6e76e40e441ea;hb=cecf8a0bb86a9b3223a9d02d1106a564aa6ef7f9;hp=152e6d090d03a3a19c18e60652e238bca3c7ad0a;hpb=3e78befc911eac2ecc70747854911d1f803797b5;p=gdcm.git

diff --git a/src/gdcmDictEntry.cxx b/src/gdcmDictEntry.cxx
index 152e6d09..da623a2e 100644
--- a/src/gdcmDictEntry.cxx
+++ b/src/gdcmDictEntry.cxx
@@ -1,25 +1,52 @@
 // gdcmDictEntry.cxx
+//-----------------------------------------------------------------------------
+#include "gdcmDictEntry.h"
+#include "gdcmDebug.h"
 
 #include <stdio.h>    // FIXME For sprintf
-#include "gdcmDictEntry.h"
-#include "gdcmUtil.h"
 
+//-----------------------------------------------------------------------------
+// Constructor / Destructor
+/**
+ * \ingroup gdcmDictEntry
+ * \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,
-									  std::string  InVr, std::string InFourth,
-									  std::string  InName) {
-	group 		= InGroup;
-	element 	= InElement;
-	vr 		= InVr;
-	fourth 		= InFourth;
-	name 		= InName;
-	key 		= TranslateToKey(group, element);
+                             std::string  InVr, std::string InFourth,
+                             std::string  InName) {
+	group 	= InGroup;
+	element = InElement;
+	vr      = InVr;
+	fourth 	= InFourth;
+	name    = InName;
+	key     = TranslateToKey(group, element);
 }
 
+//-----------------------------------------------------------------------------
+// Print
+
+//-----------------------------------------------------------------------------
+// Public
+/**
+ * \ingroup gdcmDictEntry
+ * \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);
@@ -29,20 +56,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(std::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
+
+//-----------------------------------------------------------------------------
+