yarp::dev::ILinearVelocitySensors Class Reference

#include <yarp/dev/MultipleAnalogSensorsInterfaces.h>

Inheritance diagram for yarp::dev::ILinearVelocitySensors:

Public Member Functions
virtual size_t	getNrOfLinearVelocitySensors () const =0
	Get the number of linear velocity sensors exposed by this device.
virtual yarp::dev::MAS_status	getLinearVelocitySensorStatus (size_t sens_index) const =0
	Get the status of the specified sensor.
virtual bool	getLinearVelocitySensorName (size_t sens_index, std::string &name) const =0
	Get the name of the specified sensor.
virtual bool	getLinearVelocitySensorFrameName (size_t sens_index, std::string &frameName) const =0
	Get the name of the frame of the specified sensor.
virtual bool	getLinearVelocitySensorMeasure (size_t sens_index, yarp::sig::Vector &xyz, double &timestamp) const =0
	Get the last reading of the linear velocity sensor as x y z.
virtual	~ILinearVelocitySensors ()

Detailed Description

Definition at line 292 of file MultipleAnalogSensorsInterfaces.h.

Constructor & Destructor Documentation

~ILinearVelocitySensors()

virtual yarp::dev::ILinearVelocitySensors::~ILinearVelocitySensors ( )

inlinevirtual

Definition at line 331 of file MultipleAnalogSensorsInterfaces.h.

Member Function Documentation

getLinearVelocitySensorFrameName()

virtual bool yarp::dev::ILinearVelocitySensors::getLinearVelocitySensorFrameName ( 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.

getLinearVelocitySensorMeasure()

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

pure virtual

Get the last reading of the linear velocity sensor as x y z.

Parameters

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

Returns

false if an error occurred, true otherwise.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

getLinearVelocitySensorName()

virtual bool yarp::dev::ILinearVelocitySensors::getLinearVelocitySensorName ( 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.

getLinearVelocitySensorStatus()

virtual yarp::dev::MAS_status yarp::dev::ILinearVelocitySensors::getLinearVelocitySensorStatus ( size_t  sens_index ) const

pure virtual

Get the status of the specified sensor.

Implemented in MultipleAnalogSensorsRemapper, and MultipleAnalogSensorsClient.

getNrOfLinearVelocitySensors()

virtual size_t yarp::dev::ILinearVelocitySensors::getNrOfLinearVelocitySensors ( ) const

pure virtual

Get the number of linear velocity sensors 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