fakeIMU : fake device implementing the device interface typically implemented by an Inertial Measurement Unit More...

#include <fake/fakeIMU/FakeIMU.h>

Inheritance diagram for FakeIMU:

Public Member Functions
	FakeIMU ()
	This device implements a fake analog sensor emulating an IMU.

	FakeIMU (const FakeIMU &)=delete

	FakeIMU (FakeIMU &&)=delete

FakeIMU &	operator= (const FakeIMU &)=delete

FakeIMU &	operator= (FakeIMU &&)=delete

	~FakeIMU () override

bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.

bool	close () override
	Close the DeviceDriver.

size_t	getNrOfThreeAxisGyroscopes () const override
	Get the number of three axis gyroscopes exposed by this sensor.

yarp::dev::MAS_status	getThreeAxisGyroscopeStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getThreeAxisGyroscopeName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getThreeAxisGyroscopeFrameName (size_t sens_index, std::string &frameName) const override
	Get the name of the frame of the specified sensor.

bool	getThreeAxisGyroscopeMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
	Get the last reading of the gyroscope.

size_t	getNrOfThreeAxisLinearAccelerometers () const override
	Get the number of three axis linear accelerometers exposed by this device.

yarp::dev::MAS_status	getThreeAxisLinearAccelerometerStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getThreeAxisLinearAccelerometerName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getThreeAxisLinearAccelerometerFrameName (size_t sens_index, std::string &frameName) const override
	Get the name of the frame of the specified sensor.

bool	getThreeAxisLinearAccelerometerMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
	Get the last reading of the specified sensor.

size_t	getNrOfThreeAxisMagnetometers () const override
	Get the number of magnetometers exposed by this device.

yarp::dev::MAS_status	getThreeAxisMagnetometerStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getThreeAxisMagnetometerName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getThreeAxisMagnetometerFrameName (size_t sens_index, std::string &frameName) const override
	Get the name of the frame of the specified sensor.

bool	getThreeAxisMagnetometerMeasure (size_t sens_index, yarp::sig::Vector &out, double &timestamp) const override
	Get the last reading of the specified sensor.

size_t	getNrOfOrientationSensors () const override
	Get the number of orientation sensors exposed by this device.

yarp::dev::MAS_status	getOrientationSensorStatus (size_t sens_index) const override
	Get the status of the specified sensor.

bool	getOrientationSensorName (size_t sens_index, std::string &name) const override
	Get the name of the specified sensor.

bool	getOrientationSensorFrameName (size_t sens_index, std::string &frameName) const override
	Get the name of the frame of the specified sensor.

bool	getOrientationSensorMeasureAsRollPitchYaw (size_t sens_index, yarp::sig::Vector &rpy, double &timestamp) const override
	Get the last reading of the orientation sensor as roll pitch yaw.

Public Member Functions inherited from yarp::dev::DeviceDriver
	DeviceDriver ()

	DeviceDriver (const DeviceDriver &other)=delete

	DeviceDriver (DeviceDriver &&other) noexcept=delete

DeviceDriver &	operator= (const DeviceDriver &other)=delete

DeviceDriver &	operator= (DeviceDriver &&other) noexcept=delete

virtual	~DeviceDriver ()

virtual std::string	id () const
	Return the id assigned to the PolyDriver.

virtual void	setId (const std::string &id)
	Set the id for this device.

template<class T >
bool	view (T *&x)
	Get an interface to the device driver.

virtual DeviceDriver *	getImplementation ()
	Some drivers are bureaucrats, pointing at others.

Public Member Functions inherited from yarp::os::PeriodicThread
	PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No, PeriodicThreadClock clockAccuracy=PeriodicThreadClock::Relative)
	Constructor.

	PeriodicThread (double period, PeriodicThreadClock clockAccuracy)
	Constructor.

virtual	~PeriodicThread ()

bool	start ()
	Call this to start the thread.

void	step ()
	Call this to "step" the thread rather than starting it.

void	stop ()
	Call this to stop the thread, this call blocks until the thread is terminated (and releaseThread() called).

void	askToStop ()
	Stop the thread.

bool	isRunning () const
	Returns true when the thread is started, false otherwise.

bool	isSuspended () const
	Returns true when the thread is suspended, false otherwise.

bool	setPeriod (double period)
	Set the (new) period of the thread.

double	getPeriod () const
	Return the current period of the thread.

void	suspend ()
	Suspend the thread, the thread keeps running by doLoop is never executed.

void	resume ()
	Resume the thread if previously suspended.

