#include <yarp/dev/ImplementEncodersTimed.h>

Inheritance diagram for yarp::dev::ImplementEncodersTimed:

Public Member Functions
	ImplementEncodersTimed (yarp::dev::IEncodersTimedRaw *y)

virtual	~ImplementEncodersTimed ()

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

bool	resetEncoder (int j) override
	Reset encoder, single joint. More...

bool	resetEncoders () override
	Reset encoders. More...

bool	setEncoder (int j, double val) override
	Set the value of the encoder for a given joint. More...

bool	setEncoders (const double *vals) override
	Set the value of all encoders. More...

bool	getEncoder (int j, double *v) override
	Read the value of an encoder. More...

bool	getEncodersTimed (double encs, double time) override
	Read the instantaneous acceleration of all axes. More...

bool	getEncoderTimed (int j, double v, double t) override
	Read the instantaneous acceleration of all axes. More...

bool	getEncoders (double *encs) override
	Read the position of all axes. More...

bool	getEncoderSpeed (int j, double *spds) override
	Read the istantaneous speed of an axis. More...

bool	getEncoderSpeeds (double *spds) override
	Read the instantaneous speed of all axes. More...

bool	getEncoderAcceleration (int j, double *spds) override
	Read the instantaneous acceleration of an axis. More...

bool	getEncoderAccelerations (double *accs) override
	Read the instantaneous acceleration of all axes. More...

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

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

Protected Member Functions
bool	initialize (int size, const int amap, const double enc, const double *zos)
	Initialize the internal data and alloc memory. More...

bool	uninitialize ()
	Clean up internal data and memory. More...

Protected Attributes
IEncodersTimedRaw *	iEncoders

void *	helper

yarp::dev::impl::FixedSizeBuffersManager< double > *	buffManager

Detailed Description

Definition at line 31 of file ImplementEncodersTimed.h.

Constructor & Destructor Documentation

◆ ImplementEncodersTimed()

ImplementEncodersTimed::ImplementEncodersTimed ( yarp::dev::IEncodersTimedRaw * y )

Definition at line 20 of file ImplementEncodersTimed.cpp.

◆ ~ImplementEncodersTimed()

ImplementEncodersTimed::~ImplementEncodersTimed ( )

virtual

Definition at line 26 of file ImplementEncodersTimed.cpp.

Member Function Documentation

◆ getAxes()

bool ImplementEncodersTimed::getAxes ( int * ax )

overridevirtual

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.

Implements yarp::dev::IEncoders.

Reimplemented in FakeMotionControl.

Definition at line 64 of file ImplementEncodersTimed.cpp.

◆ getEncoder()

bool ImplementEncodersTimed::getEncoder	(	int	j,
		double *	v
	)

overridevirtual

Read the value of an encoder.

Parameters

j	encoder number
v	pointer to storage for the return value

Returns: true/false, upon success/failure (you knew it, uh?)

Implements yarp::dev::IEncoders.

Definition at line 104 of file ImplementEncodersTimed.cpp.

◆ getEncoderAcceleration()

bool ImplementEncodersTimed::getEncoderAcceleration	(	int	j,
		double *	spds
	)

overridevirtual

Read the instantaneous acceleration of an axis.

Parameters

j	axis number
spds	pointer to the array that will contain the output

Implements yarp::dev::IEncoders.

Definition at line 154 of file ImplementEncodersTimed.cpp.

◆ getEncoderAccelerations()

bool ImplementEncodersTimed::getEncoderAccelerations ( double * accs )

overridevirtual

Read the instantaneous acceleration of all axes.

Parameters

accs	pointer to the array that will contain the output

Returns: true if all goes well, false if anything bad happens.

Implements yarp::dev::IEncoders.

Definition at line 170 of file ImplementEncodersTimed.cpp.

◆ getEncoders()

bool ImplementEncodersTimed::getEncoders ( double * encs )

overridevirtual

Read the position of all axes.

Parameters

encs	pointer to the array that will contain the output

Returns: true/false on success/failure

Implements yarp::dev::IEncoders.

Definition at line 120 of file ImplementEncodersTimed.cpp.

◆ getEncoderSpeed()

bool ImplementEncodersTimed::getEncoderSpeed	(	int	j,
		double *	sp
	)

overridevirtual

Read the istantaneous speed of an axis.

Parameters

j	axis number
sp	pointer to storage for the output

Returns: true if successful, false ... otherwise.

Implements yarp::dev::IEncoders.

Definition at line 129 of file ImplementEncodersTimed.cpp.

◆ getEncoderSpeeds()

bool ImplementEncodersTimed::getEncoderSpeeds ( double * spds )

overridevirtual

