yarp::dev::IEncoderArrays Class Reference

Device interface to one or multiple arrays of encoders. More...

#include <yarp/dev/MultipleAnalogSensorsInterfaces.h>

Inheritance diagram for yarp::dev::IEncoderArrays:

Public Member Functions
virtual size_t	getNrOfEncoderArrays () const =0
	Get the number of encoder arrays exposed by this device. More...
virtual yarp::dev::MAS_status	getEncoderArrayStatus (size_t sens_index) const =0
	Get the status of the specified sensor. More...
virtual bool	getEncoderArrayName (size_t sens_index, std::string &name) const =0
	Get the name of the specified sensor. More...
virtual bool	getEncoderArrayMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const =0
	Get the last reading of the specified sensor. More...
virtual size_t	getEncoderArraySize (size_t sens_index) const =0
	Get the size of the specified encoder array. More...
virtual	~IEncoderArrays ()

Detailed Description

Device interface to one or multiple arrays of encoders.

Sensor Tag
EncoderArrays

Note

This interface is typically used for group of encoders that are not explicitly controlled by one of the interfaces typically used for motor control, such as IEncoders and IPositionControl, such as encoders measuring the complete state in an underactuated mechanism.

Definition at line 519 of file MultipleAnalogSensorsInterfaces.h.

Constructor & Destructor Documentation

~IEncoderArrays()

virtual yarp::dev::IEncoderArrays::~IEncoderArrays ( )

inlinevirtual

Definition at line 553 of file MultipleAnalogSensorsInterfaces.h.

Member Function Documentation

getEncoderArrayMeasure()

virtual bool yarp::dev::IEncoderArrays::getEncoderArrayMeasure ( size_t  sens_index, yarp::sig::Vector &  out, double &  timestamp  ) const

pure virtual

Get the last reading of the specified sensor.

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfEncoderArrays()-1).
[out]	out	The requested measure. The vector should be getEncoderArraySize(sens_index)-dimensional. The measure is expressed in Newton.
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

getEncoderArrayName()

virtual bool yarp::dev::IEncoderArrays::getEncoderArrayName ( size_t  sens_index, std::string &  name  ) const

pure virtual

Get the name of the specified sensor.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

getEncoderArraySize()

virtual size_t yarp::dev::IEncoderArrays::getEncoderArraySize ( size_t  sens_index ) const

pure virtual

Get the size of the specified encoder array.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

getEncoderArrayStatus()

virtual yarp::dev::MAS_status yarp::dev::IEncoderArrays::getEncoderArrayStatus ( size_t  sens_index ) const

pure virtual

Get the status of the specified sensor.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

getNrOfEncoderArrays()

virtual size_t yarp::dev::IEncoderArrays::getNrOfEncoderArrays ( ) const

pure virtual

Get the number of encoder arrays exposed by this device.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

---

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

• src/libYARP_dev/src/yarp/dev/MultipleAnalogSensorsInterfaces.h