SimInputFrameSeries Class Reference

An InputFrameSeries encapsulated into a SimModule. More...

#include <Media/SimFrameSeries.H>

Inheritance diagram for SimInputFrameSeries:

[legend]

Collaboration diagram for SimInputFrameSeries:

[legend]

List of all members.

Public Member Functions
	SimInputFrameSeries (OptionManager &mgr, const std::string &descrName="Sim Input Frame Series", const std::string &tagName="SimInputFrameSeries")
	Constructor.
virtual	~SimInputFrameSeries ()
	Destructor.
virtual GenericFrameSpec	peekFrameSpec ()
	Get specifications of the image frames.
virtual void	startStream ()
	Optional call to efficiently prepare for frame streaming.
void	setFrameSource (const std::string &source)
	Set the frame source; same as doing --in=source on the command line.
int	frame () const
	Get the current frame number.
Protected Member Functions
	SIMCALLBACK_DECLARE (SimInputFrameSeries, SimEventClockTick)
	Callback function triggered at each clock tick.

---

Detailed Description

An InputFrameSeries encapsulated into a SimModule.

SimInputFrameSeries encapsulates the functionality of InputFrameSeries for use by SimModule objects. The interface is a simplified version of that of InputFrameSeries, since now most of the I/O is handled through the SimEventQueue blackboard rather than through explicit function calls and return values. Rather than deriving from InputFrameSeries, we hold an InputFrameSeries as a data member. This is because much of the InputFrameSeries interface is not used here because it is replaced by posting messages to the SimEventQueue.

Definition at line 61 of file SimFrameSeries.H.

---

Constructor & Destructor Documentation

SimInputFrameSeries::SimInputFrameSeries	(	OptionManager &	mgr,
		const std::string &	descrName = "Sim Input Frame Series",
		const std::string &	tagName = "SimInputFrameSeries"
	)

Constructor.

Definition at line 57 of file SimFrameSeries.C.

References ModelComponent::addSubComponent().

SimInputFrameSeries::~SimInputFrameSeries

(

)

[virtual]

Destructor.

Definition at line 68 of file SimFrameSeries.C.

---

Member Function Documentation

int SimInputFrameSeries::frame

(

)

const

Get the current frame number.

Definition at line 129 of file SimFrameSeries.C.

GenericFrameSpec SimInputFrameSeries::peekFrameSpec

(

)

[virtual]

Get specifications of the image frames.

It is okay to call this before the model is started(). If input resizing is being done, the returned dimensions will be the resized dims. All in all, this will return the size of whatever you will get when calling readFrame(), readRGB(), etc.

Definition at line 117 of file SimFrameSeries.C.

void SimInputFrameSeries::setFrameSource

(

const std::string &

source

)

Set the frame source; same as doing --in=source on the command line.

Definition at line 125 of file SimFrameSeries.C.

SimInputFrameSeries::SIMCALLBACK_DECLARE	(	SimInputFrameSeries	,
		SimEventClockTick
	)			[protected]

Callback function triggered at each clock tick.

void SimInputFrameSeries::startStream

(

)

[virtual]

Optional call to efficiently prepare for frame streaming.

Definition at line 121 of file SimFrameSeries.C.

---

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

• src/Media/SimFrameSeries.H
• src/Media/SimFrameSeries.C