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

Device interface to one or multiple three axis linear accelerometers. More...

#include <yarp/dev/MultipleAnalogSensorsInterfaces.h>

+ Inheritance diagram for yarp::dev::IThreeAxisLinearAccelerometers:

Public Member Functions

virtual size_t getNrOfThreeAxisLinearAccelerometers () const =0
 Get the number of three axis linear accelerometers exposed by this device. More...
 
virtual yarp::dev::MAS_status getThreeAxisLinearAccelerometerStatus (size_t sens_index) const =0
 Get the status of the specified sensor. More...
 
virtual bool getThreeAxisLinearAccelerometerName (size_t sens_index, std::string &name) const =0
 Get the name of the specified sensor. More...
 
virtual bool getThreeAxisLinearAccelerometerFrameName (size_t sens_index, std::string &frameName) const =0
 Get the name of the frame of the specified sensor. More...
 
virtual bool getThreeAxisLinearAccelerometerMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const =0
 Get the last reading of the specified sensor. More...
 
virtual ~IThreeAxisLinearAccelerometers ()
 

Detailed Description

Device interface to one or multiple three axis linear accelerometers.

Sensor Tag
ThreeAxisLinearAccelerometers

Definition at line 117 of file MultipleAnalogSensorsInterfaces.h.

Constructor & Destructor Documentation

◆ ~IThreeAxisLinearAccelerometers()

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

Definition at line 152 of file MultipleAnalogSensorsInterfaces.h.

Member Function Documentation

◆ getNrOfThreeAxisLinearAccelerometers()

virtual size_t yarp::dev::IThreeAxisLinearAccelerometers::getNrOfThreeAxisLinearAccelerometers ( ) const
pure virtual

Get the number of three axis linear accelerometers exposed by this device.

Implemented in MultipleAnalogSensorsRemapper, MultipleAnalogSensorsClient, BoschIMU, and fakeIMU.

◆ getThreeAxisLinearAccelerometerFrameName()

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

Get the name of the frame of the specified sensor.

Returns
false if an error occurred, true otherwise.

Implemented in MultipleAnalogSensorsRemapper, MultipleAnalogSensorsClient, BoschIMU, and fakeIMU.

◆ getThreeAxisLinearAccelerometerMeasure()

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

Get the last reading of the specified sensor.

Parameters
[in]sens_indexThe index of the specified sensor (should be between 0 and getNrOfThreeAxisLinearAccelerometers()-1).
[out]outThe requested measure. The vector should be 3-dimensional. The measure is expressed in meters^2/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.

◆ getThreeAxisLinearAccelerometerName()

virtual bool yarp::dev::IThreeAxisLinearAccelerometers::getThreeAxisLinearAccelerometerName ( 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, MultipleAnalogSensorsClient, BoschIMU, and fakeIMU.

◆ getThreeAxisLinearAccelerometerStatus()

virtual yarp::dev::MAS_status yarp::dev::IThreeAxisLinearAccelerometers::getThreeAxisLinearAccelerometerStatus ( size_t  sens_index) const
pure virtual

Get the status of the specified sensor.

Implemented in MultipleAnalogSensorsRemapper, MultipleAnalogSensorsClient, BoschIMU, and fakeIMU.


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