void	resetStat ()
	Reset thread statistics.

double	getEstimatedPeriod () const
	Return estimated period since last reset.

void	getEstimatedPeriod (double &av, double &std) const
	Return estimated period since last reset.

unsigned int	getIterations () const
	Return the number of iterations performed since last reset.

double	getEstimatedUsed () const
	Return the estimated duration of the run() function since last reset.

void	getEstimatedUsed (double &av, double &std) const
	Return estimated duration of the run() function since last reset.

int	setPriority (int priority, int policy=-1)
	Set the priority and scheduling policy of the thread, if the OS supports that.

int	getPriority () const
	Query the current priority of the thread, if the OS supports that.

int	getPolicy () const
	Query the current scheduling policy of the thread, if the OS supports that.

Public Member Functions inherited from yarp::dev::IThreeAxisGyroscopes
virtual	~IThreeAxisGyroscopes ()

Public Member Functions inherited from yarp::dev::IThreeAxisLinearAccelerometers
virtual	~IThreeAxisLinearAccelerometers ()

Public Member Functions inherited from yarp::dev::IThreeAxisMagnetometers
virtual	~IThreeAxisMagnetometers ()

Public Member Functions inherited from yarp::dev::IOrientationSensors
virtual	~IOrientationSensors ()

Public Member Functions inherited from FakeIMU_ParamsParser
	FakeIMU_ParamsParser ()

	~FakeIMU_ParamsParser () override=default

bool	parseParams (const yarp::os::Searchable &config) override
	Parse the DeviceDriver parameters.

std::string	getDeviceClassName () const override
	Get the name of the DeviceDriver class.

