Magnetometer contains information about a magnetometer sensor.
More...
#include <Magnetometer.hh>
Magnetometer contains information about a magnetometer sensor.
This sensor can be attached to a link.
◆ Magnetometer() [1/3]
sdf::v9::Magnetometer::Magnetometer |
( |
| ) |
|
◆ Magnetometer() [2/3]
sdf::v9::Magnetometer::Magnetometer |
( |
const Magnetometer & |
_magnetometer | ) |
|
Copy constructor.
- Parameters
-
◆ Magnetometer() [3/3]
sdf::v9::Magnetometer::Magnetometer |
( |
Magnetometer && |
_magnetometer | ) |
|
|
noexcept |
Move constructor.
- Parameters
-
◆ ~Magnetometer()
sdf::v9::Magnetometer::~Magnetometer |
( |
| ) |
|
◆ Element()
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()
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
-
- 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::v9::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]
Assignment operator.
- Parameters
-
[in] | _magnetometer | The magnetometer to set values from. |
- Returns
- *this
◆ operator=() [2/2]
Move assignment operator.
- Parameters
-
[in] | _magnetometer | The magnetometer to set values from. |
- Returns
- *this
◆ operator==()
bool sdf::v9::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::v9::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::v9::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::v9::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::v9::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::v9::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::v9::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: