YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::dev::IFrameGrabberControls Class Referenceabstract

Control interface for frame grabber devices. More...

#include <yarp/dev/IFrameGrabberControls.h>

+ Inheritance diagram for yarp::dev::IFrameGrabberControls:

Public Member Functions

virtual ~IFrameGrabberControls ()
 Destructor.
 
std::string busType2String (BusType type)
 
FeatureMode toFeatureMode (bool _auto)
 
virtual bool getCameraDescription (CameraDescriptor *camera)=0
 Get a basic description of the camera hw.
 
virtual bool hasFeature (int feature, bool *hasFeature)=0
 Check if camera has the requested feature (saturation, brightness ... )
 
virtual bool setFeature (int feature, double value)=0
 Set the requested feature to a value (saturation, brightness ... )
 
virtual bool getFeature (int feature, double *value)=0
 Get the current value for the requested feature.
 
virtual bool setFeature (int feature, double value1, double value2)=0
 Set the requested feature to a value using 2 params (like white balance)
 
virtual bool getFeature (int feature, double *value1, double *value2)=0
 Get the current value for the requested feature.
 
virtual bool hasOnOff (int feature, bool *HasOnOff)=0
 Check if the camera has the ability to turn on/off the requested feature.
 
virtual bool setActive (int feature, bool onoff)=0
 Set the requested feature on or off.
 
virtual bool getActive (int feature, bool *isActive)=0
 Get the current status of the feature, on or off.
 
virtual bool hasAuto (int feature, bool *hasAuto)=0
 Check if the requested feature has the 'auto' mode.
 
virtual bool hasManual (int feature, bool *hasManual)=0
 Check if the requested feature has the 'manual' mode.
 
virtual bool hasOnePush (int feature, bool *hasOnePush)=0
 Check if the requested feature has the 'onePush' mode.
 
virtual bool setMode (int feature, FeatureMode mode)=0
 Set the requested mode for the feature.
 
virtual bool getMode (int feature, FeatureMode *mode)=0
 Get the current mode for the feature.
 
virtual bool setOnePush (int feature)=0
 Set the requested feature to a value (saturation, brightness ... )
 

Detailed Description

Control interface for frame grabber devices.

Definition at line 67 of file IFrameGrabberControls.h.

Constructor & Destructor Documentation

◆ ~IFrameGrabberControls()

yarp::dev::IFrameGrabberControls::~IFrameGrabberControls ( )
virtualdefault

Destructor.

Member Function Documentation

◆ busType2String()

std::string yarp::dev::IFrameGrabberControls::busType2String ( BusType  type)
inline

Definition at line 75 of file IFrameGrabberControls.h.

◆ getActive()

virtual bool yarp::dev::IFrameGrabberControls::getActive ( int  feature,
bool *  isActive 
)
pure virtual

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

Parameters
featurethe identifier of the feature to check
isActiveflag true if the feature is active, false otherwise
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in V4L_camera, pylonCameraDriver, realsense2Driver, UltraPythonDriver, IFrameGrabberControlsMock, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, and USBCameraDriver.

◆ getCameraDescription()

virtual bool yarp::dev::IFrameGrabberControls::getCameraDescription ( CameraDescriptor camera)
pure virtual

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
devicereturns an identifier for the bus
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in pylonCameraDriver, realsense2Driver, UltraPythonDriver, IFrameGrabberControlsMock, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ getFeature() [1/2]

virtual bool yarp::dev::IFrameGrabberControls::getFeature ( int  feature,
double *  value 
)
pure virtual

Get the current value for the requested feature.

Parameters
featurethe identifier of the feature to read
valuepointer to current value of the feature, from 0 to 1 expressed as a percentage
Returns
returns true on success, false on failure.

Implemented in pylonCameraDriver, realsense2Driver, UltraPythonDriver, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ getFeature() [2/2]

virtual bool yarp::dev::IFrameGrabberControls::getFeature ( int  feature,
double *  value1,
double *  value2 
)
pure virtual

Get the current value for the requested feature.

Parameters
featurethe identifier of the feaature to read
value1returns the current value of the feature, from 0 to 1 expressed as a percentage
value2returns the current value of the feature, from 0 to 1 expressed as a percentage
Returns
returns true on success, false on failure.

Implemented in pylonCameraDriver, realsense2Driver, UltraPythonDriver, IFrameGrabberControlsMock, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ getMode()

virtual bool yarp::dev::IFrameGrabberControls::getMode ( int  feature,
FeatureMode mode 
)
pure virtual

Get the current mode for the feature.

Parameters
featurethe identifier of the feature to change
hasAutoflag true if the feature is has 'auto' mode, false otherwise
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in pylonCameraDriver, realsense2Driver, UltraPythonDriver, IFrameGrabberControlsMock, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ hasAuto()

virtual bool yarp::dev::IFrameGrabberControls::hasAuto ( int  feature,
bool *  hasAuto 
)
pure virtual

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

Parameters
featurethe identifier of the feature to check
hasAutoflag true if the feature is has 'auto' mode, false otherwise
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in V4L_camera, pylonCameraDriver, realsense2Driver, UltraPythonDriver, IFrameGrabberControlsMock, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, and USBCameraDriver.

◆ hasFeature()

virtual bool yarp::dev::IFrameGrabberControls::hasFeature ( int  feature,
bool *  hasFeature 
)
pure virtual

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

Parameters
featurethe identifier of the feature to check
hasFeatureflag value: true if the feature is present, false otherwise
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in pylonCameraDriver, realsense2Driver, UltraPythonDriver, IFrameGrabberControlsMock, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ hasManual()

virtual bool yarp::dev::IFrameGrabberControls::hasManual ( int  feature,
bool *  hasManual 
)
pure virtual

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

Parameters
featurethe identifier of the feature to check
hasAutoflag true if the feature is has 'manual' mode, false otherwise
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in V4L_camera, pylonCameraDriver, realsense2Driver, UltraPythonDriver, IFrameGrabberControlsMock, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, and USBCameraDriver.

◆ hasOnePush()

virtual bool yarp::dev::IFrameGrabberControls::hasOnePush ( int  feature,
bool *  hasOnePush 
)
pure virtual

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

Parameters
featurethe identifier of the feature to check
hasAutoflag true if the feature is has 'onePush' mode, false otherwise
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in V4L_camera, pylonCameraDriver, realsense2Driver, UltraPythonDriver, IFrameGrabberControlsMock, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, and USBCameraDriver.

◆ hasOnOff()

virtual bool yarp::dev::IFrameGrabberControls::hasOnOff ( int  feature,
bool *  HasOnOff 
)
pure virtual

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

Parameters
featurethe identifier of the feature to change
hasOnOffflag 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)

Implemented in V4L_camera, pylonCameraDriver, realsense2Driver, UltraPythonDriver, IFrameGrabberControlsMock, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, and USBCameraDriver.

◆ setActive()

virtual bool yarp::dev::IFrameGrabberControls::setActive ( int  feature,
bool  onoff 
)
pure virtual

Set the requested feature on or off.

Parameters
featurethe identifier of the feature to change
onofftrue to activate, off to deactivate the feature
Returns
returns true on success, false on failure.

Implemented in pylonCameraDriver, realsense2Driver, UltraPythonDriver, IFrameGrabberControlsMock, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ setFeature() [1/2]

virtual bool yarp::dev::IFrameGrabberControls::setFeature ( int  feature,
double  value 
)
pure virtual

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

Parameters
featurethe identifier of the feature to change
valuenew 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)

Implemented in pylonCameraDriver, realsense2Driver, UltraPythonDriver, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ setFeature() [2/2]

virtual bool yarp::dev::IFrameGrabberControls::setFeature ( int  feature,
double  value1,
double  value2 
)
pure virtual

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

Parameters
featurethe identifier of the feature to change
value1first param, from 0 to 1 expressed as a percentage
value2second param, from 0 to 1 expressed as a percentage
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implemented in pylonCameraDriver, realsense2Driver, UltraPythonDriver, IFrameGrabberControlsMock, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ setMode()

virtual bool yarp::dev::IFrameGrabberControls::setMode ( int  feature,
FeatureMode  mode 
)
pure virtual

Set the requested mode for the feature.

Parameters
featurethe identifier of the feature to change
auto_onofftrue to activate 'auto' mode, false to activate 'manual' mode
Returns
returns true on success, false on failure.

Implemented in pylonCameraDriver, realsense2Driver, UltraPythonDriver, IFrameGrabberControlsMock, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ setOnePush()

virtual bool yarp::dev::IFrameGrabberControls::setOnePush ( int  feature)
pure virtual

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

Parameters
featurethe identifier of the feature to change
valuenew value of the feature, from 0 to 1 as a percentage of param range
Returns
returns true on success, false on failure.

Implemented in pylonCameraDriver, realsense2Driver, UltraPythonDriver, IFrameGrabberControlsMock, FakeFrameGrabber, FrameGrabberCropper, yarp::proto::framegrabber::FrameGrabberControls_Forwarder, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ toFeatureMode()

FeatureMode yarp::dev::IFrameGrabberControls::toFeatureMode ( bool  _auto)
inline

Definition at line 92 of file IFrameGrabberControls.h.


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