YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::dev::IVelocityControl Class Referenceabstract

Interface for control boards implementing velocity control. More...

#include <yarp/dev/IVelocityControl.h>

+ Inheritance diagram for yarp::dev::IVelocityControl:

Public Member Functions

virtual ~IVelocityControl ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAxes (size_t &axes)=0
 Get the number of controlled axes.
 
virtual yarp::dev::ReturnValue velocityMove (int j, double sp)=0
 Start motion at a given speed, single joint.
 
virtual yarp::dev::ReturnValue velocityMove (const double *sp)=0
 Start motion at a given speed, multiple joints.
 
virtual yarp::dev::ReturnValue setTrajAcceleration (int j, double acc)=0
 Set reference acceleration for a joint.
 
virtual yarp::dev::ReturnValue setTrajAccelerations (const double *accs)=0
 Set reference acceleration on all joints.
 
virtual yarp::dev::ReturnValue getTrajAcceleration (int j, double *acc)=0
 Get reference acceleration for a joint.
 
virtual yarp::dev::ReturnValue getTrajAccelerations (double *accs)=0
 Get reference acceleration of all joints.
 
virtual yarp::dev::ReturnValue stop (int j)=0
 Stop motion, single joint.
 
virtual yarp::dev::ReturnValue stop ()=0
 Stop motion, multiple joints.
 
virtual yarp::dev::ReturnValue velocityMove (const int n_joint, const int *joints, const double *spds)=0
 Start motion at a given speed for a subset of joints.
 
virtual yarp::dev::ReturnValue getTargetVelocity (const int joint, double *vel)=0
 Get the last reference speed set by velocityMove for single joint.
 
virtual yarp::dev::ReturnValue getTargetVelocities (double *vels)=0
 Get the last reference speed set by velocityMove for all joints.
 
virtual yarp::dev::ReturnValue getTargetVelocities (const int n_joint, const int *joints, double *vels)=0
 Get the last reference speed set by velocityMove for a group of joints.
 
virtual yarp::dev::ReturnValue setTrajAccelerations (const int n_joint, const int *joints, const double *accs)=0
 Set reference acceleration for a subset of joints.
 
virtual yarp::dev::ReturnValue getTrajAccelerations (const int n_joint, const int *joints, double *accs)=0
 Get reference acceleration for a subset of joints.
 
virtual yarp::dev::ReturnValue stop (const int n_joint, const int *joints)=0
 Stop motion for a subset of joints.
 

Detailed Description

Interface for control boards implementing velocity control.

Definition at line 155 of file IVelocityControl.h.

Constructor & Destructor Documentation

◆ ~IVelocityControl()

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

Destructor.

Definition at line 161 of file IVelocityControl.h.

Member Function Documentation

◆ getAxes()

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::getAxes ( size_t &  axes)
pure virtual

Get the number of controlled axes.

This command asks the number of controlled axes for the current physical interface. param axes pointer to storage

Returns
true/false.

Implemented in ControlBoardRemapper, FakeLaserWithMotor, FakeMotionControl, ControlBoard_nwc_yarp, and yarp::dev::ImplementVelocityControl.

◆ getTargetVelocities() [1/2]

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::getTargetVelocities ( const int  n_joint,
const int *  joints,
double *  vels 
)
pure virtual

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

Implemented in ControlBoardRemapper, ControlBoard_nwc_yarp, and yarp::dev::ImplementVelocityControl.

◆ getTargetVelocities() [2/2]

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::getTargetVelocities ( double *  vels)
pure virtual

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

Implemented in ControlBoardRemapper, ControlBoard_nwc_yarp, and yarp::dev::ImplementVelocityControl.

◆ getTargetVelocity()

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::getTargetVelocity ( const int  joint,
double *  vel 
)
pure virtual

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

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

Implemented in ControlBoardRemapper, ControlBoard_nwc_yarp, and yarp::dev::ImplementVelocityControl.

◆ getTrajAcceleration()

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::getTrajAcceleration ( int  j,
double *  acc 
)
pure virtual

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

Implemented in ControlBoardRemapper, ControlBoard_nwc_yarp, and yarp::dev::ImplementVelocityControl.

◆ getTrajAccelerations() [1/2]

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::getTrajAccelerations ( const int  n_joint,
const int *  joints,
double *  accs 
)
pure virtual

Get reference acceleration for a subset of joints.

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

