#include <ControlBoardWrapper/ControlBoardWrapperPositionControl.h>

Inheritance diagram for ControlBoardWrapperPositionControl:

Public Member Functions
bool	getAxes (int *ax) override
	Get the number of controlled axes. More...

bool	positionMove (int j, double ref) override
	Set new reference point for a single axis. More...

bool	positionMove (const double *refs) override
	Set new reference point for all axes. More...

bool	positionMove (const int n_joints, const int joints, const double refs) override
	Set new reference point for a subset of joints. More...

bool	getTargetPosition (const int joint, double *ref) override
	Get the last position reference for the specified axis. More...

bool	getTargetPositions (double *refs) override
	Get the last position reference for all axes. More...

bool	getTargetPositions (const int n_joint, const int joints, double refs) override
	Get the last position reference for the specified group of axes. More...

bool	relativeMove (int j, double delta) override
	Set relative position. More...

bool	relativeMove (const double *deltas) override
	Set relative position, all joints. More...

bool	relativeMove (const int n_joints, const int joints, const double deltas) override
	Set relative position for a subset of joints. More...

bool	checkMotionDone (int j, bool *flag) override
	Check if the current trajectory is terminated. More...

bool	checkMotionDone (bool *flag) override
	Check if the current trajectory is terminated. More...

bool	checkMotionDone (const int n_joints, const int joints, bool flags) override
	Check if the current trajectory is terminated. More...

bool	setRefSpeed (int j, double sp) override
	Set reference speed for a joint, this is the speed used during the interpolation of the trajectory. More...

bool	setRefSpeeds (const double *spds) override
	Set reference speed on all joints. More...

bool	setRefSpeeds (const int n_joints, const int joints, const double spds) override
	Set reference speed on all joints. More...

bool	setRefAcceleration (int j, double acc) override
	Set reference acceleration for a joint. More...

bool	setRefAccelerations (const double *accs) override
	Set reference acceleration on all joints. More...

bool	setRefAccelerations (const int n_joints, const int joints, const double accs) override
	Set reference acceleration on all joints. More...

bool	getRefSpeed (int j, double *ref) override
	Get reference speed for a joint. More...

bool	getRefSpeeds (double *spds) override
	Get reference speed of all joints. More...

bool	getRefSpeeds (const int n_joints, const int joints, double spds) override
	Get reference speed of all joints. More...

bool	getRefAcceleration (int j, double *acc) override
	Get reference acceleration for a joint. More...

bool	getRefAccelerations (double *accs) override
	Get reference acceleration of all joints. More...

bool	getRefAccelerations (const int n_joints, const int joints, double accs) override
	Get reference acceleration for a joint. More...

bool	stop (int j) override
	Stop motion, single joint. More...

bool	stop () override
	Stop motion, multiple joints. More...

bool	stop (const int n_joints, const int *joints) override
	Stop motion for subset of joints. More...

Public Member Functions inherited from ControlBoardWrapperCommon
bool	getAxes (int *ax)

bool	setRefAcceleration (int j, double acc)

bool	setRefAccelerations (const double *accs)

bool	setRefAccelerations (const int n_joints, const int joints, const double accs)

bool	getRefAcceleration (int j, double *acc)

bool	getRefAccelerations (double *accs)

bool	getRefAccelerations (const int n_joints, const int joints, double accs)

bool	stop (int j)

bool	stop ()

bool	stop (const int n_joint, const int *joints)

bool	getNumberOfMotors (int *num)

bool	getCurrent (int m, double *curr)

bool	getCurrents (double *currs)

void	printError (const std::string &func_name, const std::string &info, bool result)

Public Member Functions inherited from yarp::dev::IPositionControl
virtual	~IPositionControl ()
	Destructor. More...

virtual bool	getAxes (int *ax)=0
	Get the number of controlled axes. More...

virtual bool	positionMove (int j, double ref)=0
	Set new reference point for a single axis. More...

virtual bool	positionMove (const double *refs)=0
	Set new reference point for all axes. More...

virtual bool	relativeMove (int j, double delta)=0
	Set relative position. More...

virtual bool	relativeMove (const double *deltas)=0
	Set relative position, all joints. More...

virtual bool	checkMotionDone (int j, bool *flag)=0
	Check if the current trajectory is terminated. More...

virtual bool	checkMotionDone (bool *flag)=0
	Check if the current trajectory is terminated. More...

virtual bool	setRefSpeed (int j, double sp)=0
	Set reference speed for a joint, this is the speed used during the interpolation of the trajectory. More...

virtual bool	setRefSpeeds (const double *spds)=0
	Set reference speed on all joints. More...

virtual bool	setRefAcceleration (int j, double acc)=0
	Set reference acceleration for a joint. More...

virtual bool	setRefAccelerations (const double *accs)=0
	Set reference acceleration on all joints. More...

