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

Interface for a generic control board device implementing position control. More...

#include <yarp/dev/IPositionControl.h>

+ Inheritance diagram for yarp::dev::IPositionControl:

Public Member Functions

virtual ~IPositionControl ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAxes (size_t &ax)=0
 Get the number of controlled axes.
 
virtual yarp::dev::ReturnValue positionMove (int j, double ref)=0
 Set new reference point for a single axis.
 
virtual yarp::dev::ReturnValue positionMove (const double *refs)=0
 Set new reference point for all axes.
 
virtual yarp::dev::ReturnValue relativeMove (int j, double delta)=0
 Set relative position.
 
virtual yarp::dev::ReturnValue relativeMove (const double *deltas)=0
 Set relative position, all joints.
 
virtual yarp::dev::ReturnValue checkMotionDone (int j, bool &flag)=0
 Check if the current trajectory is terminated.
 
virtual yarp::dev::ReturnValue checkMotionDone (bool &flag)=0
 Check if the current trajectory is terminated.
 
virtual yarp::dev::ReturnValue setTrajSpeed (int j, double sp)=0
 Set reference speed for a joint, this is the speed used during the interpolation of the trajectory.
 
virtual yarp::dev::ReturnValue setTrajSpeeds (const double *spds)=0
 Set reference speed on all 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 getTrajSpeed (int j, double *ref)=0
 Get reference speed for a joint.
 
virtual yarp::dev::ReturnValue getTrajSpeeds (double *spds)=0
 Get reference speed of 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 positionMove (const int n_joint, const int *joints, const double *refs)=0
 Set new reference point for a subset of joints.
 
virtual yarp::dev::ReturnValue relativeMove (const int n_joint, const int *joints, const double *deltas)=0
 Set relative position for a subset of joints.
 
virtual yarp::dev::ReturnValue checkMotionDone (const std::vector< int > &joints, bool &flag)=0
 Check if the current trajectory is terminated.
 
virtual yarp::dev::ReturnValue setTrajSpeeds (const int n_joint, const int *joints, const double *spds)=0
 Set reference speed on all joints.
 
virtual yarp::dev::ReturnValue setTrajAccelerations (const int n_joint, const int *joints, const double *accs)=0
 Set reference acceleration on all joints.
 
virtual yarp::dev::ReturnValue getTrajSpeeds (const int n_joint, const int *joints, double *spds)=0
 Get reference speed of all joints.
 
virtual yarp::dev::ReturnValue getTrajAccelerations (const int n_joint, const int *joints, double *accs)=0
 Get reference acceleration for a joint.
 
virtual yarp::dev::ReturnValue stop (const int n_joint, const int *joints)=0
 Stop motion for subset of joints.
 
virtual yarp::dev::ReturnValue getTargetPosition (const int joint, double *ref)=0
 Get the last position reference for the specified axis.
 
virtual yarp::dev::ReturnValue getTargetPositions (double *refs)=0
 Get the last position reference for all axes.
 
virtual yarp::dev::ReturnValue getTargetPositions (const int n_joint, const int *joints, double *refs)=0
 Get the last position reference for the specified group of axes.
 

Detailed Description

Interface for a generic control board device implementing position control.

Examples
dev/motortest/motortest.cpp.

Definition at line 254 of file IPositionControl.h.

Constructor & Destructor Documentation

◆ ~IPositionControl()

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

Destructor.

Definition at line 260 of file IPositionControl.h.

Member Function Documentation

