YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::dev::StubImplVelocityControlRaw Class Reference

Stub implementation of IPositionControl2Raw interface. More...

#include <yarp/dev/ImplementVelocityControl.h>

+ Inheritance diagram for yarp::dev::StubImplVelocityControlRaw:

Public Member Functions

yarp::dev::ReturnValue getAxes (size_t &axes) override
 Get the number of controlled axes.
 
yarp::dev::ReturnValue velocityMoveRaw (int j, double sp) override
 Start motion at a given speed, single joint.
 
yarp::dev::ReturnValue velocityMoveRaw (const double *sp) override
 Start motion at a given speed, multiple joints.
 
yarp::dev::ReturnValue setTrajAccelerationRaw (int j, double acc) override
 Set reference acceleration for a joint.
 
yarp::dev::ReturnValue setTrajAccelerationsRaw (const double *accs) override
 Set reference acceleration on all joints.
 
yarp::dev::ReturnValue getTrajAccelerationRaw (int j, double *acc) override
 Get reference acceleration for a joint.
 
yarp::dev::ReturnValue getTrajAccelerationsRaw (double *accs) override
 Get reference acceleration of all joints.
 
yarp::dev::ReturnValue stopRaw (int j) override
 Stop motion, single joint.
 
yarp::dev::ReturnValue stopRaw () override
 Stop motion, multiple joints.
 
yarp::dev::ReturnValue velocityMoveRaw (const int n_joint, const int *joints, const double *spds) override
 Start motion at a given speed for a subset of joints.
 
yarp::dev::ReturnValue getTargetVelocityRaw (const int joint, double *vel) override
 Get the last reference speed set by velocityMove for single joint.
 
yarp::dev::ReturnValue getTargetVelocitiesRaw (double *vels) override
 Get the last reference speed set by velocityMove for all joints.
 
yarp::dev::ReturnValue getTargetVelocitiesRaw (const int n_joint, const int *joints, double *vels) override
 Get the last reference speed set by velocityMove for a group of joints.
 
yarp::dev::ReturnValue setTrajAccelerationsRaw (const int n_joint, const int *joints, const double *accs) override
 Set reference acceleration for a subset of joints.
 
yarp::dev::ReturnValue getTrajAccelerationsRaw (const int n_joint, const int *joints, double *accs) override
 Get reference acceleration for a subset of joints.
 
yarp::dev::ReturnValue stopRaw (const int n_joint, const int *joints) override
 Stop motion for a subset of joints.
 
- Public Member Functions inherited from yarp::dev::IVelocityControlRaw
virtual ~IVelocityControlRaw ()
 Destructor.
 

Detailed Description

Stub implementation of IPositionControl2Raw interface.

Inherit from this class if you want a stub implementation of methods in IPositionControlRaw. 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 98 of file ImplementVelocityControl.h.

Member Function Documentation

◆ getAxes()

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::getAxes ( size_t &  axis)
inlineoverridevirtual

Get the number of controlled axes.

This command asks the number of controlled axes for the current physical interface.

Parameters
axispointer to storage, return value
Returns
true/false.

Implements yarp::dev::IVelocityControlRaw.

Definition at line 101 of file ImplementVelocityControl.h.

◆ getTargetVelocitiesRaw() [1/2]

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::getTargetVelocitiesRaw ( const int  n_joint,
const int *  joints,
double *  vels 
)
inlineoverridevirtual

Get the last reference speed set by velocityMove for a group of joints.

Parameters
n_jointhow many joints this command is referring to
jointsof joints controlled. The size of this array is n_joints
velspointer to the array containing the requested values, one value for each joint. The size of the array is n_joints.
Returns
true/false on success/failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 137 of file ImplementVelocityControl.h.

◆ getTargetVelocitiesRaw() [2/2]

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::getTargetVelocitiesRaw ( double *  vels)
inlineoverridevirtual

Get the last reference speed set by velocityMove for all joints.

Parameters
velspointer to the array containing the new speed values, one value for each joint
Returns
true/false on success/failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 134 of file ImplementVelocityControl.h.

◆ getTargetVelocityRaw()

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::getTargetVelocityRaw ( const int  joint,
double *  vel 
)
inlineoverridevirtual

Get the last reference speed set by velocityMove for single joint.

Parameters
jjoint number
velreturns the requested reference.
Returns
true/false on success/failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 131 of file ImplementVelocityControl.h.

