src/gdcmDicomDirElement.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDicomDirElement.h,v $
   5   Language:  C++
   6   Date:      $Date: 2004/10/12 04:35:44 $
   7   Version:   $Revision: 1.12 $
   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 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> ListDicomDirMetaElem;
  41 typedef std::list<Element> ListDicomDirPatientElem;
  42 typedef std::list<Element> ListDicomDirStudyElem;
  43 typedef std::list<Element> ListDicomDirSerieElem;
  44 typedef std::list<Element> ListDicomDirImageElem;
  45
  46 //-----------------------------------------------------------------------------
  47 /**
  48  * \ingroup DicomDirElement
  49  * \brief    DicomDirElement represents elements contained in a dicom dir
  50  *           Class for the chained lists from the file 'Dicts/DicomDir.dic'
  51  */
  52 class GDCM_EXPORT DicomDirElement
  53 {
  54 public:
  55    DicomDirElement();
  56    ~DicomDirElement();
  57
  58   /**
  59     * \brief   canonical Printer
  60     * \sa    SetPrintLevel
  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    &GetDicomDirMetaElements()
  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 &GetDicomDirPatientElements()
  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   &GetDicomDirStudyElements()
  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   &GetDicomDirSerieElements()
  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   &GetDicomDirImageElements()
 102       { return DicomDirImageList; };
 103
 104 private:
 105    /// Elements chained list, related to the MetaElements of DICOMDIR
 106    ListDicomDirMetaElem    DicomDirMetaList;
 107    /// Elements chained list, related to the PatientElements of DICOMDIR
 108    ListDicomDirPatientElem DicomDirPatientList;
 109    /// Elements chained list, related to the StudyElements of DICOMDIR
 110    ListDicomDirStudyElem   DicomDirStudyList;
 111    /// Elements chained list, related to the SerieElements of DICOMDIR
 112    ListDicomDirSerieElem   DicomDirSerieList;
 113    /// Elements chained list, related to the ImageElements of DICOMDIR
 114
 115    ListDicomDirImageElem   DicomDirImageList;
 116 };
 117 } // end namespace gdcm
 118 //-----------------------------------------------------------------------------
 119 #endif