src/gdcmDicomDirElement.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDicomDirElement.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/20 17:15:54 $
   7   Version:   $Revision: 1.21 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 #ifndef GDCMDICOMDIRELEMENT_H
  20 #define GDCMDICOMDIRELEMENT_H
  21
  22 #include "gdcmCommon.h"
  23
  24 #include <list>
  25
  26 namespace gdcm
  27 {
  28
  29 //-----------------------------------------------------------------------------
  30 GDCM_EXPORT typedef struct
  31 {
  32    /// DicomGroup number
  33    unsigned short int Group;
  34    /// DicomElement number
  35    unsigned short int Elem;
  36    /// value (coded as a std::string) of the Element
  37    std::string Value;
  38 } Element;
  39
  40 typedef std::list<Element> ListDicomDirElem;
  41 typedef std::list<Element> ListDicomDirMetaElem;
  42 typedef std::list<Element> ListDicomDirPatientElem;
  43 typedef std::list<Element> ListDicomDirStudyElem;
  44 typedef std::list<Element> ListDicomDirSerieElem;
  45 typedef std::list<Element> ListDicomDirImageElem;
  46
  47 //-----------------------------------------------------------------------------
  48 /**
  49  * \ingroup DicomDirElement
  50  * \brief   Represents elements contained in a DicomDir
  51  *           class for the chained lists from the file 'Dicts/DicomDir.dic'
  52  */
  53 class GDCM_EXPORT DicomDirElement
  54 {
  55 public:
  56    DicomDirElement();
  57    ~DicomDirElement();
  58
  59   /**
  60     * \brief   canonical Printer
  61     */
  62    void Print(std::ostream &os);
  63
  64    /**
  65     * \ingroup DicomDirElement
  66     * \brief   returns a reference to the chained List
  67     *          related to the META Elements of a DICOMDIR.
  68     */
  69    ListDicomDirMetaElem const &GetDicomDirMetaElements() const
  70       { return DicomDirMetaList; };
  71
  72    /**
  73     * \ingroup DicomDirElement
  74     * \brief   returns a reference to the chained List
  75     *          related to the PATIENT Elements of a DICOMDIR.
  76     */
  77    ListDicomDirPatientElem const &GetDicomDirPatientElements() const
  78       { return DicomDirPatientList; };
  79
  80    /**
  81     * \ingroup DicomDirElement
  82     * \brief   returns a reference to the chained List
  83     *          related to the STUDY Elements of a DICOMDIR.
  84     */
  85    ListDicomDirStudyElem const &GetDicomDirStudyElements() const
  86       { return DicomDirStudyList; };
  87
  88    /**
  89     * \ingroup DicomDirElement
  90     * \brief   returns a reference to the chained List
  91     *          related to the SERIE Elements of a DICOMDIR.
  92     */
  93    ListDicomDirSerieElem const &GetDicomDirSerieElements() const
  94       { return DicomDirSerieList; };
  95
  96    /**
  97     * \ingroup DicomDirElement
  98     * \brief   returns a reference to the chained List
  99     *          related to the IMAGE Elements of a DICOMDIR.
 100     */
 101    ListDicomDirImageElem const &GetDicomDirImageElements() const
 102       { return DicomDirImageList; };
 103
 104    // Public method to add an element
 105    bool AddNewEntry(DicomDirType type, Element const &elem);
 106
 107 private:
 108    /// Elements chained list, related to the MetaElements of DICOMDIR
 109    ListDicomDirMetaElem    DicomDirMetaList;
 110    /// Elements chained list, related to the PatientElements of DICOMDIR
 111    ListDicomDirPatientElem DicomDirPatientList;
 112    /// Elements chained list, related to the StudyElements of DICOMDIR
 113    ListDicomDirStudyElem   DicomDirStudyList;
 114    /// Elements chained list, related to the SerieElements of DICOMDIR
 115    ListDicomDirSerieElem   DicomDirSerieList;
 116    /// Elements chained list, related to the ImageElements of DICOMDIR
 117    ListDicomDirImageElem   DicomDirImageList;
 118 };
 119 } // end namespace gdcm
 120 //-----------------------------------------------------------------------------
 121 #endif