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

Interface for a generic control board device implementing position control in encoder coordinates. More...

#include <yarp/dev/IPositionControl.h>

+ Inheritance diagram for yarp::dev::IPositionControlRaw:

Public Member Functions

virtual ~IPositionControlRaw ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAxes (size_t &ax)=0
 Get the number of controlled axes.
 
virtual yarp::dev::ReturnValue positionMoveRaw (int j, double ref)=0
 Set new reference point for a single axis.
 
virtual yarp::dev::ReturnValue positionMoveRaw (const double *refs)=0
 Set new reference point for all axes.
 
virtual yarp::dev::ReturnValue relativeMoveRaw (int j, double delta)=0
 Set relative position.
 
virtual yarp::dev::ReturnValue relativeMoveRaw (const double *deltas)=0
 Set relative position, all joints.
 
virtual yarp::dev::ReturnValue checkMotionDoneRaw (int j, bool &flag)=0
 Check if the current trajectory is terminated.
 
virtual yarp::dev::ReturnValue checkMotionDoneRaw (bool &flag)=0
 Check if the current trajectory all joints is terminated.
 
virtual yarp::dev::ReturnValue setTrajSpeedRaw (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 setTrajSpeedsRaw (const double *spds)=0
 Set reference speed on all joints.
 
virtual yarp::dev::ReturnValue setTrajAccelerationRaw (int j, double acc)=0
 Set reference acceleration for a joint.
 
virtual yarp::dev::ReturnValue setTrajAccelerationsRaw (const double *accs)=0
 Set reference acceleration on all joints.
 
virtual yarp::dev::ReturnValue getTrajSpeedRaw (int j, double *ref)=0
 Get reference speed for a joint.
 
virtual yarp::dev::ReturnValue getTrajSpeedsRaw (double *spds)=0
 Get reference speed of all joints.
 
virtual yarp::dev::ReturnValue getTrajAccelerationRaw (int j, double *acc)=0
 Get reference acceleration for a joint.
 
virtual yarp::dev::ReturnValue getTrajAccelerationsRaw (double *accs)=0
 Get reference acceleration of all joints.
 
virtual yarp::dev::ReturnValue stopRaw (int j)=0
 Stop motion, single joint.
 
virtual yarp::dev::ReturnValue stopRaw ()=0
 Stop motion, multiple joints.
 
virtual yarp::dev::ReturnValue positionMoveRaw (const int n_joint, const int *joints, const double *refs)=0
 Set new reference point for a subset of joints.
 
virtual yarp::dev::ReturnValue relativeMoveRaw (const int n_joint, const int *joints, const double *deltas)=0
 Set relative position for a subset of joints.
 
virtual yarp::dev::ReturnValue checkMotionDoneRaw (const std::vector< int > &joints, bool &flag)=0
 Check if the current trajectory is terminated.
 
virtual yarp::dev::ReturnValue setTrajSpeedsRaw (const int n_joint, const int *joints, const double *spds)=0
 Set reference speed on all joints.
 
virtual yarp::dev::ReturnValue setTrajAccelerationsRaw (const int n_joint, const int *joints, const double *accs)=0
 Set reference acceleration on all joints.
 
virtual yarp::dev::ReturnValue getTrajSpeedsRaw (const int n_joint, const int *joints, double *spds)=0
 Get reference speed of all joints.
 
virtual yarp::dev::ReturnValue getTrajAccelerationsRaw (const int n_joint, const int *joints, double *accs)=0
 Get reference acceleration for a joint.
 
virtual yarp::dev::ReturnValue stopRaw (const int n_joint, const int *joints)=0
 Stop motion for subset of joints.
 
virtual yarp::dev::ReturnValue getTargetPositionRaw (const int joint, double *ref)=0
 Get the last position reference for the specified axis.
 
virtual yarp::dev::ReturnValue getTargetPositionsRaw (double *refs)=0
 Get the last position reference for all axes.
 
virtual yarp::dev::ReturnValue getTargetPositionsRaw (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 in encoder coordinates.

Definition at line 27 of file IPositionControl.h.

Constructor & Destructor Documentation

◆ ~IPositionControlRaw()

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

Destructor.

Definition at line 33 of file IPositionControl.h.

Member Function Documentation

◆ checkMotionDoneRaw() [1/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::checkMotionDoneRaw ( bool &  flag)
pure virtual

Check if the current trajectory all joints is terminated.

Non blocking.

Parameters
flagthe return value ("and" of all joints)
Returns
true/false on network communication (the value you actually want is stored in flag)

Implemented in FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ checkMotionDoneRaw() [2/3]

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

Check if the current trajectory is terminated.

Non blocking.

Parameters
jointsthe array of joint numbers
flagtrue if the trajectory is terminated, false otherwise (a single value which is the 'and' of all joints')
Returns
true/false if network communication went well.

Implemented in FakeMotionControl, yarp::dev::StubImplPositionControlRaw, and FakeLaserWithMotor.

◆ checkMotionDoneRaw() [3/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::checkMotionDoneRaw ( 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 (the value you actually want is stored in flag)

Implemented in FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ getAxes()

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::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
axstorage to return param
Returns
true/false.

Implemented in FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ getTargetPositionRaw()

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::getTargetPositionRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ getTargetPositionsRaw() [1/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::getTargetPositionsRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ getTargetPositionsRaw() [2/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::getTargetPositionsRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ getTrajAccelerationRaw()

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::getTrajAccelerationRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ getTrajAccelerationsRaw() [1/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::getTrajAccelerationsRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ getTrajAccelerationsRaw() [2/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::getTrajAccelerationsRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ getTrajSpeedRaw()

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::getTrajSpeedRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ getTrajSpeedsRaw() [1/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::getTrajSpeedsRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ getTrajSpeedsRaw() [2/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::getTrajSpeedsRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ positionMoveRaw() [1/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::positionMoveRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ positionMoveRaw() [2/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::positionMoveRaw ( 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 specifies the new reference points
Returns
true/false on success/failure

Implemented in FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ positionMoveRaw() [3/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::positionMoveRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ relativeMoveRaw() [1/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::relativeMoveRaw ( const double *  deltas)
pure virtual

Set relative position, all joints.

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

Implemented in FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ relativeMoveRaw() [2/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::relativeMoveRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ relativeMoveRaw() [3/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::relativeMoveRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ setTrajAccelerationRaw()

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::setTrajAccelerationRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ setTrajAccelerationsRaw() [1/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::setTrajAccelerationsRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ setTrajAccelerationsRaw() [2/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::setTrajAccelerationsRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ setTrajSpeedRaw()

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::setTrajSpeedRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ setTrajSpeedsRaw() [1/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::setTrajSpeedsRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ setTrajSpeedsRaw() [2/2]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::setTrajSpeedsRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ stopRaw() [1/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::stopRaw ( )
pure virtual

Stop motion, multiple joints.

Returns
true/false on success/failure

Implemented in FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ stopRaw() [2/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::stopRaw ( 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 FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.

◆ stopRaw() [3/3]

virtual yarp::dev::ReturnValue yarp::dev::IPositionControlRaw::stopRaw ( int  j)
pure virtual

Stop motion, single joint.

Parameters
jjoint number
Returns
true/false on success/failure

Implemented in FakeLaserWithMotor, FakeMotionControl, and yarp::dev::StubImplPositionControlRaw.


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