X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDicomDirElement.h;h=c2b1afe7bc2e0998c3909ef71b89364593e14aad;hb=d6f3715fc5f0acf5deeefd288703e24790d069cd;hp=cd747093bb3c1ce29e2aeea6cc8ccd8ef15af3e3;hpb=fae5f95ae8cf044c024b1793b94032c9368f0f4b;p=gdcm.git

diff --git a/src/gdcmDicomDirElement.h b/src/gdcmDicomDirElement.h
index cd747093..c2b1afe7 100644
--- 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: 2005/01/26 09:49:53 $
+  Version:   $Revision: 1.23 $
+                                                                                
+  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.html 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
 
@@ -7,47 +23,98 @@
 
 #include <list>
 
+namespace gdcm 
+{
+
 //-----------------------------------------------------------------------------
-typedef struct
+/**
+ * \brief internal structure, not end user intended
+ *        shouln't appear here
+ */  
+GDCM_EXPORT typedef struct
 {
-	unsigned short int group;
-	unsigned short int elem;
-	std::string value;
-} gdcmElement;
+   /// DicomGroup number
+   unsigned short int Group;
+   /// DicomElement number
+   unsigned short int Elem;
+   /// value (coded as a std::string) of the Element
+   std::string Value;
+} Element;
 
-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<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;
 
 //-----------------------------------------------------------------------------
-/*
- * \defgroup gdcmDicomDirElement
- * \brief    gdcmDicomDirElement represents elements contained in a dicom dir
- *
+/**
+ * \brief   Represents elements contained in a DicomDir
+ *           class for the chained lists from the file 'Dicts/DicomDir.dic'
  */
-class GDCM_EXPORT gdcmDicomDirElement
+class GDCM_EXPORT DicomDirElement
 {
 public:
-   gdcmDicomDirElement(void);
-   ~gdcmDicomDirElement(void);
+   DicomDirElement();
+   ~DicomDirElement();
 
+  /**
+    * \brief   canonical Printer 
+    */ 
    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 DicomDirElement
+    * \brief   returns a reference to the chained List 
+    *          related to the META Elements of a DICOMDIR.
+    */
+   ListDicomDirMetaElem const &GetDicomDirMetaElements() const
+      { return DicomDirMetaList; };
+
+   /**
+    * \brief   returns a reference to the chained List 
+    *          related to the PATIENT Elements of a DICOMDIR.
+    */      
+   ListDicomDirPatientElem const &GetDicomDirPatientElements() const
+      { return DicomDirPatientList; };
+
+   /**
+    * \brief   returns a reference to the chained List 
+    *          related to the STUDY Elements of a DICOMDIR.
+    */      
+   ListDicomDirStudyElem const &GetDicomDirStudyElements() const
+      { return DicomDirStudyList; };
+
+   /**
+    * \brief   returns a reference to the chained List 
+    *          related to the SERIE Elements of a DICOMDIR.
+    */
+   ListDicomDirSerieElem const &GetDicomDirSerieElements() const
+      { return DicomDirSerieList; };
+
+   /**
+    * \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 AddEntry(DicomDirType type, Element const &elem);
 
 private:
-   ListMetaElem    MetaList;
-   ListPatientElem PatientList;
-   ListStudyElem   StudyList;
-   ListSerieElem   SerieList;
-   ListImageElem   ImageList;
+   /// Elements chained list, related to the MetaElements of DICOMDIR
+   ListDicomDirMetaElem    DicomDirMetaList;
+   /// Elements chained list, related to the PatientElements of DICOMDIR
+   ListDicomDirPatientElem DicomDirPatientList;
+   /// Elements chained list, related to the StudyElements of DICOMDIR
+   ListDicomDirStudyElem   DicomDirStudyList;
+   /// 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
 //-----------------------------------------------------------------------------
 #endif