src/gdcmDicomDirElement.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDicomDirElement.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/10/25 14:52:33 $
   7   Version:   $Revision: 1.33 $
   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 "gdcmRefCounter.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 : public RefCounter
  69 {
  70    gdcmTypeMacro(DicomDirElement);
  71
  72 public:
  73    static DicomDirElement *New() {return new DicomDirElement();}
  74
  75    /**
  76     * \brief   canonical Printer
  77     */
  78    void Print(std::ostream &os);
  79
  80    /**
  81     * \brief   returns a reference to the chained List
  82     *          related to the META Elements of a DICOMDIR.
  83     */
  84    ListDicomDirMetaElem const &GetDicomDirMetaElements() const
  85       { return DicomDirMetaList; }
  86
  87    /**
  88     * \brief   returns a reference to the chained List
  89     *          related to the PATIENT Elements of a DICOMDIR.
  90     */
  91    ListDicomDirPatientElem const &GetDicomDirPatientElements() const
  92       { return DicomDirPatientList; }
  93
  94    /**
  95     * \brief   returns a reference to the chained List
  96     *          related to the STUDY Elements of a DICOMDIR.
  97     */
  98    ListDicomDirStudyElem const &GetDicomDirStudyElements() const
  99       { return DicomDirStudyList; }
 100
 101    /**
 102     * \brief   returns a reference to the chained List
 103     *          related to the VISIT Elements of a DICOMDIR.
 104     */
 105    ListDicomDirVisitElem const &GetDicomDirVisitElements() const
 106       { return DicomDirVisitList; }
 107    /**
 108     * \brief   returns a reference to the chained List
 109     *          related to the SERIE Elements of a DICOMDIR.
 110     */
 111    ListDicomDirSerieElem const &GetDicomDirSerieElements() const
 112       { return DicomDirSerieList; }
 113
 114    /**
 115     * \brief   returns a reference to the chained List
 116     *          related to the IMAGE Elements of a DICOMDIR.
 117     */
 118    ListDicomDirImageElem const &GetDicomDirImageElements() const
 119       { return DicomDirImageList; }
 120
 121    // Public method to add an element
 122    bool AddEntry(DicomDirType type, DicomElement const &elem);
 123
 124    // Only one instance of ddElem
 125    void AddDicomDirElement(DicomDirType type,
 126                            uint16_t group, uint16_t elem);
 127
 128 protected:
 129    DicomDirElement();
 130    ~DicomDirElement();
 131
 132 private:
 133    /// Elements chained list, related to the MetaElements of DICOMDIR
 134    ListDicomDirMetaElem    DicomDirMetaList;
 135    /// Elements chained list, related to the PatientElements of DICOMDIR
 136    ListDicomDirPatientElem DicomDirPatientList;
 137    /// Elements chained list, related to the StudyElements of DICOMDIR
 138    ListDicomDirStudyElem   DicomDirStudyList;
 139    /// Elements chained list, related to the VisitElements of DICOMDIR
 140    ListDicomDirVisitElem   DicomDirVisitList;
 141    /// Elements chained list, related to the SerieElements of DICOMDIR
 142    ListDicomDirSerieElem   DicomDirSerieList;
 143    /// Elements chained list, related to the ImageElements of DICOMDIR
 144    ListDicomDirImageElem   DicomDirImageList;
 145 };
 146 } // end namespace gdcm
 147 //-----------------------------------------------------------------------------
 148 #endif