Public Member Functions | List of all members
sdf::v12::Magnetometer Class Reference

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

#include <Magnetometer.hh>

Public Member Functions

 Magnetometer ()
 Default constructor. 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...
 
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 NoiseXNoise () const
 Get the noise values related to the body-frame x axis. More...
 
const NoiseYNoise () const
 Get the noise values related to the body-frame y axis. More...
 
const NoiseZNoise () 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()

sdf::v12::Magnetometer::Magnetometer ( )

Default constructor.

Member Function Documentation

◆ Element()

sdf::ElementPtr sdf::v12::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::v12::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]_sdfThe 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::v12::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==()

bool sdf::v12::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::v12::Magnetometer::SetXNoise ( const Noise _noise)

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

Parameters
[in]_noiseNoise values for the x axis.

◆ SetYNoise()

void sdf::v12::Magnetometer::SetYNoise ( const Noise _noise)

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

Parameters
[in]_noiseNoise values for the y axis.

◆ SetZNoise()

void sdf::v12::Magnetometer::SetZNoise ( const Noise _noise)

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

Parameters
[in]_noiseNoise values for the z axis.

◆ XNoise()

const Noise& sdf::v12::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::v12::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::v12::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: