Class inertialsim::sensors::MagnetometerSpecification::Bias¶

ClassList > inertialsim > sensors > MagnetometerSpecification > Bias

Magnetometer bias specification.More...

#include <magnetometer_specification.h>

Inherits the following classes: inertialsim::sensors::SensorSpecification::Bias

Public Functions¶

Type	Name
	Bias (int axes) Construct with default (zero) values.

Public Functions inherited from inertialsim::sensors::SensorSpecification::Bias¶

See inertialsim::sensors::SensorSpecification::Bias

Type	Name
	Bias (int axes) Construct with default (zero) values.
const Parameter< SpecificationArray > &	fixed () const Get fixed bias.
const Parameter< SpecificationArray > &	repeatability () const Get bias repeatability (random component).
void	set_fixed (const Parameter< T > & specification) Set fixed bias.
void	set_repeatability (const Parameter< T > & specification) Set bias repeatability.
void	set_temperature (const Parameter< T > & specification) Set temperature bias.
const Parameter< SpecificationArray > &	temperature () const Get temperature-dependent bias coefficient.
virtual	~Bias () = default

Protected Attributes inherited from inertialsim::sensors::SensorSpecification::Bias¶

See inertialsim::sensors::SensorSpecification::Bias

Type	Name
int	axes_
Parameter< SpecificationArray >	fixed_
Parameter< SpecificationArray >	repeatability_
Parameter< SpecificationArray >	temperature_

Protected Functions¶

Type	Name
virtual void	set_fixed_impl (const Parameter< SpecificationArray > & specification) override Implementation of fixed bias setter. Must validate units and set fixed_ member.
virtual void	set_repeatability_impl (const Parameter< SpecificationArray > & specification) override Implementation of repeatability setter. Must validate units and set repeatability_ member.
virtual void	set_temperature_impl (const Parameter< SpecificationArray > & specification) override Implementation of temperature bias setter. Must validate units and set temperature_ member.

Protected Functions inherited from inertialsim::sensors::SensorSpecification::Bias¶

See inertialsim::sensors::SensorSpecification::Bias

Type	Name
virtual void	set_fixed_impl (const Parameter< SpecificationArray > & specification) = 0 Implementation of fixed bias setter. Must validate units and set fixed_ member.
virtual void	set_repeatability_impl (const Parameter< SpecificationArray > & specification) = 0 Implementation of repeatability setter. Must validate units and set repeatability_ member.
virtual void	set_temperature_impl (const Parameter< SpecificationArray > & specification) = 0 Implementation of temperature bias setter. Must validate units and set temperature_ member.

Detailed Description¶

Specification of magnetometer bias including fixed bias (systematic offset), bias repeatability (random turn-on to turn-on variations), and temperature- dependent bias coefficient.

Public Functions Documentation¶

function Bias¶

Construct with default (zero) values.

inline explicit inertialsim::sensors::MagnetometerSpecification::Bias::Bias (
    int axes
)

Parameters:

axes Number of magnetometer axes (typically 3 for tri-axial).

Protected Functions Documentation¶

function set_fixed_impl¶

Implementation of fixed bias setter. Must validate units and set fixed_ member.

virtual void inertialsim::sensors::MagnetometerSpecification::Bias::set_fixed_impl (
    const Parameter < SpecificationArray > & specification
) override

Implements inertialsim::sensors::SensorSpecification::Bias::set_fixed_impl

function set_repeatability_impl¶

Implementation of repeatability setter. Must validate units and set repeatability_ member.

virtual void inertialsim::sensors::MagnetometerSpecification::Bias::set_repeatability_impl (
    const Parameter < SpecificationArray > & specification
) override

Implements inertialsim::sensors::SensorSpecification::Bias::set_repeatability_impl

function set_temperature_impl¶

Implementation of temperature bias setter. Must validate units and set temperature_ member.

virtual void inertialsim::sensors::MagnetometerSpecification::Bias::set_temperature_impl (
    const Parameter < SpecificationArray > & specification
) override

Implements inertialsim::sensors::SensorSpecification::Bias::set_temperature_impl

The documentation for this class was generated from the following file cpp/include/inertialsim/sensors/magnetometer_specification.h