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

Control board, extend encoder interface with timestamps. More...

#include <yarp/dev/IEncodersTimed.h>

+ Inheritance diagram for yarp::dev::IEncodersTimed:

Public Member Functions

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

Detailed Description

Control board, extend encoder interface with timestamps.

Definition at line 53 of file IEncodersTimed.h.

Constructor & Destructor Documentation

◆ ~IEncodersTimed()

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

Destructor.

Definition at line 59 of file IEncodersTimed.h.

Member Function Documentation

◆ getEncodersTimed()

virtual yarp::dev::ReturnValue yarp::dev::IEncodersTimed::getEncodersTimed ( double *  encs,
double *  time 
)
pure virtual

Read the instantaneous acceleration of all axes.

Parameters
encspointer to the array that will contain the output
timepointer to the array that will contain individual timestamps
Returns
true if all goes well, false if anything bad happens.

Implemented in yarp::dev::xHandControlBoard, ControlBoardCouplingHandler, ControlBoardRemappingEngine, yarp::dev::ImplementEncodersTimed, and ControlBoard_nwc_yarp.

◆ getEncoderTimed()

virtual yarp::dev::ReturnValue yarp::dev::IEncodersTimed::getEncoderTimed ( int  j,
double *  encs,
double *  time 
)
pure virtual

Read the instantaneous acceleration of all axes.

Parameters
jaxis index
encsencoder value (pointer to)
timecorresponding timestamp (pointer to)
Returns
true if all goes well, false if anything bad happens.

Implemented in yarp::dev::xHandControlBoard, ControlBoardCouplingHandler, ControlBoardRemappingEngine, ControlBoard_nwc_yarp, and yarp::dev::ImplementEncodersTimed.


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