yarp::dev::IPositionSensors Class Reference

Device interface to one or multiple position sensors, such as UWB localization sensors. More...

#include <yarp/dev/MultipleAnalogSensorsInterfaces.h>

Inheritance diagram for yarp::dev::IPositionSensors:

Public Member Functions
virtual size_t	getNrOfPositionSensors () const =0
	Get the number of position sensors exposed by this device. More...
virtual yarp::dev::MAS_status	getPositionSensorStatus (size_t sens_index) const =0
	Get the status of the specified sensor. More...
virtual bool	getPositionSensorName (size_t sens_index, std::string &name) const =0
	Get the name of the specified sensor. More...
virtual bool	getPositionSensorFrameName (size_t sens_index, std::string &frameName) const =0
	Get the name of the frame of the specified sensor. More...
virtual bool	getPositionSensorMeasure (size_t sens_index, yarp::sig::Vector &xyz, double &timestamp) const =0
	Get the last reading of the position sensor as x y z. More...
virtual	~IPositionSensors ()

Detailed Description

Device interface to one or multiple position sensors, such as UWB localization sensors.

The device returns the relative position between a lab or surface-fixed frame and a frame rigidly attached to the sensor.

The definition of the lab or surface-fixed frame is sensor-specific.

Sensor Tag
PositionSensors

Definition at line 215 of file MultipleAnalogSensorsInterfaces.h.

Constructor & Destructor Documentation

~IPositionSensors()

virtual yarp::dev::IPositionSensors::~IPositionSensors ( )

inlinevirtual

Definition at line 254 of file MultipleAnalogSensorsInterfaces.h.

Member Function Documentation

getNrOfPositionSensors()

virtual size_t yarp::dev::IPositionSensors::getNrOfPositionSensors ( ) const

pure virtual

Get the number of position sensors exposed by this device.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

getPositionSensorFrameName()

virtual bool yarp::dev::IPositionSensors::getPositionSensorFrameName ( size_t  sens_index, std::string &  frameName  ) const

pure virtual

Get the name of the frame of the specified sensor.

Note

This is an implementation specific method, that may return the name of the sensor frame in a scenegraph

Returns

false if an error occurred, true otherwise.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

getPositionSensorMeasure()

virtual bool yarp::dev::IPositionSensors::getPositionSensorMeasure ( size_t  sens_index, yarp::sig::Vector &  xyz, double &  timestamp  ) const

pure virtual

Get the last reading of the position sensor as x y z.

Parameters

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

Returns

false if an error occurred, true otherwise.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

getPositionSensorName()

virtual bool yarp::dev::IPositionSensors::getPositionSensorName ( size_t  sens_index, std::string &  name  ) const

pure virtual

Get the name of the specified sensor.

Returns

false if an error occurred, true otherwise.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

getPositionSensorStatus()

virtual yarp::dev::MAS_status yarp::dev::IPositionSensors::getPositionSensorStatus ( size_t  sens_index ) const

pure virtual

Get the status of the specified sensor.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

---

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

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