#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-device-ultrapython/src/devices/ultrapython/UltraPythonDriver.h>

Inheritance diagram for UltraPythonDriver:

Public Member Functions
	UltraPythonDriver ()

	~UltraPythonDriver () override

bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.

bool	close () override
	Close the DeviceDriver.

int	height () const override
	Return the height of each frame.

int	width () const override
	Return the width of each frame.

bool	getImage (yarp::sig::ImageOf< yarp::sig::PixelRgb > &image) override
	Get an image from the frame grabber.

yarp::os::Stamp	getLastInputStamp () override
	Return the time stamp relative to the last acquisition.

bool	getCameraDescription (CameraDescriptor *camera) override
	Get a basic description of the camera hw.

bool	hasFeature (int feature, bool *hasFeature) override
	Check if camera has the requested feature (saturation, brightness ... )

bool	setFeature (int feature, double value) override
	Set the requested feature to a value (saturation, brightness ... )

bool	getFeature (int feature, double *value) override
	Get the current value for the requested feature.

bool	setFeature (int feature, double value1, double value2) override
	Set the requested feature to a value using 2 params (like white balance)

bool	getFeature (int feature, double value1, double value2) override
	Get the current value for the requested feature.

bool	hasOnOff (int feature, bool *HasOnOff) override
	Check if the camera has the ability to turn on/off the requested feature.

bool	setActive (int feature, bool onoff) override
	Set the requested feature on or off.

bool	getActive (int feature, bool *isActive) override
	Get the current status of the feature, on or off.

bool	hasAuto (int feature, bool *hasAuto) override
	Check if the requested feature has the 'auto' mode.

bool	hasManual (int feature, bool *hasManual) override
	Check if the requested feature has the 'manual' mode.

bool	hasOnePush (int feature, bool *hasOnePush) override
	Check if the requested feature has the 'onePush' mode.

bool	setMode (int feature, FeatureMode mode) override
	Set the requested mode for the feature.

bool	getMode (int feature, FeatureMode *mode) override
	Get the current mode for the feature.

bool	setOnePush (int feature) override
	Set the requested feature to a value (saturation, brightness ... )

Public Member Functions inherited from yarp::dev::DeviceDriver
	DeviceDriver ()

	DeviceDriver (const DeviceDriver &other)=delete

	DeviceDriver (DeviceDriver &&other) noexcept=delete

DeviceDriver &	operator= (const DeviceDriver &other)=delete

DeviceDriver &	operator= (DeviceDriver &&other) noexcept=delete

virtual	~DeviceDriver ()

virtual std::string	id () const
	Return the id assigned to the PolyDriver.

virtual void	setId (const std::string &id)
	Set the id for this device.

template<class T >
bool	view (T *&x)
	Get an interface to the device driver.

virtual DeviceDriver *	getImplementation ()
	Some drivers are bureaucrats, pointing at others.

Public Member Functions inherited from yarp::dev::IPreciselyTimed
virtual	~IPreciselyTimed ()

Public Member Functions inherited from yarp::dev::IFrameGrabberControls
virtual	~IFrameGrabberControls ()
	Destructor.

std::string	busType2String (BusType type)

FeatureMode	toFeatureMode (bool _auto)

Public Member Functions inherited from yarp::dev::IFrameGrabberOf< yarp::sig::ImageOf< yarp::sig::PixelRgb > >
virtual bool	getImageCrop (cropType_id_t cropType, yarp::sig::VectorOf< std::pair< int, int > > vertices, yarp::sig::ImageOf< yarp::sig::PixelRgb > &image)
	Get a crop of the image from the frame grabber.

Public Member Functions inherited from yarp::dev::IFrameGrabberImageBase
virtual	~IFrameGrabberImageBase ()
	Destructor.

Detailed Description

Definition at line 31 of file UltraPythonDriver.h.

Constructor & Destructor Documentation

◆ UltraPythonDriver()

UltraPythonDriver::UltraPythonDriver ( )

Definition at line 35 of file UltraPythonDriver.cpp.

◆ ~UltraPythonDriver()