◆ getTrajAccelerationRaw()

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::getTrajAccelerationRaw ( int  j,
double *  acc 
)
inlineoverridevirtual

Get reference acceleration for a joint.

Returns the acceleration used to generate the trajectory profile.

Parameters
jjoint number
accpointer to storage for the return value
Returns
true/false on success/failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 116 of file ImplementVelocityControl.h.

◆ getTrajAccelerationsRaw() [1/2]

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::getTrajAccelerationsRaw ( const int  n_joint,
const int *  joints,
double *  accs 
)
inlineoverridevirtual

Get reference acceleration for a subset of joints.

These are the values used during the interpolation of the trajectory.

Parameters
jointspointer to the array of joint numbers
accspointer to the array that will store the acceleration values.
Returns
true/false on success or failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 143 of file ImplementVelocityControl.h.

◆ getTrajAccelerationsRaw() [2/2]

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::getTrajAccelerationsRaw ( double *  accs)
inlineoverridevirtual

Get reference acceleration of all joints.

These are the values used during the interpolation of the trajectory.

Parameters
accspointer to the array that will store the acceleration values.
Returns
true/false on success or failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 119 of file ImplementVelocityControl.h.

◆ setTrajAccelerationRaw()

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::setTrajAccelerationRaw ( int  j,
double  acc 
)
inlineoverridevirtual

Set reference acceleration for a joint.

This value is used during the trajectory generation.

Parameters
jjoint number
accacceleration value
Returns
true/false upon success/failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 110 of file ImplementVelocityControl.h.

◆ setTrajAccelerationsRaw() [1/2]

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::setTrajAccelerationsRaw ( const double *  accs)
inlineoverridevirtual

Set reference acceleration on all joints.

This is the value that is used during the generation of the trajectory.

Parameters
accspointer to the array of acceleration values
Returns
true/false upon success/failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 113 of file ImplementVelocityControl.h.

◆ setTrajAccelerationsRaw() [2/2]

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::setTrajAccelerationsRaw ( const int  n_joint,
const int *  joints,
const double *  accs 
)
inlineoverridevirtual

Set reference acceleration for a subset of joints.

This is the value that is used during the generation of the trajectory.

Parameters
jointspointer to the array of joint numbers
accspointer to the array containing acceleration values
Returns
true/false upon success/failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 140 of file ImplementVelocityControl.h.

◆ stopRaw() [1/3]

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::stopRaw ( )
inlineoverridevirtual

Stop motion, multiple joints.

Returns
true/false on success or failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 125 of file ImplementVelocityControl.h.

◆ stopRaw() [2/3]

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::stopRaw ( const int  n_joint,
const int *  joints 
)
inlineoverridevirtual

Stop motion for a subset of joints.

Parameters
jointspointer to the array of joint numbers
Returns
true/false on success or failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 146 of file ImplementVelocityControl.h.

◆ stopRaw() [3/3]

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::stopRaw ( int  j)
inlineoverridevirtual

Stop motion, single joint.

Parameters
jjoint number
Returns
true/false on success or failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 122 of file ImplementVelocityControl.h.

◆ velocityMoveRaw() [1/3]

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::velocityMoveRaw ( const double *  sp)
inlineoverridevirtual

Start motion at a given speed, multiple joints.

Parameters
sppointer to the array containing the new speed values
Returns
true/false upon success/failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 107 of file ImplementVelocityControl.h.

◆ velocityMoveRaw() [2/3]

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::velocityMoveRaw ( const int  n_joint,
const int *  joints,
const double *  spds 
)
inlineoverridevirtual

Start motion at a given speed for a subset of joints.

Parameters
n_jointhow many joints this command is referring to
jointspointer to the array of joint numbers
spdspointer to the array containing the new speed values
Returns
true/false upon success/failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 128 of file ImplementVelocityControl.h.

◆ velocityMoveRaw() [3/3]

yarp::dev::ReturnValue yarp::dev::StubImplVelocityControlRaw::velocityMoveRaw ( int  j,
double  sp 
)
inlineoverridevirtual

Start motion at a given speed, single joint.

Parameters
jjoint number
spspeed value
Returns
bool/false upon success/failure

Implements yarp::dev::IVelocityControlRaw.

Definition at line 104 of file ImplementVelocityControl.h.


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