* src/gdcmDicomDir.cxx, gdcmDocEntrySet.cxx: removed inclusion of errno.h

[gdcm.git] / src / gdcmDicomDirElement.h

diff --git a/src/gdcmDicomDirElement.h b/src/gdcmDicomDirElement.h
index f813bca489b0fc44793e9e282fd7b0c6626117a1..578dfa77783cc89864dd6680d7a24347d275123e 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/06/20 18:08:47 $
+  Version:   $Revision: 1.8 $
+                                                                                
+  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,9 +26,12 @@
 //-----------------------------------------------------------------------------
 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> ListDicomDirMetaElem;
@@ -22,10 +41,10 @@ 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
 {
@@ -33,24 +52,58 @@ public:
    gdcmDicomDirElement(void);
    ~gdcmDicomDirElement(void);
 
+  /**
+    * \brief   canonical Printer 
+    * \sa    SetPrintLevel
+  */ 
    void Print(std::ostream &os);
-
+/**
+ * \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:
+   /// 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;
 };