UltraPythonDriver::~UltraPythonDriver ( )

override

Definition at line 63 of file UltraPythonDriver.cpp.

Member Function Documentation

◆ close()

bool UltraPythonDriver::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 87 of file UltraPythonDriver.cpp.

◆ getActive()

bool UltraPythonDriver::getActive	(	int	feature,
		bool *	isActive
	)

overridevirtual

Get the current status of the feature, on or off.

Parameters

feature	the identifier of the feature to check
isActive	flag true if the feature is active, false otherwise

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 215 of file UltraPythonDriver.cpp.

◆ getCameraDescription()

bool UltraPythonDriver::getCameraDescription ( CameraDescriptor * camera )

overridevirtual

Get a basic description of the camera hw.

This is mainly used to determine the HW bus type in order to choose the corresponding interface for advanced controls.

Parameters

device returns an identifier for the bus

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 135 of file UltraPythonDriver.cpp.

◆ getFeature() [1/2]

bool UltraPythonDriver::getFeature	(	int	feature,
		double *	value
	)

overridevirtual

Get the current value for the requested feature.

Parameters

feature	the identifier of the feature to read
value	pointer to current value of the feature, from 0 to 1 expressed as a percentage

Returns: returns true on success, false on failure.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 169 of file UltraPythonDriver.cpp.

◆ getFeature() [2/2]

bool UltraPythonDriver::getFeature	(	int	feature,
		double *	value1,
		double *	value2
	)

overridevirtual

Get the current value for the requested feature.

Parameters

feature	the identifier of the feaature to read
value1	returns the current value of the feature, from 0 to 1 expressed as a percentage
value2	returns the current value of the feature, from 0 to 1 expressed as a percentage

Returns: returns true on success, false on failure.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 197 of file UltraPythonDriver.cpp.

◆ getImage()

bool UltraPythonDriver::getImage ( yarp::sig::ImageOf< yarp::sig::PixelRgb > & image )

overridevirtual

Get an image from the frame grabber.

Parameters

image the image to be filled

Returns: true/false upon success/failure

Implements yarp::dev::IFrameGrabberOf< yarp::sig::ImageOf< yarp::sig::PixelRgb > >.

Definition at line 110 of file UltraPythonDriver.cpp.

◆ getLastInputStamp()

yarp::os::Stamp UltraPythonDriver::getLastInputStamp ( )

overridevirtual

Return the time stamp relative to the last acquisition.

Implements yarp::dev::IPreciselyTimed.

Definition at line 104 of file UltraPythonDriver.cpp.

◆ getMode()

bool UltraPythonDriver::getMode	(	int	feature,
		FeatureMode *	mode
	)

overridevirtual

Get the current mode for the feature.

Parameters

feature	the identifier of the feature to change
hasAuto	flag true if the feature is has 'auto' mode, false otherwise

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 241 of file UltraPythonDriver.cpp.

◆ hasAuto()

bool UltraPythonDriver::hasAuto	(	int	feature,
		bool *	hasAuto
	)

overridevirtual

Check if the requested feature has the 'auto' mode.

Parameters

feature	the identifier of the feature to check
hasAuto	flag true if the feature is has 'auto' mode, false otherwise

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 221 of file UltraPythonDriver.cpp.

◆ hasFeature()

bool UltraPythonDriver::hasFeature	(	int	feature,
		bool *	hasFeature
	)

overridevirtual

Check if camera has the requested feature (saturation, brightness ... )

Parameters

feature	the identifier of the feature to check
hasFeature	flag value: true if the feature is present, false otherwise

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 142 of file UltraPythonDriver.cpp.

◆ hasManual()

bool UltraPythonDriver::hasManual	(	int	feature,
		bool *	hasManual
	)

overridevirtual

Check if the requested feature has the 'manual' mode.

Parameters

feature	the identifier of the feature to check
hasAuto	flag true if the feature is has 'manual' mode, false otherwise

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 227 of file UltraPythonDriver.cpp.

◆ hasOnePush()

bool UltraPythonDriver::hasOnePush	(	int	feature,
		bool *	hasOnePush
	)

