YARP
Yet Another Robot Platform
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...
 
virtual bool setLimitsRaw (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 getLimitsRaw (int axis, double *min, double *max)=0
 Get the software limits for a particular axis. More...
 
virtual bool setVelLimitsRaw (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 getVelLimitsRaw (int axis, double *min, double *max)=0
 Get the software speed limits for a particular axis. 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 81 of file ImplementControlLimits.h.

Constructor & Destructor Documentation

◆ ~StubImplControlLimitsRaw()

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

Destructor.

Definition at line 104 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
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.

Implements yarp::dev::IControlLimitsRaw.

Definition at line 111 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
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.

Implements yarp::dev::IControlLimitsRaw.

Definition at line 121 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
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

Implements yarp::dev::IControlLimitsRaw.

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

Implements yarp::dev::IControlLimitsRaw.

Definition at line 116 of file ImplementControlLimits.h.


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