yarp::dev::IControlLimits Class Reference

Interface for control devices, commands to get/set position and veloity limits. More...

#include <yarp/dev/IControlLimits.h>

Inheritance diagram for yarp::dev::IControlLimits:

Public Member Functions
virtual	~IControlLimits ()
	Destructor.
virtual bool	setLimits (int axis, double min, double max)=0
	Set the software limits for a particular axis, the behavior of the control card when these limits are exceeded, depends on the implementation.
virtual bool	getLimits (int axis, double *min, double *max)=0
	Get the software limits for a particular axis.
virtual bool	setVelLimits (int axis, double min, double max)=0
	Set the software speed limits for a particular axis, the behavior of the control card when these limits are exceeded, depends on the implementation.
virtual bool	getVelLimits (int axis, double *min, double *max)=0
	Get the software speed limits for a particular axis.

Detailed Description

Interface for control devices, commands to get/set position and veloity limits.

Definition at line 25 of file IControlLimits.h.

Constructor & Destructor Documentation

~IControlLimits()

virtual yarp::dev::IControlLimits::~IControlLimits ( )

inlinevirtual

Destructor.

Definition at line 31 of file IControlLimits.h.

Member Function Documentation

getLimits()

virtual bool yarp::dev::IControlLimits::getLimits ( int  axis, double *  min, double *  max  )

pure virtual

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.

Implemented in FakeBot, RemoteControlBoard, yarp::dev::ImplementControlLimits, and ControlBoardRemapper.

getVelLimits()

virtual bool yarp::dev::IControlLimits::getVelLimits ( int  axis, double *  min, double *  max  )

pure virtual

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.

Implemented in FakeBot, RemoteControlBoard, yarp::dev::ImplementControlLimits, and ControlBoardRemapper.

setLimits()

virtual bool yarp::dev::IControlLimits::setLimits ( int  axis, double  min, double  max  )

pure virtual

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

Implemented in FakeBot, RemoteControlBoard, yarp::dev::ImplementControlLimits, and ControlBoardRemapper.

setVelLimits()

virtual bool yarp::dev::IControlLimits::setVelLimits ( int  axis, double  min, double  max  )

pure virtual

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

Implemented in FakeBot, RemoteControlBoard, yarp::dev::ImplementControlLimits, and ControlBoardRemapper.

---

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

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