src/gdcmDicomDirElement.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDicomDirElement.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/10/19 12:01:50 $
   7   Version:   $Revision: 1.32 $
   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
  31 typedef std::list<DicomElement> ListDicomDirElem;
  32 typedef std::list<DicomElement> ListDicomDirMetaElem;
  33 typedef std::list<DicomElement> ListDicomDirPatientElem;
  34 typedef std::list<DicomElement> ListDicomDirStudyElem;
  35 typedef std::list<DicomElement> ListDicomDirVisitElem;
  36 typedef std::list<DicomElement> ListDicomDirSerieElem;
  37 typedef std::list<DicomElement> ListDicomDirImageElem;
  38
  39 // For future use (Full DICOMDIR)
  40
  41 /*
  42 typedef std::list<DicomElement> ListDicomDirResultElem;
  43 typedef std::list<DicomElement> ListDicomDirStudyComponentElem;
  44
  45 typedef std::list<DicomElement> ListDicomDirOverlayElem;
  46 typedef std::list<DicomElement> ListDicomDirModalityLutElem;
  47 typedef std::list<DicomElement> ListDicomDirModalityLutElem;
  48 typedef std::list<DicomElement> ListDicomDirCurveElem;
  49 typedef std::list<DicomElement> ListDicomDirStoredPrintElem;
  50 typedef std::list<DicomElement> ListDicomDirRtDoseElem;
  51 typedef std::list<DicomElement> ListDicomDirRtStructureSetElem;
  52 typedef std::list<DicomElement> ListDicomDirRtPlanElem;
  53 typedef std::list<DicomElement> ListDicomDirRtTreatRecordElem;
  54 typedef std::list<DicomElement> ListDicomDirPresentationElem;
  55 typedef std::list<DicomElement> ListDicomDirSrDocumentElem;
  56 typedef std::list<DicomElement> ListDicomDirKeyObjectDocElem;
  57 typedef std::list<DicomElement> ListDicomDirSpectroscopyElem;
  58 typedef std::list<DicomElement> ListDicomDirRawDataElem;
  59 typedef std::list<DicomElement> ListDicomDirRegistrationElem;
  60 typedef std::list<DicomElement> ListDicomDirFiducialElem;
  61 */
  62
  63 //-----------------------------------------------------------------------------
  64 /**
  65  * \brief   Represents elements contained in a DicomDir class
  66  *          for the chained lists from the file 'Dicts/DicomDir.dic'
  67  */
  68 class GDCM_EXPORT DicomDirElement
  69 {
  70 public:
  71    DicomDirElement();
  72    ~DicomDirElement();
  73
  74   /**
  75     * \brief   canonical Printer
  76     */
  77    void Print(std::ostream &os);
  78
  79    /**
  80     * \brief   returns a reference to the chained List
  81     *          related to the META Elements of a DICOMDIR.
  82     */
  83    ListDicomDirMetaElem const &GetDicomDirMetaElements() const
  84       { return DicomDirMetaList; }
  85
  86    /**
  87     * \brief   returns a reference to the chained List
  88     *          related to the PATIENT Elements of a DICOMDIR.
  89     */
  90    ListDicomDirPatientElem const &GetDicomDirPatientElements() const
  91       { return DicomDirPatientList; }
  92
  93    /**
  94     * \brief   returns a reference to the chained List
  95     *          related to the STUDY Elements of a DICOMDIR.
  96     */
  97    ListDicomDirStudyElem const &GetDicomDirStudyElements() const
  98       { return DicomDirStudyList; }
  99
 100    /**
 101     * \brief   returns a reference to the chained List
 102     *          related to the VISIT Elements of a DICOMDIR.
 103     */
 104    ListDicomDirVisitElem const &GetDicomDirVisitElements() const
 105       { return DicomDirVisitList; }
 106    /**
 107     * \brief   returns a reference to the chained List
 108     *          related to the SERIE Elements of a DICOMDIR.
 109     */
 110    ListDicomDirSerieElem const &GetDicomDirSerieElements() const
 111       { return DicomDirSerieList; }
 112
 113    /**
 114     * \brief   returns a reference to the chained List
 115     *          related to the IMAGE Elements of a DICOMDIR.
 116     */
 117    ListDicomDirImageElem const &GetDicomDirImageElements() const
 118       { return DicomDirImageList; }
 119
 120    // Public method to add an element
 121    bool AddEntry(DicomDirType type, DicomElement const &elem);
 122
 123    // Only one instance of ddElem
 124    void AddDicomDirElement(DicomDirType type,
 125                            uint16_t group, uint16_t elem);
 126
 127 private:
 128    /// Elements chained list, related to the MetaElements of DICOMDIR
 129    ListDicomDirMetaElem    DicomDirMetaList;
 130    /// Elements chained list, related to the PatientElements of DICOMDIR
 131    ListDicomDirPatientElem DicomDirPatientList;
 132    /// Elements chained list, related to the StudyElements of DICOMDIR
 133    ListDicomDirStudyElem   DicomDirStudyList;
 134    /// Elements chained list, related to the VisitElements of DICOMDIR
 135    ListDicomDirVisitElem   DicomDirVisitList;
 136    /// Elements chained list, related to the SerieElements of DICOMDIR
 137    ListDicomDirSerieElem   DicomDirSerieList;
 138    /// Elements chained list, related to the ImageElements of DICOMDIR
 139    ListDicomDirImageElem   DicomDirImageList;
 140 };
 141 } // end namespace gdcm
 142 //-----------------------------------------------------------------------------
 143 #endif