Parameters
n_jointhow many joints this command is referring to
jointslist of joints controlled. The size of this array is n_joints
accspointer to the array containing acceleration values, one value for each joint, the size of the array is n_joints. The first value will be the new reference for the joint joints[0]. for example: n_joint 3 joints 0 2 4 accs 10 30 40
Returns
true/false on success/failure

Implemented in ControlBoard_nwc_yarp, yarp::dev::ImplementVelocityControl, and ControlBoardRemapper.

◆ getTrajAccelerations() [2/2]

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::getTrajAccelerations ( double *  accs)
pure virtual

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

Implemented in ControlBoardRemapper, ControlBoard_nwc_yarp, and yarp::dev::ImplementVelocityControl.

◆ setTrajAcceleration()

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::setTrajAcceleration ( int  j,
double  acc 
)
pure virtual

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

Implemented in ControlBoardRemapper, ControlBoard_nwc_yarp, and yarp::dev::ImplementVelocityControl.

◆ setTrajAccelerations() [1/2]

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::setTrajAccelerations ( const double *  accs)
pure virtual

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

Implemented in ControlBoardRemapper, ControlBoard_nwc_yarp, and yarp::dev::ImplementVelocityControl.

◆ setTrajAccelerations() [2/2]

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::setTrajAccelerations ( const int  n_joint,
const int *  joints,
const double *  accs 
)
pure virtual

Set reference acceleration for a subset of joints.

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

Parameters
n_jointhow many joints this command is referring to
jointslist of joints controlled. The size of this array is n_joints
accspointer to the array containing acceleration values, one value for each joint, the size of the array is n_joints. The first value will be the new reference for the joint joints[0]. for example: n_joint 3 joints 0 2 4 accs 10 30 40
Returns
true/false on success/failure

Implemented in ControlBoard_nwc_yarp, yarp::dev::ImplementVelocityControl, and ControlBoardRemapper.

◆ stop() [1/3]

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::stop ( )
pure virtual

Stop motion, multiple joints.

Returns
true/false on success or failure

Implemented in yarp::dev::xHandControlBoard, ControlBoardRemapper, ControlBoard_nwc_yarp, and yarp::dev::ImplementVelocityControl.

◆ stop() [2/3]

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::stop ( const int  n_joint,
const int *  joints 
)
pure virtual

Stop motion for a subset of joints.

Parameters
n_jointhow many joints this command is referring to
jointsjoints pointer to the array of joint numbers
Returns
true/false on success or failure

Implemented in ControlBoard_nwc_yarp, yarp::dev::ImplementVelocityControl, yarp::dev::xHandControlBoard, and ControlBoardRemapper.

◆ stop() [3/3]

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::stop ( int  j)
pure virtual

Stop motion, single joint.

Parameters
jjoint number
Returns
true/false on success or failure

Implemented in yarp::dev::xHandControlBoard, ControlBoardRemapper, ControlBoard_nwc_yarp, and yarp::dev::ImplementVelocityControl.

◆ velocityMove() [1/3]

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::velocityMove ( const double *  sp)
pure virtual

Start motion at a given speed, multiple joints.

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

Implemented in yarp::dev::ImplementVelocityControl, yarp::dev::xHandControlBoard, ControlBoardRemapper, and ControlBoard_nwc_yarp.

◆ velocityMove() [2/3]

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::velocityMove ( const int  n_joint,
const int *  joints,
const double *  spds 
)
pure virtual

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

Parameters
n_jointhow many joints this command is referring to
jointsof joints controlled. The size of this array is n_joints
spdspointer to the array containing the new speed values, one value for each joint, the size of the array is n_joints. The first value will be the new reference for the joint joints[0]. for example: n_joint 3 joints 0 2 4 spds 10 30 40
Returns
true/false on success/failure

Implemented in ControlBoard_nwc_yarp, yarp::dev::ImplementVelocityControl, yarp::dev::xHandControlBoard, and ControlBoardRemapper.

◆ velocityMove() [3/3]

virtual yarp::dev::ReturnValue yarp::dev::IVelocityControl::velocityMove ( int  j,
double  sp 
)
pure virtual

Start motion at a given speed, single joint.

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

Implemented in yarp::dev::ImplementVelocityControl, yarp::dev::xHandControlBoard, ControlBoardRemapper, and ControlBoard_nwc_yarp.


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