std::string	getDeviceName () const override
	Get the name of the device (i.e.

std::string	getDocumentationOfDeviceParams () const override
	Get the documentation of the DeviceDriver's parameters.

std::vector< std::string >	getListOfParams () const override
	Return a list of all params used by the device.

Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual	~IDeviceDriverParams ()

Additional Inherited Members
Public Attributes inherited from FakeIMU_ParamsParser
const std::string	m_device_classname = {"FakeIMU"}

const std::string	m_device_name = {"fakeIMU"}

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

const std::string	m_period_defaultValue = {"10"}

const std::string	m_constantValue_defaultValue = {"false"}

const std::string	m_sensorName_defaultValue = {"sensorName"}

const std::string	m_frameName_defaultValue = {"frameName"}

int	m_period = {10}

bool	m_constantValue = {false}

std::string	m_sensorName = {"sensorName"}

std::string	m_frameName = {"frameName"}

Protected Member Functions inherited from yarp::os::PeriodicThread
virtual void	threadRelease ()
	Release method.

virtual void	beforeStart ()
	Called just before a new thread starts.

virtual void	afterStart (bool success)
	Called just after a new thread starts (or fails to start), this is executed by the same thread that calls start().

Detailed Description

fakeIMU : fake device implementing the device interface typically implemented by an Inertial Measurement Unit

Parameters required by this device are shown in class: FakeIMU_ParamsParser

Definition at line 21 of file FakeIMU.h.

Constructor & Destructor Documentation

◆ FakeIMU() [1/3]

FakeIMU::FakeIMU ( )

This device implements a fake analog sensor emulating an IMU.

Definition at line 35 of file FakeIMU.cpp.

◆ FakeIMU() [2/3]

FakeIMU::FakeIMU ( const FakeIMU & )

delete

◆ FakeIMU() [3/3]

FakeIMU::FakeIMU ( FakeIMU && )

delete

◆ ~FakeIMU()

FakeIMU::~FakeIMU ( )

override

Definition at line 47 of file FakeIMU.cpp.

Member Function Documentation

◆ close()

bool FakeIMU::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 63 of file FakeIMU.cpp.

◆ getNrOfOrientationSensors()

size_t FakeIMU::getNrOfOrientationSensors ( ) const

overridevirtual

Get the number of orientation sensors exposed by this device.

Implements yarp::dev::IOrientationSensors.

Definition at line 241 of file FakeIMU.cpp.

◆ getNrOfThreeAxisGyroscopes()

size_t FakeIMU::getNrOfThreeAxisGyroscopes ( ) const

overridevirtual

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

Implements yarp::dev::IThreeAxisGyroscopes.

Definition at line 127 of file FakeIMU.cpp.

◆ getNrOfThreeAxisLinearAccelerometers()

size_t FakeIMU::getNrOfThreeAxisLinearAccelerometers ( ) const

overridevirtual

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

Implements yarp::dev::IThreeAxisLinearAccelerometers.

Definition at line 165 of file FakeIMU.cpp.

◆ getNrOfThreeAxisMagnetometers()

size_t FakeIMU::getNrOfThreeAxisMagnetometers ( ) const

overridevirtual

Get the number of magnetometers exposed by this device.

Implements yarp::dev::IThreeAxisMagnetometers.

Definition at line 203 of file FakeIMU.cpp.

◆ getOrientationSensorFrameName()

bool FakeIMU::getOrientationSensorFrameName	(	size_t	sens_index,
		std::string &	frameName
	)		const

overridevirtual

Get the name of the frame of the specified sensor.

Note: This is an implementation specific method, that may return the name of the sensor frame in a scenegraph

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IOrientationSensors.

Definition at line 256 of file FakeIMU.cpp.

◆ getOrientationSensorMeasureAsRollPitchYaw()

bool FakeIMU::getOrientationSensorMeasureAsRollPitchYaw	(	size_t	sens_index,
		yarp::sig::Vector &	rpy,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the orientation sensor as roll pitch yaw.

If $ f $ is the lab or surface fixed frame, and $ s $ is the sensor-fixed frame, this methods returns the angles $r \in [-180, 180] , p \in [-90, 90], y \in [-180, 180]$ such that

${}^f R_s = RotZ\left(\frac{\pi}{180}y\right)*RotY\left(\frac{\pi}{180}p\right)*RotX\left(\frac{\pi}{180}r\right)$

with

$RotZ(\theta) = \begin{bmatrix} \cos(\theta) & -\sin(\theta) & 0 \\ \sin(\theta) & \cos(\theta) & 0 \\ 0 & 0 & 1 \\ \end{bmatrix}$

,

$RotY(\theta) = \begin{bmatrix} \cos(\theta) & 0 & \sin(\theta) \\ 0 & 1 & 0 \\ -\sin(\theta) & 0 & \cos(\theta) \\ \end{bmatrix}$

and

$RotX(\theta) = \begin{bmatrix} 1 & 0 & 0 \\ 0 & \cos(\theta) & - \sin(\theta) \\ 0 & \sin(\theta) & \cos(\theta) \\ \end{bmatrix}$

where ${}^f R_s \in \mathbb{R}^{3 \times 3}$ is the rotation that left-multiplied by a 3d column vector expressed in $ s $ it returns it expressed in $ f $ .

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfOrientationSensors()-1).
[out]	out	The requested measure. The vector should be 3-dimensional. The measure is expressed in degrees .
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IOrientationSensors.

Definition at line 261 of file FakeIMU.cpp.

◆ getOrientationSensorName()

bool FakeIMU::getOrientationSensorName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IOrientationSensors.

Definition at line 251 of file FakeIMU.cpp.

◆ getOrientationSensorStatus()

yarp::dev::MAS_status FakeIMU::getOrientationSensorStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Implements yarp::dev::IOrientationSensors.

Definition at line 246 of file FakeIMU.cpp.

◆ getThreeAxisGyroscopeFrameName()

bool FakeIMU::getThreeAxisGyroscopeFrameName	(	size_t	sens_index,
		std::string &	frameName
	)		const

overridevirtual

Get the name of the frame of the specified sensor.

Parameters

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

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisGyroscopes.

Definition at line 142 of file FakeIMU.cpp.

◆ getThreeAxisGyroscopeMeasure()

bool FakeIMU::getThreeAxisGyroscopeMeasure	(	size_t	sens_index,
		yarp::sig::Vector &	out,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the gyroscope.

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfThreeAxisGyroscopes()-1).
[out]	out	The requested measure. The vector should be 3-dimensional. The measure is expressed in degrees/seconds.
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisGyroscopes.

Definition at line 147 of file FakeIMU.cpp.

◆ getThreeAxisGyroscopeName()

bool FakeIMU::getThreeAxisGyroscopeName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Parameters

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

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisGyroscopes.

Definition at line 137 of file FakeIMU.cpp.

◆ getThreeAxisGyroscopeStatus()

yarp::dev::MAS_status FakeIMU::getThreeAxisGyroscopeStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Parameters

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

Implements yarp::dev::IThreeAxisGyroscopes.

Definition at line 132 of file FakeIMU.cpp.

◆ getThreeAxisLinearAccelerometerFrameName()

bool FakeIMU::getThreeAxisLinearAccelerometerFrameName	(	size_t	sens_index,
		std::string &	frameName
	)		const

overridevirtual

Get the name of the frame of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisLinearAccelerometers.

Definition at line 180 of file FakeIMU.cpp.

◆ getThreeAxisLinearAccelerometerMeasure()

bool FakeIMU::getThreeAxisLinearAccelerometerMeasure	(	size_t	sens_index,
		yarp::sig::Vector &	out,
		double &	timestamp
	)		const

overridevirtual

Get the last reading of the specified sensor.

Parameters

[in]	sens_index	The index of the specified sensor (should be between 0 and getNrOfThreeAxisLinearAccelerometers()-1).
[out]	out	The requested measure. The vector should be 3-dimensional. The measure is expressed in meters^2/seconds.
[out]	timestamp	The timestamp of the requested measure, expressed in seconds.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisLinearAccelerometers.

Definition at line 185 of file FakeIMU.cpp.

◆ getThreeAxisLinearAccelerometerName()

bool FakeIMU::getThreeAxisLinearAccelerometerName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisLinearAccelerometers.

Definition at line 175 of file FakeIMU.cpp.

◆ getThreeAxisLinearAccelerometerStatus()

yarp::dev::MAS_status FakeIMU::getThreeAxisLinearAccelerometerStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Implements yarp::dev::IThreeAxisLinearAccelerometers.

Definition at line 170 of file FakeIMU.cpp.

◆ getThreeAxisMagnetometerFrameName()

bool FakeIMU::getThreeAxisMagnetometerFrameName	(	size_t	sens_index,
		std::string &	frameName
	)		const

overridevirtual

Get the name of the frame of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisMagnetometers.

Definition at line 218 of file FakeIMU.cpp.

◆ getThreeAxisMagnetometerMeasure()

bool FakeIMU::getThreeAxisMagnetometerMeasure	(	size_t	sens_index,
		yarp::sig::Vector &	out,
		double &	timestamp
	)		const

overridevirtual

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.

Implements yarp::dev::IThreeAxisMagnetometers.

Definition at line 223 of file FakeIMU.cpp.

◆ getThreeAxisMagnetometerName()

bool FakeIMU::getThreeAxisMagnetometerName	(	size_t	sens_index,
		std::string &	name
	)		const

overridevirtual

Get the name of the specified sensor.

Returns: false if an error occurred, true otherwise.

Implements yarp::dev::IThreeAxisMagnetometers.

Definition at line 213 of file FakeIMU.cpp.

◆ getThreeAxisMagnetometerStatus()

yarp::dev::MAS_status FakeIMU::getThreeAxisMagnetometerStatus ( size_t sens_index ) const

overridevirtual

Get the status of the specified sensor.

Implements yarp::dev::IThreeAxisMagnetometers.

Definition at line 208 of file FakeIMU.cpp.

◆ open()

bool FakeIMU::open ( yarp::os::Searchable & config )

overridevirtual

Open the DeviceDriver.

Parameters

config is a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).

