src/gdcmDicomDirElement.h

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