yarp::dev::IThreeAxisMagnetometers Class Reference

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

#include <yarp/dev/MultipleAnalogSensorsInterfaces.h>

Inheritance diagram for yarp::dev::IThreeAxisMagnetometers:

Public Member Functions
virtual size_t	getNrOfThreeAxisMagnetometers () const =0
	Get the number of magnetometers exposed by this device. More...
virtual yarp::dev::MAS_status	getThreeAxisMagnetometerStatus (size_t sens_index) const =0
	Get the status of the specified sensor. More...
virtual bool	getThreeAxisMagnetometerName (size_t sens_index, std::string &name) const =0
	Get the name of the specified sensor. More...
virtual bool	getThreeAxisMagnetometerFrameName (size_t sens_index, std::string &frameName) const =0
	Get the name of the frame of the specified sensor. More...
virtual bool	getThreeAxisMagnetometerMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const =0
	Get the last reading of the specified sensor. More...
virtual	~IThreeAxisMagnetometers ()

Detailed Description

Device interface to one or multiple three axis magnetometers.

Sensor Tag
ThreeAxisMagnetometers

Definition at line 164 of file MultipleAnalogSensorsInterfaces.h.

Constructor & Destructor Documentation

~IThreeAxisMagnetometers()

virtual yarp::dev::IThreeAxisMagnetometers::~IThreeAxisMagnetometers ( )

inlinevirtual

Definition at line 199 of file MultipleAnalogSensorsInterfaces.h.

Member Function Documentation

getNrOfThreeAxisMagnetometers()

virtual size_t yarp::dev::IThreeAxisMagnetometers::getNrOfThreeAxisMagnetometers ( ) const

pure virtual

Get the number of magnetometers exposed by this device.

Implemented in MultipleAnalogSensorsRemapper, MultipleAnalogSensorsClient, BoschIMU, and fakeIMU.

getThreeAxisMagnetometerFrameName()

virtual bool yarp::dev::IThreeAxisMagnetometers::getThreeAxisMagnetometerFrameName ( 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.

getThreeAxisMagnetometerMeasure()

virtual bool yarp::dev::IThreeAxisMagnetometers::getThreeAxisMagnetometerMeasure ( 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 getNrOfThreeAxisMagnetometers()-1).
[out]	out	The requested measure. The vector should be 3-dimensional. The measure is expressed in tesla .
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Returns

false if an error occurred, true otherwise.

Implemented in MultipleAnalogSensorsRemapper, MultipleAnalogSensorsClient, BoschIMU, and fakeIMU.

getThreeAxisMagnetometerName()

virtual bool yarp::dev::IThreeAxisMagnetometers::getThreeAxisMagnetometerName ( 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.

getThreeAxisMagnetometerStatus()

virtual yarp::dev::MAS_status yarp::dev::IThreeAxisMagnetometers::getThreeAxisMagnetometerStatus ( 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:

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