src/gdcmDicomDirSerie.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDicomDirSerie.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/17 10:59:52 $
   7   Version:   $Revision: 1.20 $
   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 GDCMDICOMDIRSERIE_H
  20 #define GDCMDICOMDIRSERIE_H
  21
  22 #include "gdcmDicomDirObject.h"
  23
  24 namespace gdcm
  25 {
  26 class DicomDirImage;
  27 //-----------------------------------------------------------------------------
  28 typedef std::list<DicomDirImage *> ListDicomDirImage;
  29
  30 //-----------------------------------------------------------------------------
  31 /**
  32  * \brief   describes a SERIE  within a within a STUDY
  33  * (DicomDirStudy) of a given DICOMDIR (DicomDir)
  34  */
  35 class GDCM_EXPORT DicomDirSerie : public DicomDirObject
  36 {
  37 public:
  38    DicomDirSerie();
  39    ~DicomDirSerie();
  40
  41    void Print( std::ostream &os = std::cout, std::string const & indent = "" );
  42    void WriteContent( std::ofstream *fp, FileType t );
  43
  44     // TODO Remove GetDicomDirImages
  45     // use InitTraversal + GetNextEntry instead.
  46
  47    /// Returns the IMAGE chained List for this SERIE.
  48    ListDicomDirImage const &GetDicomDirImages() const { return Images; };
  49
  50    // should avoid exposing internal mechanism
  51    void InitTraversal();
  52    DicomDirImage *GetNextEntry();
  53
  54    /// adds the passed IMAGE to the IMAGE chained List for this SERIE.
  55    void AddDicomDirImage(DicomDirImage *obj) { Images.push_back(obj); };
  56
  57    DicomDirImage *NewImage();
  58
  59 private:
  60
  61    ///chained list of DicomDirImages (to be exploited recursively)
  62    ListDicomDirImage Images;
  63    /// iterator on the DicomDirImages of the current DicomDirSerie
  64    ListDicomDirImage::iterator ItDicomDirImage;
  65 };
  66 } // end namespace gdcm
  67 //-----------------------------------------------------------------------------
  68 #endif