sdf::v10::Magnetometer Class Reference

Magnetometer contains information about a magnetometer sensor. More...

#include <Magnetometer.hh>

Public Member Functions
	Magnetometer ()
	Default constructor. More...
	Magnetometer (const Magnetometer &_magnetometer)
	Copy constructor. More...
	Magnetometer (Magnetometer &&_magnetometer) noexcept
	Move constructor. More...
	~Magnetometer ()
	Destructor. More...
sdf::ElementPtr	Element () const
	Get a pointer to the SDF element that was used during load. More...
Errors	Load (ElementPtr _sdf)
	Load the magnetometer based on an element pointer. More...
bool	operator!= (const Magnetometer &_mag) const
	Return true this Magnetometer object does not contain the same values as the passed in parameter. More...
Magnetometer &	operator= (const Magnetometer &_magnetometer)
	Assignment operator. More...
Magnetometer &	operator= (Magnetometer &&_magnetometer)
	Move assignment operator. More...
bool	operator== (const Magnetometer &_mag) const
	Return true if both Magnetometer objects contain the same values. More...
void	SetXNoise (const Noise &_noise)
	Set the noise values related to the body-frame x axis. More...
void	SetYNoise (const Noise &_noise)
	Set the noise values related to the body-frame y axis. More...
void	SetZNoise (const Noise &_noise)
	Set the noise values related to the body-frame z axis. More...
const Noise &	XNoise () const
	Get the noise values related to the body-frame x axis. More...
const Noise &	YNoise () const
	Get the noise values related to the body-frame y axis. More...
const Noise &	ZNoise () const
	Get the noise values related to the body-frame z axis. More...

Detailed Description

Magnetometer contains information about a magnetometer sensor.

This sensor can be attached to a link.

Constructor & Destructor Documentation

Magnetometer() [1/3]

sdf::v10::Magnetometer::Magnetometer

(

)

Default constructor.

Magnetometer() [2/3]

sdf::v10::Magnetometer::Magnetometer

(

const Magnetometer &

_magnetometer

)

Copy constructor.

Parameters

[in]

_magnetometer

Magnetometer to copy.

Magnetometer() [3/3]

sdf::v10::Magnetometer::Magnetometer ( Magnetometer &&  _magnetometer )

noexcept

Move constructor.

Parameters

[in]

_magnetometer

Magnetometer to move.

~Magnetometer()

sdf::v10::Magnetometer::~Magnetometer

(

)

Destructor.

Member Function Documentation

Element()

sdf::ElementPtr sdf::v10::Magnetometer::Element

(

)

const

Get a pointer to the SDF element that was used during load.

Returns

SDF element pointer. The value will be nullptr if Load has not been called.

Load()

Errors sdf::v10::Magnetometer::Load

(

ElementPtr

_sdf

)

Load the magnetometer based on an element pointer.

This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.

Parameters

[in]

_sdf

The SDF Element pointer

Returns

Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

operator!=()

bool sdf::v10::Magnetometer::operator!=

(

const Magnetometer &

_mag

)

const

Return true this Magnetometer object does not contain the same values as the passed in parameter.

Parameters

[_in]

_mag Magnetometer value to compare. \returen True if 'this' != _mag.

operator=() [1/2]

Magnetometer& sdf::v10::Magnetometer::operator=

(

const Magnetometer &

_magnetometer

)

Assignment operator.

Parameters

[in]

_magnetometer

The magnetometer to set values from.

Returns

*this

operator=() [2/2]

Magnetometer& sdf::v10::Magnetometer::operator=

(

Magnetometer &&

_magnetometer

)

Move assignment operator.

Parameters

[in]

_magnetometer

The magnetometer to set values from.

Returns

*this

operator==()

bool sdf::v10::Magnetometer::operator==

(

const Magnetometer &

_mag

)

const

Return true if both Magnetometer objects contain the same values.

Parameters

[_in]

_mag Magnetometer value to compare. \returen True if 'this' == _mag.

SetXNoise()

void sdf::v10::Magnetometer::SetXNoise

(

const Noise &

_noise

)

Set the noise values related to the body-frame x axis.

Parameters

[in]

_noise

Noise values for the x axis.

SetYNoise()

void sdf::v10::Magnetometer::SetYNoise

(

const Noise &

_noise

)

Set the noise values related to the body-frame y axis.

Parameters

[in]

_noise

Noise values for the y axis.

SetZNoise()

void sdf::v10::Magnetometer::SetZNoise

(

const Noise &

_noise

)

Set the noise values related to the body-frame z axis.

Parameters

[in]

_noise

Noise values for the z axis.

XNoise()

const Noise& sdf::v10::Magnetometer::XNoise

(

)

const

Get the noise values related to the body-frame x axis.

Returns

Noise values for the x axis.

YNoise()

const Noise& sdf::v10::Magnetometer::YNoise

(

)

const

Get the noise values related to the body-frame y axis.

Returns

Noise values for the y axis.

ZNoise()

const Noise& sdf::v10::Magnetometer::ZNoise

(

)

const

Get the noise values related to the body-frame z axis.

Returns

Noise values for the z axis.

---

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

• Magnetometer.hh