ImuAccelerometerAdapter Class Reference

Adapter: expose an IMU device as an AccelerometerBase. More...

#include <ImuAccelerometerAdapter.hpp>

Inheritance diagram for ImuAccelerometerAdapter:

Public Member Functions
	ImuAccelerometerAdapter (ImuBase &dev)
bool	readData (AccelerometerData &data) override
	Read accelerometer data.
bool	isDataReady () override
	Check if new accelerometer data is available.
bool	reset () override
	Reset accelerometer to default state.
bool	selfTest () override
	Perform accelerometer self-test.
bool	setFullScaleRange (AccelFullScaleRange range) override
	Set accelerometer full-scale range.
bool	setOutputDataRate (float data_rate_hz) override
	Set accelerometer output data rate.
bool	setOperationMode (OperationMode mode) override
	Set accelerometer operation mode.
Public Member Functions inherited from AccelerometerBase
virtual float	getFullScaleRange () const
	Get current full-scale range setting.
virtual float	getOutputDataRate () const
	Get current output data rate setting.
virtual OperationMode	getOperationMode () const
	Get current operation mode setting.
Public Member Functions inherited from SensorBase< AccelerometerData >
	SensorBase (const SensorBase &)=delete
SensorBase &	operator= (const SensorBase &)=delete
void	setOffset (int16_t x, int16_t y, int16_t z)
	Set sensor calibration offsets.
float	getSensitivity () const
	Get sensor sensitivity.
SensorInfo	getSensorInfo () const
	Get sensor information.
virtual SensorConfig	getConfig () const
	Get current sensor configuration.

Additional Inherited Members
Protected Member Functions inherited from AccelerometerBase
	AccelerometerBase ()
	Construct a new AccelerometerBase object.
virtual	~AccelerometerBase ()=default
	Destroy the AccelerometerBase object.
	AccelerometerBase (const AccelerometerBase &)=delete
AccelerometerBase &	operator= (const AccelerometerBase &)=delete
Protected Member Functions inherited from SensorBase< AccelerometerData >
	SensorBase (SensorType sensor_type=SensorType::UNKNOWN)
	Construct a new SensorBase object.
virtual	~SensorBase ()=default
	Virtual destructor for proper polymorphic cleanup.
Protected Attributes inherited from SensorBase< AccelerometerData >
SensorConfig	_config
	Current configuration.
SensorInfo	_info
	Sensor information.
int16_t	_x_offset
int16_t	_y_offset
int16_t	_z_offset
float	_sensitivity

Detailed Description

Adapter: expose an IMU device as an AccelerometerBase.

Definition at line 38 of file ImuAccelerometerAdapter.hpp.

Constructor & Destructor Documentation

ImuAccelerometerAdapter()

ImuAccelerometerAdapter::ImuAccelerometerAdapter ( ImuBase &  dev )

inlineexplicit

Definition at line 41 of file ImuAccelerometerAdapter.hpp.

Member Function Documentation

isDataReady()

bool ImuAccelerometerAdapter::isDataReady ( )

inlineoverridevirtual

Check if new accelerometer data is available.

Returns

true New data available

false No new data

Implements AccelerometerBase.

Definition at line 48 of file ImuAccelerometerAdapter.hpp.

References ImuBase::ACCEL, and ImuBase::isDataReady().

readData()

bool ImuAccelerometerAdapter::readData ( AccelerometerData &  data )

inlineoverridevirtual

Read accelerometer data.

Parameters

data	Reference to store accelerometer data

Returns

true Read successful

false Read failed

Implements AccelerometerBase.

Definition at line 43 of file ImuAccelerometerAdapter.hpp.

References ImuBase::readAccel().

reset()

bool ImuAccelerometerAdapter::reset ( )

inlineoverridevirtual

Reset accelerometer to default state.

Returns

true Reset successful

false Reset failed

Implements AccelerometerBase.

Definition at line 53 of file ImuAccelerometerAdapter.hpp.

References ImuBase::reset().

selfTest()

bool ImuAccelerometerAdapter::selfTest ( )

inlineoverridevirtual

Perform accelerometer self-test.

Returns

true Self-test passed

false Self-test failed

Implements AccelerometerBase.

Definition at line 58 of file ImuAccelerometerAdapter.hpp.

References ImuBase::selfTest().

setFullScaleRange()

bool ImuAccelerometerAdapter::setFullScaleRange ( AccelFullScaleRange  range )

inlineoverridevirtual

Set accelerometer full-scale range.

Parameters

range

Desired full-scale range

Returns

true Configuration successful

false Configuration failed

Implements AccelerometerBase.

Definition at line 64 of file ImuAccelerometerAdapter.hpp.

References ImuBase::setAccelFullScaleRange().

setOperationMode()

bool ImuAccelerometerAdapter::setOperationMode ( OperationMode  mode )

inlineoverridevirtual

Set accelerometer operation mode.

Parameters

mode	Desired operation mode

Returns

true Configuration successful

false Configuration failed

Implements AccelerometerBase.

Definition at line 74 of file ImuAccelerometerAdapter.hpp.

References ImuBase::setOperationMode().

setOutputDataRate()

bool ImuAccelerometerAdapter::setOutputDataRate ( float  data_rate_hz )

inlineoverridevirtual

Set accelerometer output data rate.

Parameters

data_rate_hz

Desired output data rate in Hertz

Returns

true Configuration successful

false Configuration failed

Implements AccelerometerBase.

Definition at line 69 of file ImuAccelerometerAdapter.hpp.

References ImuBase::setAccelOutputDataRate().

---

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

• ImuAccelerometerAdapter.hpp