◆ checkMotionDone() [1/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::checkMotionDone ( bool &  flag)
pure virtual

Check if the current trajectory is terminated.

Non blocking.

Parameters
flagis a pointer to return value ("and" of all joints)
Returns
true/false on network communication (value you actually want is stored in *flag)

Implemented in ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ checkMotionDone() [2/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::checkMotionDone ( const std::vector< int > &  joints,
bool &  flag 
)
pure virtual

Check if the current trajectory is terminated.

Non blocking.

Parameters
jointsarray of joint numbers
flaglogical "and" of all set of joints
Returns
true/false if network communication went well.

Implemented in DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, ControlBoardRemapper, and yarp::dev::ImplementPositionControl.

◆ checkMotionDone() [3/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::checkMotionDone ( int  j,
bool &  flag 
)
pure virtual

Check if the current trajectory is terminated.

Non blocking.

Parameters
jis the axis number
flagis a pointer to return value
Returns
true/false on network communication (value you actually want is stored in *flag)

Implemented in ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ getAxes()

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::getAxes ( size_t &  ax)
pure virtual

Get the number of controlled axes.

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

Parameters
axpointer to storage
Returns
true/false.

Implemented in ControlBoardRemapper, DynamixelAX12FtdiDriver, FakeLaserWithMotor, FakeMotionControl, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ getTargetPosition()

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::getTargetPosition ( const int  joint,
double *  ref 
)
pure virtual

Get the last position reference for the specified axis.

This is the dual of PositionMove and shall return only values sent using IPositionControl interface. If other interfaces like IPositionDirect are implemented by the device, this call must ignore their values, i.e. this call must never return a reference sent using IPositionDirect::SetPosition

Parameters
reflast reference sent using PositionMove functions
Returns
true/false on success/failure

Implemented in yarp::dev::xHandControlBoard, ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, yarp::dev::ImplementPositionControl, and SerialServoBoard.

◆ getTargetPositions() [1/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::getTargetPositions ( const int  n_joint,
const int *  joints,
double *  refs 
)
pure virtual

Get the last position reference for the specified group of axes.

This is the dual of PositionMove and shall return only values sent using IPositionControl interface. If other interfaces like IPositionDirect are implemented by the device, this call must ignore their values, i.e. this call must never return a reference sent using IPositionDirect::SetPosition

Parameters
reflast reference sent using PositionMove functions
Returns
true/false on success/failure

Implemented in yarp::dev::xHandControlBoard, ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, yarp::dev::ImplementPositionControl, and SerialServoBoard.

◆ getTargetPositions() [2/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::getTargetPositions ( double *  refs)
pure virtual

Get the last position reference for all axes.

This is the dual of PositionMove and shall return only values sent using IPositionControl interface. If other interfaces like IPositionDirect are implemented by the device, this call must ignore their values, i.e. this call must never return a reference sent using IPositionDirect::SetPosition

Parameters
reflast reference sent using PositionMove functions
Returns
true/false on success/failure

Implemented in SerialServoBoard, yarp::dev::xHandControlBoard, ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, and yarp::dev::ImplementPositionControl.

◆ getTrajAcceleration()

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::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, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ getTrajAccelerations() [1/2]

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

Get reference acceleration for a joint.

Returns the acceleration used to generate the trajectory profile.

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

Implemented in DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, yarp::dev::ImplementPositionControl, and ControlBoardRemapper.

◆ getTrajAccelerations() [2/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::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, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ getTrajSpeed()

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::getTrajSpeed ( int  j,
double *  ref 
)
pure virtual

Get reference speed for a joint.

Returns the speed used to generate the trajectory profile.

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

Implemented in ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ getTrajSpeeds() [1/2]

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

Get reference speed of all joints.

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

Parameters
jointspointer to the array of joint numbers
spdspointer to the array that will store the speed values.
Returns
true/false upon success/failure

Implemented in DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, yarp::dev::ImplementPositionControl, and ControlBoardRemapper.

◆ getTrajSpeeds() [2/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::getTrajSpeeds ( double *  spds)
pure virtual

Get reference speed of all joints.

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

Parameters
spdspointer to the array that will store the speed values.

Implemented in ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ positionMove() [1/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::positionMove ( const double *  refs)
pure virtual

Set new reference point for all axes.

Parameters
refsarray, new reference points.
Returns
true/false on success/failure

Implemented in yarp::dev::xHandControlBoard, ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ positionMove() [2/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::positionMove ( const int  n_joint,
const int *  joints,
const double *  refs 
)
pure virtual

Set new reference point for a subset of joints.

Parameters
jointspointer to the array of joint numbers
refspointer to the array specifying the new reference points
Returns
true/false on success/failure

Implemented in DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, yarp::dev::ImplementPositionControl, yarp::dev::xHandControlBoard, and ControlBoardRemapper.

◆ positionMove() [3/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::positionMove ( int  j,
double  ref 
)
pure virtual

Set new reference point for a single axis.

Parameters
jjoint number
refspecifies the new ref point
Returns
true/false on success/failure

Implemented in yarp::dev::xHandControlBoard, ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ relativeMove() [1/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::relativeMove ( const double *  deltas)
pure virtual

Set relative position, all joints.

Parameters
deltaspointer to the relative commands
Returns
true/false on success/failure

Implemented in yarp::dev::xHandControlBoard, ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ relativeMove() [2/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::relativeMove ( const int  n_joint,
const int *  joints,
const double *  deltas 
)
pure virtual

Set relative position for a subset of joints.

Parameters
jointspointer to the array of joint numbers
deltaspointer to the array of relative commands
Returns
true/false on success/failure

Implemented in DynamixelAX12FtdiDriver, SerialServoBoard, yarp::dev::ImplementPositionControl, ControlBoard_nwc_yarp, yarp::dev::xHandControlBoard, and ControlBoardRemapper.

◆ relativeMove() [3/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::relativeMove ( int  j,
double  delta 
)
pure virtual

Set relative position.

The command is relative to the current position of the axis.

Parameters
jjoint axis number
deltarelative command
Returns
true/false on success/failure

Implemented in yarp::dev::xHandControlBoard, ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ setTrajAcceleration()

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::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, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ setTrajAccelerations() [1/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::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, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ setTrajAccelerations() [2/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::setTrajAccelerations ( const int  n_joint,
const int *  joints,
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
jointspointer to the array of joint numbers
accspointer to the array with acceleration values
Returns
true/false upon success/failure

Implemented in DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, yarp::dev::ImplementPositionControl, and ControlBoardRemapper.

◆ setTrajSpeed()

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::setTrajSpeed ( int  j,
double  sp 
)
pure virtual

Set reference speed for a joint, this is the speed used during the interpolation of the trajectory.

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

Implemented in ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ setTrajSpeeds() [1/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControl::setTrajSpeeds ( const double *  spds)
pure virtual

Set reference speed on all joints.

These values are used during the interpolation of the trajectory.

Parameters
spdspointer to the array of speed values.
Returns
true/false upon success/failure

Implemented in ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ setTrajSpeeds() [2/2]

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

Set reference speed on all joints.

These values are used during the interpolation of the trajectory.

Parameters
jointspointer to the array of joint numbers
spdspointer to the array with speed values.
Returns
true/false upon success/failure

Implemented in DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, yarp::dev::ImplementPositionControl, and ControlBoardRemapper.

◆ stop() [1/3]

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

Stop motion, multiple joints.

Returns
true/false on success/failure

Implemented in yarp::dev::xHandControlBoard, ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.

◆ stop() [2/3]

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

Stop motion for subset of joints.

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

Implemented in ControlBoard_nwc_yarp, DynamixelAX12FtdiDriver, SerialServoBoard, yarp::dev::ImplementPositionControl, yarp::dev::xHandControlBoard, and ControlBoardRemapper.

◆ stop() [3/3]

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

Stop motion, single joint.

Parameters
jjoint number
Returns
true/false on success/failure

Implemented in yarp::dev::xHandControlBoard, ControlBoardRemapper, DynamixelAX12FtdiDriver, ControlBoard_nwc_yarp, SerialServoBoard, and yarp::dev::ImplementPositionControl.


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