Read the instantaneous speed of all axes.

Parameters

spds	pointer to storage for the output values

Returns: guess what? (true/false on success or failure).

Implements yarp::dev::IEncoders.

Definition at line 145 of file ImplementEncodersTimed.cpp.

◆ getEncodersTimed()

bool ImplementEncodersTimed::getEncodersTimed	(	double *	encs,
		double *	time
	)

overridevirtual

Read the instantaneous acceleration of all axes.

Parameters

encs	pointer to the array that will contain the output
time	pointer to the array that will contain individual timestamps

Returns: true if all goes well, false if anything bad happens.

Implements yarp::dev::IEncodersTimed.

Definition at line 196 of file ImplementEncodersTimed.cpp.

◆ getEncoderTimed()

bool ImplementEncodersTimed::getEncoderTimed	(	int	j,
		double *	encs,
		double *	time
	)

overridevirtual

Read the instantaneous acceleration of all axes.

Parameters

j	axis index
encs	encoder value (pointer to)
time	corresponding timestamp (pointer to)

Returns: true if all goes well, false if anything bad happens.

Implements yarp::dev::IEncodersTimed.

Definition at line 179 of file ImplementEncodersTimed.cpp.

◆ initialize()

bool ImplementEncodersTimed::initialize	(	int	size,
		const int *	amap,
		const double *	enc,
		const double *	zos
	)

protected

Initialize the internal data and alloc memory.

Parameters

size	is the number of controlled axes the driver deals with.
amap	is a lookup table mapping axes onto physical drivers.
enc	is an array containing the encoder to angles conversion factors.
zos	is an array containing the zeros of the encoders.

Returns: true if initialized succeeded, false if it wasn't executed, or assert.

Definition at line 31 of file ImplementEncodersTimed.cpp.

◆ resetEncoder()

bool ImplementEncodersTimed::resetEncoder ( int j )

overridevirtual

Reset encoder, single joint.

Set the encoder value to zero

Parameters

j	encoder number

Returns: true/false

Implements yarp::dev::IEncoders.

Definition at line 70 of file ImplementEncodersTimed.cpp.

◆ resetEncoders()

bool ImplementEncodersTimed::resetEncoders ( )

overridevirtual

Reset encoders.

Set the encoders value to zero

Returns: true/false

Implements yarp::dev::IEncoders.

Definition at line 79 of file ImplementEncodersTimed.cpp.

◆ setEncoder()

bool ImplementEncodersTimed::setEncoder	(	int	j,
		double	val
	)

overridevirtual

Set the value of the encoder for a given joint.

Parameters

j	encoder number
val	new value

Returns: true/false

Implements yarp::dev::IEncoders.

Definition at line 84 of file ImplementEncodersTimed.cpp.

◆ setEncoders()

bool ImplementEncodersTimed::setEncoders ( const double * vals )

overridevirtual

Set the value of all encoders.

Parameters

vals	pointer to the new values

Returns: true/false

Implements yarp::dev::IEncoders.

Definition at line 95 of file ImplementEncodersTimed.cpp.

◆ uninitialize()

bool ImplementEncodersTimed::uninitialize ( )

protected

Clean up internal data and memory.

Returns: true if uninitialization is executed, false otherwise.

Definition at line 48 of file ImplementEncodersTimed.cpp.

Member Data Documentation

◆ buffManager

yarp::dev::impl::FixedSizeBuffersManager<double>* yarp::dev::ImplementEncodersTimed::buffManager

protected

Definition at line 36 of file ImplementEncodersTimed.h.

◆ helper

void* yarp::dev::ImplementEncodersTimed::helper

protected

Definition at line 35 of file ImplementEncodersTimed.h.

◆ iEncoders

IEncodersTimedRaw* yarp::dev::ImplementEncodersTimed::iEncoders

protected

Definition at line 34 of file ImplementEncodersTimed.h.

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

src/libYARP_dev/src/yarp/dev/ImplementEncodersTimed.h
src/libYARP_dev/src/yarp/dev/ImplementEncodersTimed.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ImplementEncodersTimed()

◆ ~ImplementEncodersTimed()

Member Function Documentation

◆ getAxes()

◆ getEncoder()

◆ getEncoderAcceleration()

◆ getEncoderAccelerations()

◆ getEncoders()

◆ getEncoderSpeed()

◆ getEncoderSpeeds()

◆ getEncodersTimed()

◆ getEncoderTimed()

◆ initialize()

◆ resetEncoder()

◆ resetEncoders()

◆ setEncoder()

◆ setEncoders()

◆ uninitialize()

Member Data Documentation

◆ buffManager

◆ helper

◆ iEncoders