virtual bool	getRefSpeed (int j, double *ref)=0
	Get reference speed for a joint. More...

virtual bool	getRefSpeeds (double *spds)=0
	Get reference speed of all joints. More...

virtual bool	getRefAcceleration (int j, double *acc)=0
	Get reference acceleration for a joint. More...

virtual bool	getRefAccelerations (double *accs)=0
	Get reference acceleration of all joints. More...

virtual bool	stop (int j)=0
	Stop motion, single joint. More...

virtual bool	stop ()=0
	Stop motion, multiple joints. More...

virtual bool	positionMove (const int n_joint, const int joints, const double refs)=0
	Set new reference point for a subset of joints. More...

virtual bool	relativeMove (const int n_joint, const int joints, const double deltas)=0
	Set relative position for a subset of joints. More...

virtual bool	checkMotionDone (const int n_joint, const int joints, bool flag)=0
	Check if the current trajectory is terminated. More...

virtual bool	setRefSpeeds (const int n_joint, const int joints, const double spds)=0
	Set reference speed on all joints. More...

virtual bool	setRefAccelerations (const int n_joint, const int joints, const double accs)=0
	Set reference acceleration on all joints. More...

virtual bool	getRefSpeeds (const int n_joint, const int joints, double spds)=0
	Get reference speed of all joints. More...

virtual bool	getRefAccelerations (const int n_joint, const int joints, double accs)=0
	Get reference acceleration for a joint. More...

virtual bool	stop (const int n_joint, const int *joints)=0
	Stop motion for subset of joints. More...

virtual bool	getTargetPosition (const int joint, double *ref)
	Get the last position reference for the specified axis. More...

virtual bool	getTargetPositions (double *refs)
	Get the last position reference for all axes. More...

virtual bool	getTargetPositions (const int n_joint, const int joints, double refs)
	Get the last position reference for the specified group of axes. More...

Additional Inherited Members
Public Attributes inherited from ControlBoardWrapperCommon
WrappedDevice	device

size_t	controlledJoints {0}

std::string	partName

std::mutex	rpcDataMutex

MultiJointData	rpcData

std::mutex	timeMutex

yarp::os::Stamp	time

Detailed Description

Definition at line 14 of file ControlBoardWrapperPositionControl.h.

Member Function Documentation

◆ checkMotionDone() [1/3]

bool ControlBoardWrapperPositionControl::checkMotionDone ( bool * flag )

overridevirtual

Check if the current trajectory is terminated.

Non blocking.

Parameters

flag	is a pointer to return value ("and" of all joints)

Returns: true/false on network communication (value you actually want is stored in *flag)

Implements yarp::dev::IPositionControl.

Definition at line 304 of file ControlBoardWrapperPositionControl.cpp.

◆ checkMotionDone() [2/3]

bool ControlBoardWrapperPositionControl::checkMotionDone	(	const int	n_joint,
		const int *	joints,
		bool *	flag
	)

overridevirtual

Check if the current trajectory is terminated.

Non blocking.

Parameters

joints	pointer to the array of joint numbers
flag	pointer to return value (logical "and" of all set of joints)

Returns: true/false if network communication went well.

Implements yarp::dev::IPositionControl.

Definition at line 343 of file ControlBoardWrapperPositionControl.cpp.

◆ checkMotionDone() [3/3]

bool ControlBoardWrapperPositionControl::checkMotionDone	(	int	j,
		bool *	flag
	)

overridevirtual

Check if the current trajectory is terminated.

Non blocking.

Parameters

j	is the axis number
flag	is a pointer to return value

Returns: true/false on network communication (value you actually want is stored in *flag)

Implements yarp::dev::IPositionControl.

Definition at line 279 of file ControlBoardWrapperPositionControl.cpp.

◆ getAxes()

bool ControlBoardWrapperPositionControl::getAxes ( int * ax )

inlineoverridevirtual

Get the number of controlled axes.

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

Parameters

ax	pointer to storage

Returns: true/false.

Implements yarp::dev::IPositionControl.

Definition at line 19 of file ControlBoardWrapperPositionControl.h.

◆ getRefAcceleration()

bool ControlBoardWrapperPositionControl::getRefAcceleration	(	int	j,
		double *	acc
	)

inlineoverridevirtual

Get reference acceleration for a joint.

Returns the acceleration used to generate the trajectory profile.

Parameters

j	joint number
acc	pointer to storage for the return value

Returns: true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 44 of file ControlBoardWrapperPositionControl.h.

◆ getRefAccelerations() [1/2]

