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

#include <yarp/dev/ImplementEncoders.h>

+ Inheritance diagram for yarp::dev::ImplementEncoders:

Public Member Functions

 ImplementEncoders (yarp::dev::IEncodersRaw *y)
 
virtual ~ImplementEncoders ()
 Destructor.
 
yarp::dev::ReturnValue getAxes (size_t &ax) override
 Get the number of controlled axes.
 
yarp::dev::ReturnValue resetEncoder (int j) override
 Reset encoder, single joint.
 
yarp::dev::ReturnValue resetEncoders () override
 Reset encoders.
 
yarp::dev::ReturnValue setEncoder (int j, double val) override
 Set the value of the encoder for a given joint.
 
yarp::dev::ReturnValue setEncoders (const double *vals) override
 Set the value of all encoders.
 
yarp::dev::ReturnValue getEncoder (int j, double *v) override
 Read the value of an encoder.
 
yarp::dev::ReturnValue getEncoders (double *encs) override
 Read the position of all axes.
 
yarp::dev::ReturnValue getEncoderSpeed (int j, double *spds) override
 Read the instantaneous speed of an axis.
 
yarp::dev::ReturnValue getEncoderSpeeds (double *spds) override
 Read the instantaneous speed of all axes.
 
yarp::dev::ReturnValue getEncoderAcceleration (int j, double *spds) override
 Read the instantaneous acceleration of an axis.
 
yarp::dev::ReturnValue getEncoderAccelerations (double *accs) override
 Read the instantaneous acceleration of all axes.
 
- Public Member Functions inherited from yarp::dev::IEncoders
virtual ~IEncoders ()
 Destructor.
 

Protected Member Functions

bool initialize (int size, const int *amap, const double *enc, const double *zos)
 Initialize the internal data and alloc memory.
 
bool uninitialize ()
 Clean up internal data and memory.
 

Protected Attributes

IEncodersRaw * m_iraw =nullptr
 
void * m_helper =nullptr
 
std::vector< int > m_buffer_ints
 
std::vector< double > m_buffer_doubles
 
std::mutex m_imp_mutex
 

Detailed Description

Definition at line 16 of file ImplementEncoders.h.

Constructor & Destructor Documentation

◆ ImplementEncoders()

ImplementEncoders::ImplementEncoders ( yarp::dev::IEncodersRaw *  y)

Definition at line 25 of file ImplementEncoders.cpp.

◆ ~ImplementEncoders()

ImplementEncoders::~ImplementEncoders ( )
virtual

Destructor.

Perform uninitialize if needed.

Definition at line 31 of file ImplementEncoders.cpp.

Member Function Documentation

◆ getAxes()

ReturnValue ImplementEncoders::getAxes ( size_t &  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.

Definition at line 66 of file ImplementEncoders.cpp.

◆ getEncoder()

ReturnValue ImplementEncoders::getEncoder ( int  j,
double *  v 
)
overridevirtual

Read the value of an encoder.

Parameters
jencoder number
vpointer to storage for the return value
Returns
true/false, upon success/failure (you knew it, uh?)

Implements yarp::dev::IEncoders.

Definition at line 115 of file ImplementEncoders.cpp.

◆ getEncoderAcceleration()

ReturnValue ImplementEncoders::getEncoderAcceleration ( int  j,
double *  spds 
)
overridevirtual

Read the instantaneous acceleration of an axis.

Parameters
jaxis number
spdspointer to the array that will contain the output

Implements yarp::dev::IEncoders.

Definition at line 181 of file ImplementEncoders.cpp.

◆ getEncoderAccelerations()

ReturnValue ImplementEncoders::getEncoderAccelerations ( double *  accs)
overridevirtual

Read the instantaneous acceleration of all axes.

Parameters
accspointer 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 200 of file ImplementEncoders.cpp.

◆ getEncoders()

ReturnValue ImplementEncoders::getEncoders ( double *  encs)
overridevirtual

Read the position of all axes.

Parameters
encspointer to the array that will contain the output
Returns
true/false on success/failure

Implements yarp::dev::IEncoders.

Definition at line 134 of file ImplementEncoders.cpp.

◆ getEncoderSpeed()

ReturnValue ImplementEncoders::getEncoderSpeed ( int  j,
double *  spds 
)
overridevirtual

Read the instantaneous speed of an axis.

Parameters
jaxis number
spdspointer to storage for the output
Returns
true if successful, false ... otherwise.

Implements yarp::dev::IEncoders.

Definition at line 149 of file ImplementEncoders.cpp.

◆ getEncoderSpeeds()

ReturnValue ImplementEncoders::getEncoderSpeeds ( double *  spds)
overridevirtual

Read the instantaneous speed of all axes.

Parameters
spdspointer to storage for the output values
Returns
guess what? (true/false on success or failure).

Implements yarp::dev::IEncoders.

Definition at line 168 of file ImplementEncoders.cpp.

◆ initialize()

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

Initialize the internal data and alloc memory.

Parameters
sizeis the number of controlled axes the driver deals with.
amapis a lookup table mapping axes onto physical drivers.
encis an array containing the encoder to angles conversion factors.
zosis an array containing the zeros of the encoders.
Returns
true if initialized succeeded, false if it wasn't executed, or assert.

Definition at line 36 of file ImplementEncoders.cpp.

◆ resetEncoder()

ReturnValue ImplementEncoders::resetEncoder ( int  j)
overridevirtual

Reset encoder, single joint.

Set the encoder value to zero

Parameters
jencoder number
Returns
true/false

Implements yarp::dev::IEncoders.

Definition at line 74 of file ImplementEncoders.cpp.

◆ resetEncoders()

ReturnValue ImplementEncoders::resetEncoders ( )
overridevirtual

Reset encoders.

Set the encoders value to zero

Returns
true/false

Implements yarp::dev::IEncoders.

Definition at line 85 of file ImplementEncoders.cpp.

◆ setEncoder()

ReturnValue ImplementEncoders::setEncoder ( int  j,
double  val 
)
overridevirtual

Set the value of the encoder for a given joint.

Parameters
jencoder number
valnew value
Returns
true/false

Implements yarp::dev::IEncoders.

Definition at line 92 of file ImplementEncoders.cpp.

◆ setEncoders()

ReturnValue ImplementEncoders::setEncoders ( const double *  vals)
overridevirtual

Set the value of all encoders.

Parameters
valspointer to the new values
Returns
true/false

Implements yarp::dev::IEncoders.

Definition at line 105 of file ImplementEncoders.cpp.

◆ uninitialize()

bool ImplementEncoders::uninitialize ( )
protected

Clean up internal data and memory.

Returns
true if uninitialization is executed, false otherwise.

Definition at line 55 of file ImplementEncoders.cpp.

Member Data Documentation

◆ m_buffer_doubles

std::vector<double> yarp::dev::ImplementEncoders::m_buffer_doubles
protected

Definition at line 22 of file ImplementEncoders.h.

◆ m_buffer_ints

std::vector<int> yarp::dev::ImplementEncoders::m_buffer_ints
protected

Definition at line 21 of file ImplementEncoders.h.

◆ m_helper

void* yarp::dev::ImplementEncoders::m_helper =nullptr
protected

Definition at line 20 of file ImplementEncoders.h.

◆ m_imp_mutex

std::mutex yarp::dev::ImplementEncoders::m_imp_mutex
protected

Definition at line 23 of file ImplementEncoders.h.

◆ m_iraw

IEncodersRaw* yarp::dev::ImplementEncoders::m_iraw =nullptr
protected

Definition at line 19 of file ImplementEncoders.h.


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