Used to buffer one Frame of Scanner Data for use by 'ScannerFileBuffered'. More...

#include <ScannerFrame.h>

Public Types
typedef ScannerFrame *	ScannerFramePtr

Public Member Functions
	ScannerFrame (ScannerClockPtr _clock, kkint32 _scanLinesPerFrame, kkint32 _pixelsPerScanLine)
	Construct a frame with the dimensions (Height = _scanLinesPerFrame) and (Width = _pixelsPerScanLine). More...

	~ScannerFrame ()

kkint32	FrameNum () const

void	FrameNum (kkint32 _frameNum)

kkint32	ScanLineFirst () const

void	ScanLineFirst (kkint32 _scanLineFirst)

kkint32	ScanLineLast () const

void	ScanLineLast (kkint32 _scanLineLast)

uchar **	ScanLines ()

void	ScanLines (uchar **_scanLines)

kkint32	Time () const

void	Time (kkint32 _time)

Detailed Description

Used to buffer one Frame of Scanner Data for use by 'ScannerFileBuffered'.

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.

Definition at line 16 of file ScannerFrame.h.

Member Typedef Documentation

typedef ScannerFrame* KKLSC::ScannerFrame::ScannerFramePtr

Definition at line 19 of file ScannerFrame.h.

Constructor & Destructor Documentation

ScannerFrame::ScannerFrame	(	ScannerClockPtr	_clock,
		kkint32	_scanLinesPerFrame,
		kkint32	_pixelsPerScanLine
	)

Construct a frame with the dimensions (Height = _scanLinesPerFrame) and (Width = _pixelsPerScanLine).

Parameters

[in]	_clock	A ScannerClock instance that is shared by all instances of 'ScannerFrame' that are used by the same instance of 'ScannerFleBuffered'.
[in]	_scanLinesPerFrame	Height of the frame.
[in]	_pixelsPerScanLine	Width of the frame.

Definition at line 15 of file ScannerFrame.cpp.

                             :
   
   clock         (_clock),
   frameNum      (-1),
   height        (_scanLinesPerFrame),
   scanLines     (NULL),
   scanLineFirst (-1),
   scanLineLast  (-1),
   time          (0),
   width         (_pixelsPerScanLine)
 
 {
   clock = _clock;
   scanLines = AllocateFrameArray ();
 }

ScannerFrame::~ScannerFrame ( )

Definition at line 35 of file ScannerFrame.cpp.

 {
   if  (scanLines)
   {
     for  (kkint32  x = 0;  x < height;  ++x)
     {
       delete  scanLines[x];
       scanLines[x] = NULL;
     }
   }
 
   delete  scanLines;
   scanLines = NULL;
 }

Member Function Documentation

kkint32 KKLSC::ScannerFrame::FrameNum ( ) const

inline

Definition at line 35 of file ScannerFrame.h.

35 {return frameNum;}

void KKLSC::ScannerFrame::FrameNum ( kkint32 _frameNum )

inline

Definition at line 42 of file ScannerFrame.h.

42 {frameNum = _frameNum;}

kkint32 KKLSC::ScannerFrame::ScanLineFirst ( ) const

inline

Definition at line 37 of file ScannerFrame.h.

37 {return scanLineFirst;}

void KKLSC::ScannerFrame::ScanLineFirst ( kkint32 _scanLineFirst )

inline

Definition at line 44 of file ScannerFrame.h.

44 {scanLineFirst = _scanLineFirst;}

kkint32 KKLSC::ScannerFrame::ScanLineLast ( ) const

inline

Definition at line 38 of file ScannerFrame.h.

38 {return scanLineLast;}

void KKLSC::ScannerFrame::ScanLineLast ( kkint32 _scanLineLast )

inline

Definition at line 45 of file ScannerFrame.h.

45 {scanLineLast = _scanLineLast;}

uchar ** ScannerFrame::ScanLines ( )

Will return scan-lines and increment 'time' by one.

Definition at line 62 of file ScannerFrame.cpp.

References KKLSC::ScannerClock::Time().

 {
   time = clock->Time ();
   return scanLines;
 } 

void ScannerFrame::ScanLines ( uchar ** _scanLines )

Definition at line 70 of file ScannerFrame.cpp.

References KKLSC::ScannerClock::Time().

 {
   time = clock->Time ();
   scanLines = _scanLines;
 }

kkint32 KKLSC::ScannerFrame::Time ( ) const

inline

The higher 'time' the more recently this frame has been accessed.

Definition at line 39 of file ScannerFrame.h.

void KKLSC::ScannerFrame::Time ( kkint32 _time )

inline

Definition at line 46 of file ScannerFrame.h.

46 {time = _time;}

The documentation for this class was generated from the following files:

C:/Users/Kurt/GitHub/KSquareLibraries/KKLineScanner/ScannerFrame.h
C:/Users/Kurt/GitHub/KSquareLibraries/KKLineScanner/ScannerFrame.cpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation