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

Device interface to one or multiple three axis gyroscopes. More...

#include <yarp/dev/MultipleAnalogSensorsInterfaces.h>

+ Inheritance diagram for yarp::dev::IThreeAxisGyroscopes:

Public Member Functions

virtual size_t getNrOfThreeAxisGyroscopes () const =0
 Get the number of three axis gyroscopes exposed by this sensor. More...
 
virtual yarp::dev::MAS_status getThreeAxisGyroscopeStatus (size_t sens_index) const =0
 Get the status of the specified sensor. More...
 
virtual bool getThreeAxisGyroscopeName (size_t sens_index, std::string &name) const =0
 Get the name of the specified sensor. More...
 
virtual bool getThreeAxisGyroscopeFrameName (size_t sens_index, std::string &frameName) const =0
 Get the name of the frame of the specified sensor. More...
 
virtual bool getThreeAxisGyroscopeMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const =0
 Get the last reading of the gyroscope. More...
 
virtual ~IThreeAxisGyroscopes ()
 

Detailed Description

Device interface to one or multiple three axis gyroscopes.

This interface is used to expose the measurement of a gyroscope device.

The measure of a gyroscope is an 3-dimensional angular velocity, and the unit of measurement used in this device is degrees/seconds.

Sensor Tag
ThreeAxisGyroscopes

Definition at line 56 of file MultipleAnalogSensorsInterfaces.h.

Constructor & Destructor Documentation

◆ ~IThreeAxisGyroscopes()

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

Definition at line 97 of file MultipleAnalogSensorsInterfaces.h.

Member Function Documentation

◆ getNrOfThreeAxisGyroscopes()

virtual size_t yarp::dev::IThreeAxisGyroscopes::getNrOfThreeAxisGyroscopes ( ) const
pure virtual

Get the number of three axis gyroscopes exposed by this sensor.

Implemented in MultipleAnalogSensorsRemapper, MultipleAnalogSensorsClient, BoschIMU, and fakeIMU.

◆ getThreeAxisGyroscopeFrameName()

virtual bool yarp::dev::IThreeAxisGyroscopes::getThreeAxisGyroscopeFrameName ( size_t  sens_index,
std::string &  frameName 
) const
pure virtual

Get the name of the frame of the specified sensor.

Parameters
[in]sens_indexThe index of the specified sensor (should be between 0 and getNrOfThreeAxisGyroscopes()-1).
Returns
false if an error occurred, true otherwise.

Implemented in MultipleAnalogSensorsRemapper, MultipleAnalogSensorsClient, BoschIMU, and fakeIMU.

◆ getThreeAxisGyroscopeMeasure()

virtual bool yarp::dev::IThreeAxisGyroscopes::getThreeAxisGyroscopeMeasure ( size_t  sens_index,
yarp::sig::Vector out,
double &  timestamp 
) const
pure virtual

Get the last reading of the gyroscope.

Parameters
[in]sens_indexThe index of the specified sensor (should be between 0 and getNrOfThreeAxisGyroscopes()-1).
[out]outThe requested measure. The vector should be 3-dimensional. The measure is expressed in degrees/seconds.
[out]timestampThe timestamp of the requested measure, expressed in seconds.
Returns
false if an error occurred, true otherwise.

Implemented in MultipleAnalogSensorsRemapper, MultipleAnalogSensorsClient, BoschIMU, and fakeIMU.

◆ getThreeAxisGyroscopeName()

virtual bool yarp::dev::IThreeAxisGyroscopes::getThreeAxisGyroscopeName ( size_t  sens_index,
std::string &  name 
) const
pure virtual

Get the name of the specified sensor.

Parameters
[in]sens_indexThe index of the specified sensor (should be between 0 and getNrOfThreeAxisGyroscopes()-1).
Returns
false if an error occurred, true otherwise.

Implemented in MultipleAnalogSensorsRemapper, MultipleAnalogSensorsClient, BoschIMU, and fakeIMU.

◆ getThreeAxisGyroscopeStatus()

virtual yarp::dev::MAS_status yarp::dev::IThreeAxisGyroscopes::getThreeAxisGyroscopeStatus ( size_t  sens_index) const
pure virtual

Get the status of the specified sensor.

Parameters
[in]sens_indexThe index of the specified sensor (should be between 0 and getNrOfThreeAxisGyroscopes()-1).

Implemented in MultipleAnalogSensorsRemapper, MultipleAnalogSensorsClient, BoschIMU, and fakeIMU.


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