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

Control board, encoder interface. More...

#include <yarp/dev/IEncoders.h>

+ Inheritance diagram for yarp::dev::IEncodersRaw:

Public Member Functions

virtual ~IEncodersRaw ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAxes (size_t &ax)=0
 Get the number of controlled axes.
 
virtual yarp::dev::ReturnValue resetEncoderRaw (int j)=0
 Reset encoder, single joint.
 
virtual yarp::dev::ReturnValue resetEncodersRaw ()=0
 Reset encoders.
 
virtual yarp::dev::ReturnValue setEncoderRaw (int j, double val)=0
 Set the value of the encoder for a given joint.
 
virtual yarp::dev::ReturnValue setEncodersRaw (const double *vals)=0
 Set the value of all encoders.
 
virtual yarp::dev::ReturnValue getEncoderRaw (int j, double *v)=0
 Read the value of an encoder.
 
virtual yarp::dev::ReturnValue getEncodersRaw (double *encs)=0
 Read the position of all axes.
 
virtual yarp::dev::ReturnValue getEncoderSpeedRaw (int j, double *sp)=0
 Read the instantaneous speed of an axis.
 
virtual yarp::dev::ReturnValue getEncoderSpeedsRaw (double *spds)=0
 Read the instantaneous acceleration of an axis.
 
virtual yarp::dev::ReturnValue getEncoderAccelerationRaw (int j, double *spds)=0
 Read the instantaneous acceleration of an axis.
 
virtual yarp::dev::ReturnValue getEncoderAccelerationsRaw (double *accs)=0
 Read the instantaneous acceleration of all axes.
 

Detailed Description

Control board, encoder interface.

Definition at line 23 of file IEncoders.h.

Constructor & Destructor Documentation

◆ ~IEncodersRaw()

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

Destructor.

Definition at line 29 of file IEncoders.h.

Member Function Documentation

◆ getAxes()

virtual yarp::dev::ReturnValue yarp::dev::IEncodersRaw::getAxes ( size_t &  ax)
pure virtual

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.

Implemented in FakeLaserWithMotor, FakeMotionControl, FakeMotionControlMicro, and yarp::dev::StubImplEncodersRaw.

◆ getEncoderAccelerationRaw()

virtual yarp::dev::ReturnValue yarp::dev::IEncodersRaw::getEncoderAccelerationRaw ( int  j,
double *  spds 
)
pure virtual

Read the instantaneous acceleration of an axis.

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

Implemented in FakeLaserWithMotor, FakeMotionControl, FakeMotionControlMicro, and yarp::dev::StubImplEncodersRaw.

◆ getEncoderAccelerationsRaw()

virtual yarp::dev::ReturnValue yarp::dev::IEncodersRaw::getEncoderAccelerationsRaw ( double *  accs)
pure virtual

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.

Implemented in FakeLaserWithMotor, FakeMotionControl, FakeMotionControlMicro, and yarp::dev::StubImplEncodersRaw.

◆ getEncoderRaw()

virtual yarp::dev::ReturnValue yarp::dev::IEncodersRaw::getEncoderRaw ( int  j,
double *  v 
)
pure virtual

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?)

Implemented in FakeLaserWithMotor, FakeMotionControl, FakeMotionControlMicro, and yarp::dev::StubImplEncodersRaw.

◆ getEncoderSpeedRaw()

virtual yarp::dev::ReturnValue yarp::dev::IEncodersRaw::getEncoderSpeedRaw ( int  j,
double *  sp 
)
pure virtual

Read the instantaneous speed of an axis.

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

Implemented in FakeLaserWithMotor, FakeMotionControl, FakeMotionControlMicro, and yarp::dev::StubImplEncodersRaw.

◆ getEncoderSpeedsRaw()

virtual yarp::dev::ReturnValue yarp::dev::IEncodersRaw::getEncoderSpeedsRaw ( double *  spds)
pure virtual

Read the instantaneous acceleration of an axis.

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

Implemented in FakeLaserWithMotor, FakeMotionControl, FakeMotionControlMicro, and yarp::dev::StubImplEncodersRaw.

◆ getEncodersRaw()

virtual yarp::dev::ReturnValue yarp::dev::IEncodersRaw::getEncodersRaw ( double *  encs)
pure virtual

Read the position of all axes.

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

Implemented in FakeLaserWithMotor, FakeMotionControl, FakeMotionControlMicro, and yarp::dev::StubImplEncodersRaw.

◆ resetEncoderRaw()

virtual yarp::dev::ReturnValue yarp::dev::IEncodersRaw::resetEncoderRaw ( int  j)
pure virtual

Reset encoder, single joint.

Set the encoder value to zero

Parameters
jencoder number
Returns
true/false

Implemented in FakeLaserWithMotor, FakeMotionControl, FakeMotionControlMicro, and yarp::dev::StubImplEncodersRaw.

◆ resetEncodersRaw()

virtual yarp::dev::ReturnValue yarp::dev::IEncodersRaw::resetEncodersRaw ( )
pure virtual

Reset encoders.

Set the encoders value to zero

Returns
true/false

Implemented in FakeLaserWithMotor, FakeMotionControl, FakeMotionControlMicro, and yarp::dev::StubImplEncodersRaw.

◆ setEncoderRaw()

virtual yarp::dev::ReturnValue yarp::dev::IEncodersRaw::setEncoderRaw ( int  j,
double  val 
)
pure virtual

Set the value of the encoder for a given joint.

Parameters
jencoder number
valnew value
Returns
true/false

Implemented in FakeLaserWithMotor, FakeMotionControl, FakeMotionControlMicro, and yarp::dev::StubImplEncodersRaw.

◆ setEncodersRaw()

virtual yarp::dev::ReturnValue yarp::dev::IEncodersRaw::setEncodersRaw ( const double *  vals)
pure virtual

Set the value of all encoders.

Parameters
valspointer to the new values
Returns
true/false

Implemented in FakeLaserWithMotor, FakeMotionControl, FakeMotionControlMicro, and yarp::dev::StubImplEncodersRaw.


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