Returns: true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 52 of file FakeIMU.cpp.

◆ operator=() [1/2]

FakeIMU & FakeIMU::operator= ( const FakeIMU & )

delete

◆ operator=() [2/2]

FakeIMU & FakeIMU::operator= ( FakeIMU && )

delete

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

src/devices/fake/fakeIMU/FakeIMU.h
src/devices/fake/fakeIMU/FakeIMU.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FakeIMU() [1/3]

◆ FakeIMU() [2/3]

◆ FakeIMU() [3/3]

◆ ~FakeIMU()

Member Function Documentation

◆ close()

◆ getNrOfOrientationSensors()

◆ getNrOfThreeAxisGyroscopes()

◆ getNrOfThreeAxisLinearAccelerometers()

◆ getNrOfThreeAxisMagnetometers()

◆ getOrientationSensorFrameName()

◆ getOrientationSensorMeasureAsRollPitchYaw()

◆ getOrientationSensorName()

◆ getOrientationSensorStatus()

◆ getThreeAxisGyroscopeFrameName()

◆ getThreeAxisGyroscopeMeasure()

◆ getThreeAxisGyroscopeName()

◆ getThreeAxisGyroscopeStatus()

◆ getThreeAxisLinearAccelerometerFrameName()

◆ getThreeAxisLinearAccelerometerMeasure()

◆ getThreeAxisLinearAccelerometerName()

◆ getThreeAxisLinearAccelerometerStatus()

◆ getThreeAxisMagnetometerFrameName()

◆ getThreeAxisMagnetometerMeasure()

◆ getThreeAxisMagnetometerName()

◆ getThreeAxisMagnetometerStatus()

◆ open()

◆ operator=() [1/2]

◆ operator=() [2/2]