YARP
Yet Another Robot Platform
yarp::dev::IControlLimits Class Referenceabstract

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

#include <yarp/dev/IControlLimits.h>

+ Inheritance diagram for yarp::dev::IControlLimits:

Detailed Description

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

Definition at line 32 of file IControlLimits.h.

Public Member Functions

virtual ~IControlLimits ()
 Destructor. More...
 
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. More...
 
virtual bool getLimits (int axis, double *min, double *max)=0
 Get the software limits for a particular axis. More...
 
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. More...
 
virtual bool getVelLimits (int axis, double *min, double *max)=0
 Get the software speed limits for a particular axis. More...
 

Constructor & Destructor Documentation

◆ ~IControlLimits()

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

Destructor.

Definition at line 38 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
axisjoint number
pointerto store the value of the lower limit
pointerto store the value of the upper limit
Returns
true if everything goes fine, false otherwise.

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

◆ 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
axisjoint number
minpointer to store the value of the lower limit
maxpointer to store the value of the upper limit
Returns
true if everything goes fine, false otherwise.

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

◆ 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
axisjoint number (why am I telling you this)
minthe value of the lower limit
maxthe value of the upper limit
Returns
true or false on success or failure

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

◆ 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
axisjoint number
minthe value of the lower limit
maxthe value of the upper limit
Returns
true or false on success or failure

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


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