overridevirtual

Check if the requested feature has the 'onePush' mode.

Parameters

feature	the identifier of the feature to check
hasAuto	flag true if the feature is has 'onePush' mode, false otherwise

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 253 of file UltraPythonDriver.cpp.

◆ hasOnOff()

bool UltraPythonDriver::hasOnOff	(	int	feature,
		bool *	HasOnOff
	)

overridevirtual

Check if the camera has the ability to turn on/off the requested feature.

Parameters

feature	the identifier of the feature to change
hasOnOff	flag true if this feature can be turned on/off, false otherwise.

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 209 of file UltraPythonDriver.cpp.

◆ height()

int UltraPythonDriver::height ( ) const

overridevirtual

Return the height of each frame.

Returns: image height

Implements yarp::dev::IFrameGrabberImageBase.

Definition at line 99 of file UltraPythonDriver.cpp.

◆ open()

bool UltraPythonDriver::open ( yarp::os::Searchable & config )

overridevirtual

Open the DeviceDriver.

Parameters

config is a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).

Returns: true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 68 of file UltraPythonDriver.cpp.

◆ setActive()

bool UltraPythonDriver::setActive	(	int	feature,
		bool	onoff
	)

overridevirtual

Set the requested feature on or off.

Parameters

feature	the identifier of the feature to change
onoff	true to activate, off to deactivate the feature

Returns: returns true on success, false on failure.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 247 of file UltraPythonDriver.cpp.

◆ setFeature() [1/2]

bool UltraPythonDriver::setFeature	(	int	feature,
		double	value
	)

overridevirtual

Set the requested feature to a value (saturation, brightness ... )

Parameters

feature	the identifier of the feature to change
value	new value of the feature, range from 0 to 1 expressed as a percentage

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 152 of file UltraPythonDriver.cpp.

◆ setFeature() [2/2]

bool UltraPythonDriver::setFeature	(	int	feature,
		double	value1,
		double	value2
	)

overridevirtual

Set the requested feature to a value using 2 params (like white balance)

Parameters

feature	the identifier of the feature to change
value1	first param, from 0 to 1 expressed as a percentage
value2	second param, from 0 to 1 expressed as a percentage

Returns: returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 203 of file UltraPythonDriver.cpp.

◆ setMode()

bool UltraPythonDriver::setMode	(	int	feature,
		FeatureMode	mode
	)

overridevirtual

Set the requested mode for the feature.

Parameters

feature	the identifier of the feature to change
auto_onoff	true to activate 'auto' mode, false to activate 'manual' mode

Returns: returns true on success, false on failure.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 235 of file UltraPythonDriver.cpp.

◆ setOnePush()

bool UltraPythonDriver::setOnePush ( int feature )

overridevirtual

Set the requested feature to a value (saturation, brightness ... )

Parameters

feature	the identifier of the feature to change
value	new value of the feature, from 0 to 1 as a percentage of param range

Returns: returns true on success, false on failure.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 260 of file UltraPythonDriver.cpp.

◆ width()

int UltraPythonDriver::width ( ) const

overridevirtual

Return the width of each frame.

Returns: image width

Implements yarp::dev::IFrameGrabberImageBase.

Definition at line 94 of file UltraPythonDriver.cpp.

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

opt-modules/yarp-device-ultrapython/src/devices/ultrapython/UltraPythonDriver.h
opt-modules/yarp-device-ultrapython/src/devices/ultrapython/UltraPythonDriver.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ UltraPythonDriver()

◆ ~UltraPythonDriver()

Member Function Documentation

◆ close()

◆ getActive()

◆ getCameraDescription()

◆ getFeature() [1/2]

◆ getFeature() [2/2]

◆ getImage()

◆ getLastInputStamp()

◆ getMode()

◆ hasAuto()

◆ hasFeature()

◆ hasManual()

◆ hasOnePush()

◆ hasOnOff()

◆ height()

◆ open()

◆ setActive()

◆ setFeature() [1/2]

◆ setFeature() [2/2]

◆ setMode()

◆ setOnePush()

◆ width()