FrameProducer< OutputType > Class Template Reference
[Base class layer.]

class FrameProducer: element that generates data per frame. More...

#include <pipelinePlugin.h>

Inheritance diagram for FrameProducer< OutputType >:

List of all members.

Public Member Functions
	FrameProducer ()
	Default Constructor.
OutputType *	getCurrent ()
	Get the most recently produced frame.
bool	isFrameAvailable ()
	Indicates if a new frame is available.
Protected Member Functions
void	postFrame ()
	Called by a subclass to indicate that a new frame is available.
Protected Attributes
OutputType	workingFrame
	The data member thats available for modification.

---

Detailed Description

template<class OutputType>
class FrameProducer< OutputType >

class FrameProducer: element that generates data per frame.

Base class for any pipeline element that generates or propagates data.

---

Member Function Documentation

template<class OutputType> OutputType * FrameProducer< OutputType >::getCurrent (   )

Get the most recently produced frame. Returns: The most current complete frame.

template<class OutputType> bool FrameProducer< OutputType >::isFrameAvailable (   )

Indicates if a new frame is available. Returns: True if getCurrent() can produce a new frame.

template<class OutputType> void FrameProducer< OutputType >::postFrame (   )  [protected]

Called by a subclass to indicate that a new frame is available. Typically only direct subclasses PipelinePlugin and SourcePipelinePlugin should call this function.

---

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

• pipelinePlugin.h

---