Class inertialsim::sensors::MagnetometerSpecification::InputLimits¶

ClassList > inertialsim > sensors > MagnetometerSpecification > InputLimits

Magnetometer input limits specification.More...

#include <magnetometer_specification.h>

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

Public Functions¶

Type	Name
	InputLimits (int axes) Construct with default (unlimited) values.

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

See inertialsim::sensors::SensorSpecification::InputLimits

Type	Name
	InputLimits (int axes) Construct with default (unlimited) values.
const Parameter< SpecificationArray > &	maximum () const Get maximum input limit.
const Parameter< SpecificationArray > &	minimum () const Get minimum input limit.
void	set_maximum (const Parameter< T > & specification) Set maximum input limit.
void	set_minimum (const Parameter< T > & specification) Set minimum input limit.
virtual	~InputLimits () = default

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

See inertialsim::sensors::SensorSpecification::InputLimits

Type	Name
int	axes_
Parameter< SpecificationArray >	maximum_
Parameter< SpecificationArray >	minimum_

Protected Functions¶

Type	Name
virtual void	set_maximum_impl (const Parameter< SpecificationArray > & specification) override Implementation of maximum setter. Must validate units and set maximum_ member.
virtual void	set_minimum_impl (const Parameter< SpecificationArray > & specification) override Implementation of minimum setter. Must validate units and set minimum_ member.

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

See inertialsim::sensors::SensorSpecification::InputLimits

Type	Name
virtual void	set_maximum_impl (const Parameter< SpecificationArray > & specification) = 0 Implementation of maximum setter. Must validate units and set maximum_ member.
virtual void	set_minimum_impl (const Parameter< SpecificationArray > & specification) = 0 Implementation of minimum setter. Must validate units and set minimum_ member.

Detailed Description¶

Specifies the range of magnetic field inputs within which the sensor operates accurately. Outputs are clamped/truncated to these limits.

Public Functions Documentation¶

function InputLimits¶

Construct with default (unlimited) values.

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

Parameters:

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

Protected Functions Documentation¶

function set_maximum_impl¶

Implementation of maximum setter. Must validate units and set maximum_ member.

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

Implements inertialsim::sensors::SensorSpecification::InputLimits::set_maximum_impl

function set_minimum_impl¶

Implementation of minimum setter. Must validate units and set minimum_ member.

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

Implements inertialsim::sensors::SensorSpecification::InputLimits::set_minimum_impl

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