* Test/TestAllEntryVerify.cxx minor fix and added comments.

[gdcm.git] / src / gdcmDicomDirElement.h

diff --git a/src/gdcmDicomDirElement.h b/src/gdcmDicomDirElement.h
index cd747093bb3c1ce29e2aeea6cc8ccd8ef15af3e3..85a83b2b41d07439b49b44d474598a22489abb9f 100644 (file)
--- a/src/gdcmDicomDirElement.h
+++ b/src/gdcmDicomDirElement.h
@@ -1,5 +1,21 @@
-// gdcmDicomDirElement.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDicomDirElement.h,v $
+  Language:  C++
+  Date:      $Date: 2004/08/01 02:39:09 $
+  Version:   $Revision: 1.9 $
+                                                                                
+  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.
+                                                                                
+=========================================================================*/
+
 #ifndef GDCMDICOMDIRELEMENT_H
 #define GDCMDICOMDIRELEMENT_H
 
@@ -10,43 +26,85 @@
 //-----------------------------------------------------------------------------
 typedef struct
 {
-       unsigned short int group;
-       unsigned short int elem;
-       std::string value;
+   /// 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
- *
+ *           Class for the chained lists from the file 'Dicts/DicomDir.dic'
  */
 class GDCM_EXPORT gdcmDicomDirElement
 {
 public:
-   gdcmDicomDirElement(void);
-   ~gdcmDicomDirElement(void);
+   gdcmDicomDirElement();
+   ~gdcmDicomDirElement();
 
+  /**
+    * \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()
+      { return DicomDirMetaList; };
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   returns a reference to the chained List 
+ *          related to the PATIENT Elements of a DICOMDIR.
+ */      
+   ListDicomDirPatientElem &GetDicomDirPatientElements()
+      { return DicomDirPatientList; };
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   returns a reference to the chained List 
+ *          related to the STUDY Elements of a DICOMDIR.
+ */      
+   ListDicomDirStudyElem   &GetDicomDirStudyElements()
+      { return DicomDirStudyList; };
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   returns a reference to the chained List 
+ *          related to the SERIE Elements of a DICOMDIR.
+ */
+   ListDicomDirSerieElem   &GetDicomDirSerieElements()
+      { return DicomDirSerieList; };
+/**
+ * \ingroup gdcmDicomDirElement
+ * \brief   returns a reference to the chained List 
+ *          related to the IMAGE Elements of a DICOMDIR.
+ */
+   ListDicomDirImageElem   &GetDicomDirImageElements()
+      { 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;
 };
 
 //-----------------------------------------------------------------------------