]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomDirElement.h
Coding Style + Doxygenation
[gdcm.git] / src / gdcmDicomDirElement.h
index 85a83b2b41d07439b49b44d474598a22489abb9f..9a879015b5c769bad19b903fe6c89bd01dcc65ba 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirElement.h,v $
   Language:  C++
-  Date:      $Date: 2004/08/01 02:39:09 $
-  Version:   $Revision: 1.9 $
+  Date:      $Date: 2005/01/06 20:03:27 $
+  Version:   $Revision: 1.18 $
                                                                                 
   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.
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
                                                                                 
      This software is distributed WITHOUT ANY WARRANTY; without even
      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 
 #include <list>
 
+namespace gdcm 
+{
+
 //-----------------------------------------------------------------------------
 typedef struct
 {
    /// DicomGroup number
-   unsigned short int group;
+   unsigned short int Group;
    /// DicomElement number
-   unsigned short int elem;
+   unsigned short int Elem;
    /// value (coded as a std::string) of the Element
-   std::string value;
-} gdcmElement;
+   std::string Value;
+} Element;
 
-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;
+typedef std::list<Element> ListDicomDirElem;
+typedef std::list<Element> ListDicomDirMetaElem;
+typedef std::list<Element> ListDicomDirPatientElem;
+typedef std::list<Element> ListDicomDirStudyElem;
+typedef std::list<Element> ListDicomDirSerieElem;
+typedef std::list<Element> ListDicomDirImageElem;
 
 //-----------------------------------------------------------------------------
 /**
- * \ingroup gdcmDicomDirElement
- * \brief    gdcmDicomDirElement represents elements contained in a dicom dir
+ * \ingroup DicomDirElement
+ * \brief    DicomDirElement represents elements contained in a dicom dir
  *           Class for the chained lists from the file 'Dicts/DicomDir.dic'
  */
-class GDCM_EXPORT gdcmDicomDirElement
+class GDCM_EXPORT DicomDirElement
 {
 public:
-   gdcmDicomDirElement();
-   ~gdcmDicomDirElement();
+   DicomDirElement();
+   ~DicomDirElement();
 
   /**
     * \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()
+
+   /**
+    * \ingroup DicomDirElement
+    * \brief   returns a reference to the chained List 
+    *          related to the META Elements of a DICOMDIR.
+    */
+   ListDicomDirMetaElem const &GetDicomDirMetaElements() const
       { return DicomDirMetaList; };
-/**
- * \ingroup gdcmDicomDirElement
- * \brief   returns a reference to the chained List 
- *          related to the PATIENT Elements of a DICOMDIR.
- */      
-   ListDicomDirPatientElem &GetDicomDirPatientElements()
+
+   /**
+    * \ingroup DicomDirElement
+    * \brief   returns a reference to the chained List 
+    *          related to the PATIENT Elements of a DICOMDIR.
+    */      
+   ListDicomDirPatientElem const &GetDicomDirPatientElements() const
       { return DicomDirPatientList; };
-/**
- * \ingroup gdcmDicomDirElement
- * \brief   returns a reference to the chained List 
- *          related to the STUDY Elements of a DICOMDIR.
- */      
-   ListDicomDirStudyElem   &GetDicomDirStudyElements()
+
+   /**
+    * \ingroup DicomDirElement
+    * \brief   returns a reference to the chained List 
+    *          related to the STUDY Elements of a DICOMDIR.
+    */      
+   ListDicomDirStudyElem const &GetDicomDirStudyElements() const
       { return DicomDirStudyList; };
-/**
- * \ingroup gdcmDicomDirElement
- * \brief   returns a reference to the chained List 
- *          related to the SERIE Elements of a DICOMDIR.
- */
-   ListDicomDirSerieElem   &GetDicomDirSerieElements()
+
+   /**
+    * \ingroup DicomDirElement
+    * \brief   returns a reference to the chained List 
+    *          related to the SERIE Elements of a DICOMDIR.
+    */
+   ListDicomDirSerieElem const &GetDicomDirSerieElements() const
       { return DicomDirSerieList; };
-/**
- * \ingroup gdcmDicomDirElement
- * \brief   returns a reference to the chained List 
- *          related to the IMAGE Elements of a DICOMDIR.
- */
-   ListDicomDirImageElem   &GetDicomDirImageElements()
+
+   /**
+    * \ingroup DicomDirElement
+    * \brief   returns a reference to the chained List 
+    *          related to the IMAGE Elements of a DICOMDIR.
+    */
+   ListDicomDirImageElem const &GetDicomDirImageElements() const
       { return DicomDirImageList; };
 
+   /**
+    * Public method to add an element
+    */
+   bool AddNewEntry(std::string const &type, Element const &elem);
+
 private:
-   /// gdcmElements chained list, related to the MetaElements of DICOMDIR
+   /// Elements chained list, related to the MetaElements of DICOMDIR
    ListDicomDirMetaElem    DicomDirMetaList;
-   /// gdcmElements chained list, related to the PatientElements of DICOMDIR
+   /// Elements chained list, related to the PatientElements of DICOMDIR
    ListDicomDirPatientElem DicomDirPatientList;
-   /// gdcmElements chained list, related to the StudyElements of DICOMDIR
+   /// Elements chained list, related to the StudyElements of DICOMDIR
    ListDicomDirStudyElem   DicomDirStudyList;
-   /// gdcmElements chained list, related to the SerieElements of DICOMDIR
+   /// Elements chained list, related to the SerieElements of DICOMDIR
    ListDicomDirSerieElem   DicomDirSerieList;
-   /// gdcmElements chained list, related to the ImageElements of DICOMDIR
-   
+   /// Elements chained list, related to the ImageElements of DICOMDIR
    ListDicomDirImageElem   DicomDirImageList;
 };
-
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif