yarp::dev::StubImplControlLimitsRaw Class Reference

Stub implementation of IControlLimitRaw interface. More...

#include <yarp/dev/ImplementControlLimits.h>

Inheritance diagram for yarp::dev::StubImplControlLimitsRaw:

Public Member Functions
virtual	~StubImplControlLimitsRaw ()
	Destructor. More...
bool	setLimitsRaw (int axis, double min, double max) override
	Set the software limits for a particular axis, the behavior of the control card when these limits are exceeded, depends on the implementation. More...
bool	getLimitsRaw (int axis, double *min, double *max) override
	Get the software limits for a particular axis. More...
bool	setVelLimitsRaw (int axis, double min, double max) override
	Set the software speed limits for a particular axis, the behavior of the control card when these limits are exceeded, depends on the implementation. More...
bool	getVelLimitsRaw (int axis, double *min, double *max) override
	Get the software speed limits for a particular axis. More...
Public Member Functions inherited from yarp::dev::IControlLimitsRaw
virtual	~IControlLimitsRaw ()
	Destructor. More...

Detailed Description

Stub implementation of IControlLimitRaw interface.

Inherit from this class if you want a stub implementation of methods in IControlLimit2Raw. This class allows to gradually implement an interface; you just have to implement functions that are useful for the underlying device. Another way to see this class is as a means to convert compile time errors in runtime errors.

If you use this class please be aware that the device you are wrapping might not function properly because you missed to implement useful functionalities.

Definition at line 85 of file ImplementControlLimits.h.

Constructor & Destructor Documentation

~StubImplControlLimitsRaw()

virtual yarp::dev::StubImplControlLimitsRaw::~StubImplControlLimitsRaw ( )

inlinevirtual

Destructor.

Definition at line 107 of file ImplementControlLimits.h.

Member Function Documentation

getLimitsRaw()

bool yarp::dev::StubImplControlLimitsRaw::getLimitsRaw ( int  axis, double *  min, double *  max  )

inlineoverridevirtual

Get the software limits for a particular axis.

Parameters

axis	joint number
pointer	to store the value of the lower limit
pointer	to store the value of the upper limit

Returns

true if everything goes fine, false otherwise.

Implements yarp::dev::IControlLimitsRaw.

Definition at line 114 of file ImplementControlLimits.h.

getVelLimitsRaw()

bool yarp::dev::StubImplControlLimitsRaw::getVelLimitsRaw ( int  axis, double *  min, double *  max  )

inlineoverridevirtual

Get the software speed limits for a particular axis.

Parameters

axis	joint number
min	pointer to store the value of the lower limit
max	pointer to store the value of the upper limit

Returns

true if everything goes fine, false otherwise.

Implements yarp::dev::IControlLimitsRaw.

Definition at line 124 of file ImplementControlLimits.h.

setLimitsRaw()

bool yarp::dev::StubImplControlLimitsRaw::setLimitsRaw ( int  axis, double  min, double  max  )

inlineoverridevirtual

Set the software limits for a particular axis, the behavior of the control card when these limits are exceeded, depends on the implementation.

Parameters

axis	joint number (why am I telling you this)
min	the value of the lower limit
max	the value of the upper limit

Returns

true or false on success or failure

Implements yarp::dev::IControlLimitsRaw.

Definition at line 109 of file ImplementControlLimits.h.

setVelLimitsRaw()

bool yarp::dev::StubImplControlLimitsRaw::setVelLimitsRaw ( int  axis, double  min, double  max  )

inlineoverridevirtual

Set the software speed limits for a particular axis, the behavior of the control card when these limits are exceeded, depends on the implementation.

Parameters

axis	joint number
min	the value of the lower limit
max	the value of the upper limit

Returns

true or false on success or failure

Implements yarp::dev::IControlLimitsRaw.

Definition at line 119 of file ImplementControlLimits.h.

---

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

• src/libYARP_dev/src/yarp/dev/ImplementControlLimits.h