bool ControlBoardWrapperPositionControl::getRefAccelerations	(	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

joints	pointer to the array of joint numbers
accs	pointer to the array that will store the acceleration values

Returns: true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 46 of file ControlBoardWrapperPositionControl.h.

◆ getRefAccelerations() [2/2]

bool ControlBoardWrapperPositionControl::getRefAccelerations ( double * accs )

inlineoverridevirtual

Get reference acceleration of all joints.

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

Parameters

accs	pointer to the array that will store the acceleration values.

Returns: true/false on success or failure

Implements yarp::dev::IPositionControl.

Definition at line 45 of file ControlBoardWrapperPositionControl.h.

◆ getRefSpeed()

bool ControlBoardWrapperPositionControl::getRefSpeed	(	int	j,
		double *	ref
	)

overridevirtual

Get reference speed for a joint.

Returns the speed used to generate the trajectory profile.

Parameters

j	joint number
ref	pointer to storage for the return value

Returns: true/false on success or failure

Implements yarp::dev::IPositionControl.

Definition at line 470 of file ControlBoardWrapperPositionControl.cpp.

◆ getRefSpeeds() [1/2]

bool ControlBoardWrapperPositionControl::getRefSpeeds	(	const int	n_joint,
		const int *	joints,
		double *	spds
	)

overridevirtual

Get reference speed of all joints.

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

Parameters

joints	pointer to the array of joint numbers
spds	pointer to the array that will store the speed values.

Returns: true/false upon success/failure

Implements yarp::dev::IPositionControl.

Definition at line 522 of file ControlBoardWrapperPositionControl.cpp.

◆ getRefSpeeds() [2/2]

bool ControlBoardWrapperPositionControl::getRefSpeeds ( double * spds )

overridevirtual

Get reference speed of all joints.

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

Parameters

spds	pointer to the array that will store the speed values.

Implements yarp::dev::IPositionControl.

Definition at line 495 of file ControlBoardWrapperPositionControl.cpp.

◆ getTargetPosition()

bool ControlBoardWrapperPositionControl::getTargetPosition	(	const int	joint,
		double *	ref
	)

overridevirtual

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

ref	last reference sent using PositionMove functions

Returns: true/false on success/failure

Reimplemented from yarp::dev::IPositionControl.

Definition at line 104 of file ControlBoardWrapperPositionControl.cpp.

◆ getTargetPositions() [1/2]

bool ControlBoardWrapperPositionControl::getTargetPositions	(	const int	n_joint,
		const int *	joints,
		double *	refs
	)

overridevirtual

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

ref	last reference sent using PositionMove functions

Returns: true/false on success/failure

Reimplemented from yarp::dev::IPositionControl.

Definition at line 157 of file ControlBoardWrapperPositionControl.cpp.

◆ getTargetPositions() [2/2]

bool ControlBoardWrapperPositionControl::getTargetPositions ( double * refs )

overridevirtual

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

ref	last reference sent using PositionMove functions

Returns: true/false on success/failure

Reimplemented from yarp::dev::IPositionControl.

Definition at line 130 of file ControlBoardWrapperPositionControl.cpp.

◆ positionMove() [1/3]

bool ControlBoardWrapperPositionControl::positionMove ( const double * refs )

overridevirtual

Set new reference point for all axes.

Parameters

refs	array, new reference points.

Returns: true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 35 of file ControlBoardWrapperPositionControl.cpp.

◆ positionMove() [2/3]

bool ControlBoardWrapperPositionControl::positionMove	(	const int	n_joint,
		const int *	joints,
		const double *	refs
	)

overridevirtual

Set new reference point for a subset of joints.

Parameters

joints	pointer to the array of joint numbers
refs	pointer to the array specifying the new reference points

Returns: true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 74 of file ControlBoardWrapperPositionControl.cpp.

◆ positionMove() [3/3]

bool ControlBoardWrapperPositionControl::positionMove	(	int	j,
		double	ref
	)

overridevirtual

Set new reference point for a single axis.

Parameters

j	joint number
ref	specifies the new ref point

Returns: true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 11 of file ControlBoardWrapperPositionControl.cpp.

◆ relativeMove() [1/3]

bool ControlBoardWrapperPositionControl::relativeMove ( const double * deltas )

overridevirtual

Set relative position, all joints.

Parameters

deltas pointer to the relative commands

Returns: true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 226 of file ControlBoardWrapperPositionControl.cpp.

◆ relativeMove() [2/3]

bool ControlBoardWrapperPositionControl::relativeMove	(	const int	n_joint,
		const int *	joints,
		const double *	deltas
	)

overridevirtual

Set relative position for a subset of joints.

Parameters

joints	pointer to the array of joint numbers
deltas	pointer to the array of relative commands

Returns: true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 249 of file ControlBoardWrapperPositionControl.cpp.

◆ relativeMove() [3/3]

bool ControlBoardWrapperPositionControl::relativeMove	(	int	j,
		double	delta
	)

overridevirtual

Set relative position.

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

Parameters

j	joint axis number
delta	relative command

Returns: true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 202 of file ControlBoardWrapperPositionControl.cpp.

◆ setRefAcceleration()

bool ControlBoardWrapperPositionControl::setRefAcceleration	(	int	j,
		double	acc
	)

inlineoverridevirtual

Set reference acceleration for a joint.

This value is used during the trajectory generation.

Parameters

j	joint number
acc	acceleration value

Returns: true/false upon success/failure

Implements yarp::dev::IPositionControl.

Definition at line 38 of file ControlBoardWrapperPositionControl.h.

◆ setRefAccelerations() [1/2]

bool ControlBoardWrapperPositionControl::setRefAccelerations ( const double * accs )

inlineoverridevirtual

Set reference acceleration on all joints.

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

Parameters

accs	pointer to the array of acceleration values

Returns: true/false upon success/failure

Implements yarp::dev::IPositionControl.

Definition at line 39 of file ControlBoardWrapperPositionControl.h.

◆ setRefAccelerations() [2/2]

bool ControlBoardWrapperPositionControl::setRefAccelerations	(	const int	n_joint,
		const int *	joints,
		const double *	accs
	)

inlineoverridevirtual

Set reference acceleration on all joints.

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

Parameters

joints	pointer to the array of joint numbers
accs	pointer to the array with acceleration values

Returns: true/false upon success/failure

Implements yarp::dev::IPositionControl.

Definition at line 40 of file ControlBoardWrapperPositionControl.h.

◆ setRefSpeed()

bool ControlBoardWrapperPositionControl::setRefSpeed	(	int	j,
		double	sp
	)

overridevirtual

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

Parameters

j	joint number
sp	speed value

Returns: true/false upon success/failure

Implements yarp::dev::IPositionControl.

Definition at line 380 of file ControlBoardWrapperPositionControl.cpp.

◆ setRefSpeeds() [1/2]

bool ControlBoardWrapperPositionControl::setRefSpeeds ( const double * spds )

overridevirtual

Set reference speed on all joints.

These values are used during the interpolation of the trajectory.

Parameters

spds	pointer to the array of speed values.

Returns: true/false upon success/failure

Implements yarp::dev::IPositionControl.

Definition at line 403 of file ControlBoardWrapperPositionControl.cpp.

◆ setRefSpeeds() [2/2]

bool ControlBoardWrapperPositionControl::setRefSpeeds	(	const int	n_joint,
		const int *	joints,
		const double *	spds
	)

overridevirtual

Set reference speed on all joints.

These values are used during the interpolation of the trajectory.

Parameters

joints	pointer to the array of joint numbers
spds	pointer to the array with speed values.

Returns: true/false upon success/failure

Implements yarp::dev::IPositionControl.

Definition at line 440 of file ControlBoardWrapperPositionControl.cpp.

◆ stop() [1/3]

bool ControlBoardWrapperPositionControl::stop ( )

inlineoverridevirtual

Stop motion, multiple joints.

Returns: true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 48 of file ControlBoardWrapperPositionControl.h.

◆ stop() [2/3]

bool ControlBoardWrapperPositionControl::stop	(	const int	n_joint,
		const int *	joints
	)

inlineoverridevirtual

Stop motion for subset of joints.

Parameters

joints pointer to the array of joint numbers

Returns: true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 49 of file ControlBoardWrapperPositionControl.h.

◆ stop() [3/3]

bool ControlBoardWrapperPositionControl::stop ( int j )

inlineoverridevirtual

Stop motion, single joint.

Parameters

j	joint number

Returns: true/false on success/failure

Implements yarp::dev::IPositionControl.

Definition at line 47 of file ControlBoardWrapperPositionControl.h.

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

src/devices/ControlBoardWrapper/ControlBoardWrapperPositionControl.h
src/devices/ControlBoardWrapper/ControlBoardWrapperPositionControl.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkMotionDone() [1/3]

◆ checkMotionDone() [2/3]

◆ checkMotionDone() [3/3]

◆ getAxes()

◆ getRefAcceleration()

◆ getRefAccelerations() [1/2]

◆ getRefAccelerations() [2/2]

◆ getRefSpeed()

◆ getRefSpeeds() [1/2]

◆ getRefSpeeds() [2/2]

◆ getTargetPosition()

◆ getTargetPositions() [1/2]

◆ getTargetPositions() [2/2]

◆ positionMove() [1/3]

◆ positionMove() [2/3]

◆ positionMove() [3/3]

◆ relativeMove() [1/3]

◆ relativeMove() [2/3]

◆ relativeMove() [3/3]

◆ setRefAcceleration()

◆ setRefAccelerations() [1/2]

◆ setRefAccelerations() [2/2]

◆ setRefSpeed()

◆ setRefSpeeds() [1/2]

◆ setRefSpeeds() [2/2]

◆ stop() [1/3]

◆ stop() [2/3]

◆ stop() [3/3]