SolAR::api::input::devices::IIMU Class Reference

Get access to the data of an IMU. UUID: 9940fa48-10cf-11e8-b642-0ed5f89f718b More...

#include <IIMU.h>

Inheritance diagram for SolAR::api::input::devices::IIMU:

Collaboration diagram for SolAR::api::input::devices::IIMU:

Public Member Functions
	IIMU ()=default
	IIMU default constructor.
virtual	~IIMU ()=default
	IIMU default destructor.
virtual FrameworkReturnCode	getGyroscopeData (SolAR::datastructure::Vector3f &gyroData)=0
	Get gyroscope data. More...
virtual FrameworkReturnCode	getAccelerometerData (SolAR::datastructure::Vector3f &accelData)=0
	Get accelerometer data. More...
virtual FrameworkReturnCode	getMagnetometerData (SolAR::datastructure::Vector3f &magData)=0
	Get magnetometer data. More...
virtual FrameworkReturnCode	getAllSensorsData (SolAR::datastructure::Vector3f &gyroData, SolAR::datastructure::Vector3f &accelData, SolAR::datastructure::Vector3f &magData)=0
	Get gyroscope, accelerometer and magnetometer data. More...
virtual bool	isGyroscopeAvailable ()=0
	Get gyroscope sensor availability. More...
virtual bool	isAccelerometerAvailable ()=0
	Get accelerometer sensor availability. More...
virtual bool	isMagnetometerAvailable ()=0
	Get magnetometer sensor availability. More...
Public Member Functions inherited from SolAR::api::input::devices::IDevice
	IDevice ()=default
	Specify the IDevice constructor class.
virtual	~IDevice () override=default
	Specify the IDevice destructor class.
virtual FrameworkReturnCode	start ()=0
	Start the acquisition device referenced by its device_id. More...
virtual FrameworkReturnCode	stop ()=0
	Stop the acquisition device. More...

Detailed Description

Get access to the data of an IMU. UUID: 9940fa48-10cf-11e8-b642-0ed5f89f718b

This class describes the interface of an Inertial Measurement Unit capture device.

Member Function Documentation

getAccelerometerData()

virtual FrameworkReturnCode SolAR::api::input::devices::IIMU::getAccelerometerData ( SolAR::datastructure::Vector3f &  accelData )

pure virtual

Get accelerometer data.

Parameters

[in,out]

accelData

The vector in which the accelerometer data will be stored (in metre per second squared)

Returns

FrameworkReturnCode to track sucessful or failing event.

getAllSensorsData()

virtual FrameworkReturnCode SolAR::api::input::devices::IIMU::getAllSensorsData ( SolAR::datastructure::Vector3f &  gyroData, SolAR::datastructure::Vector3f &  accelData, SolAR::datastructure::Vector3f &  magData  )

pure virtual

Get gyroscope, accelerometer and magnetometer data.

Parameters

[in,out]	gyroData	The vector in which the gyroscope data will be stored (in radian per second)
[in,out]	accelData	accelData The vector in which the accelerometer data will be stored (in metre per second squared)
[in,out]	magData	The vector in which the magnetometer data will be stored (in gauss)

Returns

FrameworkReturnCode to track sucessful or failing event.

getGyroscopeData()

virtual FrameworkReturnCode SolAR::api::input::devices::IIMU::getGyroscopeData ( SolAR::datastructure::Vector3f &  gyroData )

pure virtual

Get gyroscope data.

Parameters

[in,out]

gyroData

The vector in which the gyroscope data will be stored (in radian per second)

Returns

FrameworkReturnCode to track sucessful or failing event.

getMagnetometerData()

virtual FrameworkReturnCode SolAR::api::input::devices::IIMU::getMagnetometerData ( SolAR::datastructure::Vector3f &  magData )

pure virtual

Get magnetometer data.

Parameters

[in,out]

magData

The vector in which the magnetometer data will be stored (in gauss)

Returns

FrameworkReturnCode to track sucessful or failing event.

isAccelerometerAvailable()

virtual bool SolAR::api::input::devices::IIMU::isAccelerometerAvailable ( )

pure virtual

Get accelerometer sensor availability.

Returns

bool Whether the IMU can produce accelerometer data or not

isGyroscopeAvailable()

virtual bool SolAR::api::input::devices::IIMU::isGyroscopeAvailable ( )

pure virtual

Get gyroscope sensor availability.

Returns

bool Whether the IMU can produce gyroscope data or not

isMagnetometerAvailable()

virtual bool SolAR::api::input::devices::IIMU::isMagnetometerAvailable ( )

pure virtual

Get magnetometer sensor availability.

Returns

bool Whether the IMU can produce magnetometer data or not

---

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

• interfaces/api/input/devices/IIMU.h