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

Stub implementation of IPositionControlRaw interface. More...

#include <yarp/dev/ImplementPositionControl.h>

+ Inheritance diagram for yarp::dev::StubImplPositionControlRaw:

Public Member Functions

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

Detailed Description

Stub implementation of IPositionControlRaw 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 119 of file ImplementPositionControl.h.

Constructor & Destructor Documentation

◆ ~StubImplPositionControlRaw()

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

Definition at line 129 of file ImplementPositionControl.h.

Member Function Documentation

◆ checkMotionDoneRaw() [1/3]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::checkMotionDoneRaw ( bool &  flag)
inlineoverridevirtual

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)

Implements yarp::dev::IPositionControlRaw.

Definition at line 158 of file ImplementPositionControl.h.

◆ checkMotionDoneRaw() [2/3]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::checkMotionDoneRaw ( const std::vector< int > &  joints,
bool &  flag 
)
inlineoverridevirtual

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.

Implements yarp::dev::IPositionControlRaw.

Definition at line 155 of file ImplementPositionControl.h.

◆ checkMotionDoneRaw() [3/3]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::checkMotionDoneRaw ( int  j,
bool &  flag 
)
inlineoverridevirtual

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)

Implements yarp::dev::IPositionControlRaw.

Definition at line 152 of file ImplementPositionControl.h.

◆ getAxes()

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::getAxes ( size_t &  ax)
inlineoverridevirtual

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.

Implements yarp::dev::IPositionControlRaw.

Definition at line 131 of file ImplementPositionControl.h.

◆ getTargetPositionRaw()

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::getTargetPositionRaw ( const int  joint,
double *  ref 
)
inlineoverridevirtual

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 206 of file ImplementPositionControl.h.

◆ getTargetPositionsRaw() [1/2]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::getTargetPositionsRaw ( const int  n_joint,
const int *  joints,
double *  refs 
)
inlineoverridevirtual

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 212 of file ImplementPositionControl.h.

◆ getTargetPositionsRaw() [2/2]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::getTargetPositionsRaw ( double *  refs)
inlineoverridevirtual

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 209 of file ImplementPositionControl.h.

◆ getTrajAccelerationRaw()

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::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::IPositionControlRaw.

Definition at line 188 of file ImplementPositionControl.h.

◆ getTrajAccelerationsRaw() [1/2]

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

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 191 of file ImplementPositionControl.h.

◆ getTrajAccelerationsRaw() [2/2]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::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::IPositionControlRaw.

Definition at line 194 of file ImplementPositionControl.h.

◆ getTrajSpeedRaw()

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::getTrajSpeedRaw ( int  j,
double *  ref 
)
inlineoverridevirtual

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 179 of file ImplementPositionControl.h.

◆ getTrajSpeedsRaw() [1/2]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::getTrajSpeedsRaw ( const int  n_joint,
const int *  joints,
double *  spds 
)
inlineoverridevirtual

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 182 of file ImplementPositionControl.h.

◆ getTrajSpeedsRaw() [2/2]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::getTrajSpeedsRaw ( double *  spds)
inlineoverridevirtual

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.

Implements yarp::dev::IPositionControlRaw.

Definition at line 185 of file ImplementPositionControl.h.

◆ positionMoveRaw() [1/3]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::positionMoveRaw ( const double *  refs)
inlineoverridevirtual

Set new reference point for all axes.

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 140 of file ImplementPositionControl.h.

◆ positionMoveRaw() [2/3]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::positionMoveRaw ( const int  n_joint,
const int *  joints,
const double *  refs 
)
inlineoverridevirtual

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 137 of file ImplementPositionControl.h.

◆ positionMoveRaw() [3/3]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::positionMoveRaw ( int  j,
double  ref 
)
inlineoverridevirtual

Set new reference point for a single axis.

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 134 of file ImplementPositionControl.h.

◆ relativeMoveRaw() [1/3]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::relativeMoveRaw ( const double *  deltas)
inlineoverridevirtual

Set relative position, all joints.

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 149 of file ImplementPositionControl.h.

◆ relativeMoveRaw() [2/3]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::relativeMoveRaw ( const int  n_joint,
const int *  joints,
const double *  deltas 
)
inlineoverridevirtual

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 146 of file ImplementPositionControl.h.

◆ relativeMoveRaw() [3/3]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::relativeMoveRaw ( int  j,
double  delta 
)
inlineoverridevirtual

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 143 of file ImplementPositionControl.h.

◆ setTrajAccelerationRaw()

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::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::IPositionControlRaw.

Definition at line 170 of file ImplementPositionControl.h.

◆ setTrajAccelerationsRaw() [1/2]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::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::IPositionControlRaw.

Definition at line 176 of file ImplementPositionControl.h.

◆ setTrajAccelerationsRaw() [2/2]

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

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 173 of file ImplementPositionControl.h.

◆ setTrajSpeedRaw()

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::setTrajSpeedRaw ( int  j,
double  sp 
)
inlineoverridevirtual

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 161 of file ImplementPositionControl.h.

◆ setTrajSpeedsRaw() [1/2]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::setTrajSpeedsRaw ( const double *  spds)
inlineoverridevirtual

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 167 of file ImplementPositionControl.h.

◆ setTrajSpeedsRaw() [2/2]

yarp::dev::ReturnValue yarp::dev::StubImplPositionControlRaw::setTrajSpeedsRaw ( const int  n_joint,
const int *  joints,
const double *  spds 
)
inlineoverridevirtual

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 164 of file ImplementPositionControl.h.

◆ stopRaw() [1/3]

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

Stop motion, multiple joints.

Returns
true/false on success/failure

Implements yarp::dev::IPositionControlRaw.

Definition at line 203 of file ImplementPositionControl.h.

◆ stopRaw() [2/3]

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

Stop motion for subset of joints.

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

Implements yarp::dev::IPositionControlRaw.

Definition at line 200 of file ImplementPositionControl.h.

◆ stopRaw() [3/3]

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

Stop motion, single joint.

Parameters
jjoint number
Returns
true/false on success/failure

Implements yarp::dev::IPositionControlRaw.

Definition at line 197 of file ImplementPositionControl.h.


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