YARP
Yet Another Robot Platform
yarp::dev::IEncodersTimed Class Referenceabstract

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

#include <yarp/dev/IEncodersTimed.h>

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

Detailed Description

Control board, extend encoder interface with timestamps.

Definition at line 58 of file IEncodersTimed.h.

Public Member Functions

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

Constructor & Destructor Documentation

◆ ~IEncodersTimed()

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

Destructor.

Definition at line 64 of file IEncodersTimed.h.

Member Function Documentation

◆ getEncodersTimed()

virtual bool 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::RemoteControlBoard, yarp::dev::ControlBoardWrapper, yarp::dev::ControlBoardRemapper, yarp::dev::TestMotor, FakeBot, and yarp::dev::ImplementEncodersTimed.

◆ getEncoderTimed()

virtual bool 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::RemoteControlBoard, yarp::dev::ControlBoardWrapper, yarp::dev::ControlBoardRemapper, yarp::dev::TestMotor, FakeBot, and yarp::dev::ImplementEncodersTimed.


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