]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomDirElement.h
ENH: Need to include iostream
[gdcm.git] / src / gdcmDicomDirElement.h
index 9c739802c3bb0d6b9b21703e3154cc3f7b806ae2..c23be83a9e6b22a8c995205b99a9cfadd164d117 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirElement.h,v $
   Language:  C++
-  Date:      $Date: 2004/10/25 04:08:20 $
-  Version:   $Revision: 1.14 $
+  Date:      $Date: 2005/02/05 00:22:14 $
+  Version:   $Revision: 1.25 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -27,6 +27,10 @@ namespace gdcm
 {
 
 //-----------------------------------------------------------------------------
+/**
+ * \brief internal structure, not end user intended
+ *        shouln't appear here
+ */  
 typedef struct
 {
    /// DicomGroup number
@@ -46,9 +50,8 @@ typedef std::list<Element> ListDicomDirImageElem;
 
 //-----------------------------------------------------------------------------
 /**
- * \ingroup DicomDirElement
- * \brief    DicomDirElement represents elements contained in a dicom dir
- *           Class for the chained lists from the file 'Dicts/DicomDir.dic'
+ * \brief   Represents elements contained in a DicomDir
+ *           class for the chained lists from the file 'Dicts/DicomDir.dic'
  */
 class GDCM_EXPORT DicomDirElement
 {
@@ -58,50 +61,47 @@ public:
 
   /**
     * \brief   canonical Printer 
-    * \sa    SetPrintLevel
     */ 
    void Print(std::ostream &os);
 
    /**
-    * \ingroup DicomDirElement
     * \brief   returns a reference to the chained List 
     *          related to the META Elements of a DICOMDIR.
     */
-   ListDicomDirMetaElem const & GetDicomDirMetaElements() const
+   ListDicomDirMetaElem const &GetDicomDirMetaElements() const
       { return DicomDirMetaList; };
 
    /**
-    * \ingroup DicomDirElement
     * \brief   returns a reference to the chained List 
     *          related to the PATIENT Elements of a DICOMDIR.
     */      
-   ListDicomDirPatientElem const & GetDicomDirPatientElements() const
+   ListDicomDirPatientElem const &GetDicomDirPatientElements() const
       { return DicomDirPatientList; };
 
    /**
-    * \ingroup DicomDirElement
     * \brief   returns a reference to the chained List 
     *          related to the STUDY Elements of a DICOMDIR.
     */      
-   ListDicomDirStudyElem const & GetDicomDirStudyElements() const
+   ListDicomDirStudyElem const &GetDicomDirStudyElements() const
       { return DicomDirStudyList; };
 
    /**
-    * \ingroup DicomDirElement
     * \brief   returns a reference to the chained List 
     *          related to the SERIE Elements of a DICOMDIR.
     */
-   ListDicomDirSerieElem const & GetDicomDirSerieElements() const
+   ListDicomDirSerieElem const &GetDicomDirSerieElements() const
       { return DicomDirSerieList; };
 
    /**
-    * \ingroup DicomDirElement
     * \brief   returns a reference to the chained List 
     *          related to the IMAGE Elements of a DICOMDIR.
     */
-   ListDicomDirImageElem const & GetDicomDirImageElements() const
+   ListDicomDirImageElem const &GetDicomDirImageElements() const
       { return DicomDirImageList; };
 
+   // Public method to add an element
+   bool AddEntry(DicomDirType type, Element const &elem);
+
 private:
    /// Elements chained list, related to the MetaElements of DICOMDIR
    ListDicomDirMetaElem    DicomDirMetaList;
@@ -112,7 +112,6 @@ private:
    /// Elements chained list, related to the SerieElements of DICOMDIR
    ListDicomDirSerieElem   DicomDirSerieList;
    /// Elements chained list, related to the ImageElements of DICOMDIR
-   
    ListDicomDirImageElem   DicomDirImageList;
 };
 } // end namespace gdcm