Doxygenation.

[gdcm.git] / src / gdcmDicomDirElement.cxx

diff --git a/src/gdcmDicomDirElement.cxx b/src/gdcmDicomDirElement.cxx
index cc83188dd8e4926c0d731f44611de96b9954cfbe..f0f82ed195fe3a2e061f6142ee1c146d7db4b331 100644 (file)
--- a/src/gdcmDicomDirElement.cxx
+++ b/src/gdcmDicomDirElement.cxx
@@ -1,27 +1,29 @@
 // gdcmDicomDirElement.cxx
 //-----------------------------------------------------------------------------
 #include <fstream>
+#include <stdio.h>    // For sprintf
+#include <iostream>
 
 #include "gdcmDicomDirElement.h"
 #include "gdcmUtil.h"
+#include "gdcmDebug.h"
+#include "gdcmDictSet.h"
 
-#ifndef PUB_DICT_PATH
-#  define PUB_DICT_PATH     "../Dicts/"
-#endif
-#define DICT_ELEM "DicomDir.dic"
-
-#include <iostream>
-#ifdef GDCM_NO_ANSI_STRING_STREAM
-#  include <strstream>
-#  define  ostringstream ostrstream
-# else
-#  include <sstream>
-#endif
 
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   Class for the chained lists from the file 'Dicts/DicomDir.dic'
+ */
+ 
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
-gdcmDicomDirElement::gdcmDicomDirElement(void) 
-{
+
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   constructor : populates the chained lists 
+ *          from the file 'Dicts/DicomDir.dic'
+ */
+ gdcmDicomDirElement::gdcmDicomDirElement(void) {
    std::string filename=gdcmDictSet::BuildDictPath() + std::string(DICT_ELEM);
    std::ifstream from(filename.c_str());
    dbg.Error(!from, "gdcmDicomDirElement::gdcmDicomDirElement: can't open dictionary",filename.c_str());
@@ -35,8 +37,8 @@ gdcmDicomDirElement::gdcmDicomDirElement(void)
       from.getline(buff, 1024, ' ');
       type = buff;
 
-      if( (type=="metaElem") || (type=="patientElem") || 
-          (type=="studyElem") || (type=="serieElem") || 
+      if( (type=="metaElem")  || (type=="patientElem") || 
+          (type=="studyElem") || (type=="serieElem")   || 
           (type=="imageElem") )
       {
          from >> std::hex >> elem.group >> elem.elem;
@@ -48,74 +50,76 @@ gdcmDicomDirElement::gdcmDicomDirElement(void)
          elem.value = buff;
 
          if(type=="metaElem")
-            MetaList.push_back(elem);
+             DicomDirMetaList.push_back(elem);
          else if(type=="patientElem")
-            PatientList.push_back(elem);
+            DicomDirPatientList.push_back(elem);
          else if(type=="studyElem")
-            StudyList.push_back(elem);
+            DicomDirStudyList.push_back(elem);
          else if(type=="serieElem")
-            SerieList.push_back(elem);
+            DicomDirSerieList.push_back(elem);
          else if(type=="imageElem")
-            ImageList.push_back(elem);
+            DicomDirImageList.push_back(elem);
       }
-
       from.getline(buff, 1024, '\n');
    }
    from.close();
 }
 
-gdcmDicomDirElement::~gdcmDicomDirElement() 
-{
-   MetaList.clear();
-   PatientList.clear();
-   StudyList.clear();
-   SerieList.clear();
-   ImageList.clear();
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   canonical destructor 
+ */
+ gdcmDicomDirElement::~gdcmDicomDirElement() {
+   DicomDirMetaList.clear();
+   DicomDirPatientList.clear();
+   DicomDirStudyList.clear();
+   DicomDirSerieList.clear();
+   DicomDirImageList.clear();
 }
 
 //-----------------------------------------------------------------------------
 // Print
 /**
- * \ingroup gdcmVR
- * \brief   Print all 
+ * \ingroup gdcmDicomDirElement
+ * \brief   Print all
+ * \todo add a 'Print Level' check 
  * @param   os The output stream to be written to.
  */
-void gdcmDicomDirElement::Print(std::ostream &os) 
-{
+void gdcmDicomDirElement::Print(std::ostream &os) {
    std::ostringstream s;
    std::list<gdcmElement>::iterator it;
    char greltag[10];  //group element tag
 
    s << "Meta Elements :"<<std::endl;
-   for (it = MetaList.begin();it!=MetaList.end();++it)
+   for (it = DicomDirMetaList.begin();it!=DicomDirMetaList.end();++it)
    {
       sprintf(greltag,"%04x|%04x ",it->group,it->elem);
       s << "   ("<<greltag<<") = "<< it->value<<std::endl;
    }
 
    s << "Patient Elements :"<<std::endl;
-   for (it = PatientList.begin();it!=PatientList.end();++it)
+   for (it = DicomDirPatientList.begin();it!=DicomDirPatientList.end();++it)
    {
       sprintf(greltag,"%04x|%04x ",it->group,it->elem);
       s << "   ("<<greltag<<") = "<< it->value<<std::endl;
    }
 
    s << "Study Elements :"<<std::endl;
-   for (it = StudyList.begin();it!=StudyList.end();++it)
+   for (it = DicomDirStudyList.begin();it!=DicomDirStudyList.end();++it)
    {
       sprintf(greltag,"%04x|%04x ",it->group,it->elem);
       s << "   ("<<greltag<<") = "<< it->value<<std::endl;
    }
 
    s << "Serie Elements :"<<std::endl;
-   for (it = SerieList.begin();it!=SerieList.end();++it)
+   for (it = DicomDirSerieList.begin();it!=DicomDirSerieList.end();++it)
    {
       sprintf(greltag,"%04x|%04x ",it->group,it->elem);
       s << "   ("<<greltag<<") = "<< it->value<<std::endl;
    }
 
    s << "Image Elements :"<<std::endl;
-   for (it = ImageList.begin();it!=ImageList.end();++it)
+   for (it = DicomDirImageList.begin();it!=DicomDirImageList.end();++it)
    {
       sprintf(greltag,"%04x|%04x ",it->group,it->elem);
       s << "   ("<<greltag<<") = "<< it->value<<std::endl;