SocCamera::tcMultipleROISensor Class Reference

#include <MultipleROISensor.h>

Collaboration diagram for SocCamera::tcMultipleROISensor:

Public Member Functions
	tcMultipleROISensor (int32 anMaxROIs)
virtual	~tcMultipleROISensor ()
teNackCode	setNumberOfROI (int32 anNumber)
teNackCode	setMultipleROI (int32 anIndex, ROI asROI)
int32	getNumberOfROI ()
int32	getMaxROI ()
ROI	getROI (int32 anIndex)

Protected Member Functions
virtual teNackCode	programMultipleROI ()=0

Protected Attributes
ROI *	maWindowROIs
int32	mnNumROIs
int32	mnMaxROIs

Detailed Description

This class handles most of the book keeping for multiple ROIs. The sub- classer should define validate() appropriately to determine the state of multiple ROI and the valid configuration. programMultipleROI should only return an error if the registers could not be programmed for the specified window.

Constructor & Destructor Documentation

tcMultipleROISensor()

tcMultipleROISensor::tcMultipleROISensor

(

int32

anMaxROIs

)

ctor

Parameters

anMaxROIs

- the maximum number of ROIs the sensor supports.

~tcMultipleROISensor()

tcMultipleROISensor::~tcMultipleROISensor ( )

virtual

Destructor; frees the array of ROIs used for the sub windows.

Member Function Documentation

getMaxROI()

int32 SocCamera::tcMultipleROISensor::getMaxROI

(

)

Get the maximum number of windows the sensor can support.

Returns

the maximum number of windows.

getNumberOfROI()

int32 tcMultipleROISensor::getNumberOfROI

(

)

Get the current number of windows to output.

Returns

the number of windows to image.

getROI()

ROI tcMultipleROISensor::getROI

(

int32

anIndex

)

Get the current ROI for the given index.

Parameters

anIndex

- the 0 based index to get the ROI for.

programMultipleROI()

virtual teNackCode SocCamera::tcMultipleROISensor::programMultipleROI ( )

protectedpure virtual

This function is called whenever a public setter is called.

Returns

a nack code for the operation.

setMultipleROI()

teNackCode tcMultipleROISensor::setMultipleROI	(	int32	anIndex,
		ROI	asROI
	)

Set an ROI for the given index.

Parameters

anIndex	- the 0 based index for the window to set
asROI	- the ROI to set.

Returns

a nack code for the operation

setNumberOfROI()

teNackCode tcMultipleROISensor::setNumberOfROI

(

int32

anNumber

)

Set the number of windows to image.

Parameters

anNumber

- the number of windows to image; 1 to disable multiple ROI

Returns

a nack code for the operation

Member Data Documentation

maWindowROIs

ROI* SocCamera::tcMultipleROISensor::maWindowROIs

protected

Individual window ROIs; use this for programSensor() to determine the current settings.

mnMaxROIs

int32 SocCamera::tcMultipleROISensor::mnMaxROIs

protected

The maximum number of ROIs.

mnNumROIs

int32 SocCamera::tcMultipleROISensor::mnNumROIs

protected

The current number of ROIs being set.

---

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

• /tmp/mitycam_sdk/ARM/camera_software/src/Sensors/Interfaces/MultipleROISensor.h
• /tmp/mitycam_sdk/ARM/camera_software/src/Sensors/Interfaces/MultipleROISensor.cpp