Class inertialsim::sensors::SensorSpecification::InputLimits¶

ClassList > inertialsim > sensors > SensorSpecification > InputLimits

Input limits specification. More...

#include <specification.h>

Inherited by the following classes: inertialsim::sensors::AccelerometerSpecification::InputLimits, inertialsim::sensors::GyroSpecification::InputLimits, inertialsim::sensors::MagnetometerSpecification::InputLimits

Public Functions¶

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¶

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

Protected Functions¶

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¶

The extreme values of the input (negative and positive) within which performance is of the specified accuracy. Simulated outputs outside of this range are truncated to these limits.

Public Functions Documentation¶

function InputLimits¶

Construct with default (unlimited) values.

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

Initializes minimum to -∞ and maximum to +∞.

Parameters:

axes Number of sensor axes.

function maximum¶

Get maximum input limit.

inline const Parameter < SpecificationArray > & inertialsim::sensors::SensorSpecification::InputLimits::maximum () const

Returns:

Parameter with maximum input values.

function minimum¶

Get minimum input limit.

inline const Parameter < SpecificationArray > & inertialsim::sensors::SensorSpecification::InputLimits::minimum () const

Returns:

Parameter with minimum input values.

function set_maximum¶

Set maximum input limit.

template<typename T>
inline void inertialsim::sensors::SensorSpecification::InputLimits::set_maximum (
    const Parameter < T > & specification
)

Parameters:

specification Parameter with appropriate units for the sensor type.

Exception:

std::invalid_argument if units are invalid.

function set_minimum¶

Set minimum input limit.

template<typename T>
inline void inertialsim::sensors::SensorSpecification::InputLimits::set_minimum (
    const Parameter < T > & specification
)

Parameters:

specification Parameter with appropriate units for the sensor type.

Exception:

std::invalid_argument if units are invalid.

function ~InputLimits¶

virtual inertialsim::sensors::SensorSpecification::InputLimits::~InputLimits () = default

Protected Attributes Documentation¶

variable axes_¶

int inertialsim::sensors::SensorSpecification::InputLimits::axes_;

variable maximum_¶

Parameter<SpecificationArray> inertialsim::sensors::SensorSpecification::InputLimits::maximum_;

variable minimum_¶

Parameter<SpecificationArray> inertialsim::sensors::SensorSpecification::InputLimits::minimum_;

Protected Functions Documentation¶

function set_maximum_impl¶

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

virtual void inertialsim::sensors::SensorSpecification::InputLimits::set_maximum_impl (
    const Parameter < SpecificationArray > & specification
) = 0

function set_minimum_impl¶

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

virtual void inertialsim::sensors::SensorSpecification::InputLimits::set_minimum_impl (
    const Parameter < SpecificationArray > & specification
) = 0

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