ScannerFrame.h

Go to the documentation of this file.

#if  !defined(_SCANNERFRAME_)
#define  _SCANNERFRAME_


#include  "ScannerClock.h"


namespace KKLSC
{
  /**
   *@brief Used to buffer one Frame of Scanner Data for use by 'ScannerFileBuffered'.
   *@details Each access to 'ScanLines' will cause the 'time' variable to increment by one.  This will
   * allow the 'ScannerFleBufered' class know how old its Buffered frames are.  With this knowledge it
   * will be able to keep the more currently accessed frames in memory.
   */
  class  ScannerFrame
  {
  public:
    typedef  ScannerFrame*  ScannerFramePtr;


    /**
     *@brief  Construct a frame with the dimensions (Height = _scanLinesPerFrame) and (Width = _pixelsPerScanLine).
     *@param[in] _clock  A ScannerClock instance that is shared by all instances of 'ScannerFrame' that are used by the same instance of 'ScannerFleBuffered'.
     *@param[in] _scanLinesPerFrame  Height of the frame.
     *@param[in] _pixelsPerScanLine  Width of the frame.
     */
    ScannerFrame (ScannerClockPtr _clock,
                  kkint32         _scanLinesPerFrame,
                  kkint32         _pixelsPerScanLine
                 );

    ~ScannerFrame ();

    kkint32  FrameNum      () const  {return frameNum;}
    uchar**  ScanLines     ();                                  /**< Will return scan-lines and increment 'time' by one. */
    kkint32  ScanLineFirst () const  {return scanLineFirst;}
    kkint32  ScanLineLast  () const  {return scanLineLast;}
    kkint32  Time          () const  {return time;}             /**< The higher 'time' the more recently this frame has been accessed. */


    void  FrameNum      (kkint32 _frameNum)      {frameNum      = _frameNum;}
    void  ScanLines     (uchar** _scanLines);
    void  ScanLineFirst (kkint32 _scanLineFirst) {scanLineFirst = _scanLineFirst;}
    void  ScanLineLast  (kkint32 _scanLineLast)  {scanLineLast  = _scanLineLast;}
    void  Time          (kkint32 _time)          {time          = _time;}


  private:
    uchar**  AllocateFrameArray ();

    ScannerClockPtr   clock;
    kkint32           frameNum;
    kkint32           height;
    uchar**           scanLines;
    kkint32           scanLineFirst;
    kkint32           scanLineLast;
    kkint32           time;
    kkint32           width;
  };  /* ScannerFrame */

  typedef  ScannerFrame::ScannerFramePtr  ScannerFramePtr;
}

#endif