ENH: Adding automatic testing

[gdcm.git] / src / gdcmDicomDirElement.h

diff --git a/src/gdcmDicomDirElement.h b/src/gdcmDicomDirElement.h
index cd747093bb3c1ce29e2aeea6cc8ccd8ef15af3e3..cfbb4c638d0aa0df54af3dd1d08bf42bad4eb8ac 100644 (file)
--- a/src/gdcmDicomDirElement.h
+++ b/src/gdcmDicomDirElement.h
@@ -10,20 +10,23 @@
 //-----------------------------------------------------------------------------
 typedef struct
 {
-       unsigned short int group;
+   /// DicomGroup number
+       unsigned short int group;
+   /// DicomElement number
        unsigned short int elem;
+   /// value (coded as a std::string) of the Element   
        std::string value;
 } gdcmElement;
 
-typedef std::list<gdcmElement> ListMetaElem;
-typedef std::list<gdcmElement> ListPatientElem;
-typedef std::list<gdcmElement> ListStudyElem;
-typedef std::list<gdcmElement> ListSerieElem;
-typedef std::list<gdcmElement> ListImageElem;
+typedef std::list<gdcmElement> ListDicomDirMetaElem;
+typedef std::list<gdcmElement> ListDicomDirPatientElem;
+typedef std::list<gdcmElement> ListDicomDirStudyElem;
+typedef std::list<gdcmElement> ListDicomDirSerieElem;
+typedef std::list<gdcmElement> ListDicomDirImageElem;
 
 //-----------------------------------------------------------------------------
-/*
- * \defgroup gdcmDicomDirElement
+/**
+ * \ingroup gdcmDicomDirElement
  * \brief    gdcmDicomDirElement represents elements contained in a dicom dir
  *
  */
@@ -33,20 +36,60 @@ public:
    gdcmDicomDirElement(void);
    ~gdcmDicomDirElement(void);
 
+  /**
+    * \ingroup gdcmParser
+    * \brief   canonical Printer 
+    * \sa    SetPrintLevel
+  */ 
    void Print(std::ostream &os);
-
-   ListMetaElem    &GetMetaElements(void)    {return(MetaList);};
-   ListPatientElem &GetPatientElements(void) {return(PatientList);};
-   ListStudyElem   &GetStudyElements(void)   {return(StudyList);};
-   ListSerieElem   &GetSerieElements(void)   {return(SerieList);};
-   ListImageElem   &GetImageElements(void)   {return(ImageList);};
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   returns a reference to the chained List 
+ *          related to the META Elements of a DICOMDIR.
+ */
+   ListDicomDirMetaElem    &GetDicomDirMetaElements(void)    
+      {return(DicomDirMetaList);};
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   returns a reference to the chained List 
+ *          related to the PATIENT Elements of a DICOMDIR.
+ */      
+   ListDicomDirPatientElem &GetDicomDirPatientElements(void) 
+      {return(DicomDirPatientList);};
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   returns a reference to the chained List 
+ *          related to the STUDY Elements of a DICOMDIR.
+ */      
+   ListDicomDirStudyElem   &GetDicomDirStudyElements(void)   
+      {return(DicomDirStudyList);};
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   returns a reference to the chained List 
+ *          related to the SERIE Elements of a DICOMDIR.
+ */
+   ListDicomDirSerieElem   &GetDicomDirSerieElements(void)   
+      {return(DicomDirSerieList);};
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   returns a reference to the chained List 
+ *          related to the IMAGE Elements of a DICOMDIR.
+ */
+   ListDicomDirImageElem   &GetDicomDirImageElements(void)   
+      {return(DicomDirImageList);};
 
 private:
-   ListMetaElem    MetaList;
-   ListPatientElem PatientList;
-   ListStudyElem   StudyList;
-   ListSerieElem   SerieList;
-   ListImageElem   ImageList;
+   /// gdcmElements chained list, related to the MetaElements of DICOMDIR
+   ListDicomDirMetaElem    DicomDirMetaList;
+   /// gdcmElements chained list, related to the PatientElements of DICOMDIR
+   ListDicomDirPatientElem DicomDirPatientList;
+   /// gdcmElements chained list, related to the StudyElements of DICOMDIR
+   ListDicomDirStudyElem   DicomDirStudyList;
+   /// gdcmElements chained list, related to the SerieElements of DICOMDIR
+   ListDicomDirSerieElem   DicomDirSerieList;
+   /// gdcmElements chained list, related to the ImageElements of DICOMDIR
+   
+   ListDicomDirImageElem   DicomDirImageList;
 };
 
 //-----------------------------------------------------------------------------