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

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

#include <yarp/dev/IPositionDirect.h>

+ Inheritance diagram for yarp::dev::IPositionDirect:

Public Member Functions

virtual ~IPositionDirect ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAxes (size_t &ax)=0
 Get the number of controlled axes.
 
virtual yarp::dev::ReturnValue setPosition (int j, double ref)=0
 Set new position for a single axis.
 
virtual yarp::dev::ReturnValue setPositions (const int n_joint, const int *joints, const double *refs)=0
 Set new reference point for all axes.
 
virtual yarp::dev::ReturnValue setPositions (const double *refs)=0
 Set new position for a set of axis.
 
virtual yarp::dev::ReturnValue getRefPosition (const int joint, double *ref)=0
 Get the last position reference for the specified axis.
 
virtual yarp::dev::ReturnValue getRefPositions (double *refs)=0
 Get the last position reference for all axes.
 
virtual yarp::dev::ReturnValue getRefPositions (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.

This interface is used to send high frequency streaming commands to the boards, the aim is to reach low level control in firmware bypassing the trajectory generator.

Definition at line 27 of file IPositionDirect.h.

Constructor & Destructor Documentation

◆ ~IPositionDirect()

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

Destructor.

Definition at line 34 of file IPositionDirect.h.

Member Function Documentation

◆ getAxes()

virtual yarp::dev::ReturnValue yarp::dev::IPositionDirect::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.

Returns
the number of controlled axes.

Implemented in ControlBoardRemapper, FakeMotionControl, ControlBoard_nwc_yarp, yarp::dev::ImplementPositionDirect, and yarp::dev::StubImplPositionDirectRaw.

◆ getRefPosition()

virtual yarp::dev::ReturnValue yarp::dev::IPositionDirect::getRefPosition ( const int  joint,
double *  ref 
)
pure virtual

Get the last position reference for the specified axis.

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

Parameters
reflast reference sent using setPosition(s) functions
Returns
true/false on success/failure

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

◆ getRefPositions() [1/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionDirect::getRefPositions ( 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 setPositionsRaw and shall return only values sent using IPositionDirect interface. If other interfaces like IPositionControl are implemented by the device, this call must ignore their values, i.e. this call must never return a reference sent using IPositionControl::PositionMove.

Parameters
refarray containing last reference sent using setPosition(s) functions
Returns
true/false on success/failure

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

◆ getRefPositions() [2/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionDirect::getRefPositions ( double *  refs)
pure virtual

Get the last position reference for all axes.

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

Parameters
refarray containing last reference sent using setPosition(s) functions
Returns
true/false on success/failure

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

◆ setPosition()

virtual yarp::dev::ReturnValue yarp::dev::IPositionDirect::setPosition ( int  j,
double  ref 
)
pure virtual

Set new position for a single axis.

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

Implemented in yarp::dev::xHandControlBoard, ControlBoardRemapper, ControlBoard_nwc_yarp, yarp::dev::ImplementPositionDirect, and yarp::dev::StubImplPositionDirectRaw.

◆ setPositions() [1/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionDirect::setPositions ( const double *  refs)
pure virtual

Set new position for a set of axis.

Parameters
refsspecifies the new reference points
Returns
true/false on success/failure

Implemented in yarp::dev::xHandControlBoard, ControlBoardRemapper, ControlBoard_nwc_yarp, yarp::dev::ImplementPositionDirect, and yarp::dev::StubImplPositionDirectRaw.

◆ setPositions() [2/2]

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

Set new reference point for all axes.

Parameters
n_jointhow many joints this command is referring to
jointslist of joints controlled. The size of this array is n_joints
refsarray, new reference points, one value for each joint, the size 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 refs 10 30 40
Returns
true/false on success/failure

Implemented in ControlBoard_nwc_yarp, yarp::dev::ImplementPositionDirect, yarp::dev::StubImplPositionDirectRaw, yarp::dev::xHandControlBoard, and ControlBoardRemapper.


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