src/gdcmRLEFramesInfo.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmRLEFramesInfo.h,v $
   5   Language:  C++
   6   Date:      $Date: 2004/10/06 09:58:08 $
   7   Version:   $Revision: 1.1 $
   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
  20 #ifndef GDCMRLEFRAMESINFO_H
  21 #define GDCMRLEFRAMESINFO_H
  22
  23 #include "gdcmRLEFrame.h"
  24 #include <list>
  25
  26 /**
  27  * \brief Utility class for gathering the informations of the collection
  28  *        of RLE frame[s] (see \ref gdcmRLEFrame)  when handling
  29  *        "Encapsulated RLE Compressed Images" (see PS-3.3 annex G).
  30  *        Note: a classical image can be considered as the degenerated case
  31  *              of a multiframe image. In this case the collection is limited
  32  *              to a single individual frame.
  33  *        The informations on each frame are obtained during the parsing
  34  *        of a gdcmDocument (refer to \ref gdcmDocument::Parse7FE0() ).
  35  *        They shall be used when (if necessary) decoding the frames.
  36  *
  37  *        This class is simply a stl list<> of \ref gdcmRLEFrame.
  38  */
  39 class GDCM_EXPORT gdcmRLEFramesInfo
  40 {
  41    typedef std::list< gdcmRLEFrame* > RLEFrameList;
  42 friend class gdcmDocument;
  43 friend class gdcmFile;
  44    RLEFrameList Frames;
  45 public:
  46    ~gdcmRLEFramesInfo();
  47 };
  48
  49 //-----------------------------------------------------------------------------
  50 #endif