src/gdcmDicomDirStudy.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDicomDirStudy.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/16 04:50:41 $
   7   Version:   $Revision: 1.17 $
   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 GDCMDICOMDIRSTUDY_H
  20 #define GDCMDICOMDIRSTUDY_H
  21
  22 #include "gdcmDicomDirObject.h"
  23
  24 namespace gdcm
  25 {
  26 class DicomDirSerie;
  27 //-----------------------------------------------------------------------------
  28 typedef std::list<DicomDirSerie *> ListDicomDirSerie;
  29
  30 //-----------------------------------------------------------------------------
  31 /**
  32  * \ingroup DicomDirStudy
  33  * \brief   describes a STUDY within a within a PATIENT
  34  * (DicomDirPatient) of a given DICOMDIR (DicomDir)
  35  */
  36 class GDCM_EXPORT DicomDirStudy : public DicomDirObject
  37 {
  38 public:
  39    DicomDirStudy();
  40    ~DicomDirStudy();
  41
  42    void Print(std::ostream &os = std::cout, std::string const & indent = "" );
  43    void WriteContent(std::ofstream *fp, FileType t);
  44
  45    /**
  46     * \ingroup DicomDirStudy
  47     * \brief   returns the SERIE chained List for this STUDY.
  48     */
  49    ListDicomDirSerie const &GetDicomDirSeries() const { return Series; };
  50
  51    /**
  52     * \ingroup DicomDirStudy
  53     * \brief   adds the passed SERIE to the SERIE chained List for this STUDY.
  54     */
  55    void AddDicomDirSerie(DicomDirSerie *obj) { Series.push_back(obj); };
  56
  57    /**
  58     * \ingroup DicomDirStudy
  59     * \brief   TODO
  60     */
  61    DicomDirSerie* NewSerie();
  62
  63 private:
  64 /**
  65 * \brief chained list of DicomDirSeries (to be exploited recursively)
  66 */
  67    ListDicomDirSerie Series;
  68 };
  69 } // end namespace gdcm
  70
  71 //-----------------------------------------------------------------------------
  72 #endif