Class inertialsim::sensors::GyroSpecification::DataInterface¶

ClassList > inertialsim > sensors > GyroSpecification > DataInterface

Gyro data interface specification.More...

#include <gyro_specification.h>

Inherits the following classes: inertialsim::sensors::InertialSensorSpecification::DataInterface

Public Functions¶

Type	Name
	DataInterface (int axes) Construct with default values.

Public Functions inherited from inertialsim::sensors::InertialSensorSpecification::DataInterface¶

See inertialsim::sensors::InertialSensorSpecification::DataInterface

Type	Name
	DataInterface (int axes) Construct with default values.
const std::optional< Parameter< SpecificationArray > > &	delta_quantization () const Get delta quantization (if set).
const Parameter< double > &	delta_sample_rate () const Get delta sample rate.
int	delta_stride () const Get delta stride (output decimation factor).
void	set_delta_quantization (const Parameter< T > & param)
void	set_delta_quantization (std::nullopt_t) Clear delta (integrated) output quantization.
void	set_delta_sample_rate (const Parameter< double > & param) Set delta sample rate.

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

See inertialsim::sensors::SensorSpecification::DataInterface

Type	Name
	DataInterface (int axes) Construct with default values.
const std::optional< Parameter< SpecificationArray > > &	quantization () const Get current quantization (if set).
const Parameter< double > &	sample_rate () const Get current sample rate.
void	set_quantization (const Parameter< T > & specification)
void	set_quantization (std::nullopt_t) Clear quantization.
void	set_sample_rate (const Parameter< double > & specification) Set sample rate.
virtual	~DataInterface () = default

Protected Attributes inherited from inertialsim::sensors::InertialSensorSpecification::DataInterface¶

See inertialsim::sensors::InertialSensorSpecification::DataInterface

Type	Name
std::optional< Parameter< SpecificationArray > >	delta_quantization_
Parameter< double >	delta_sample_rate_
int	delta_stride_ = `{}`

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

See inertialsim::sensors::SensorSpecification::DataInterface

Type	Name
int	axes_
std::optional< Parameter< SpecificationArray > >	quantization_
Parameter< double >	sample_rate_

Protected Functions¶

Type	Name
virtual void	set_delta_quantization_impl (const Parameter< SpecificationArray > & param) override Implementation of delta quantization setter. Must validate units and set delta_quantization_ member.
virtual void	set_quantization_impl (const Parameter< SpecificationArray > & specification) override Implementation of quantization setter. Must validate units and set quantization_ member.

Protected Functions inherited from inertialsim::sensors::InertialSensorSpecification::DataInterface¶

See inertialsim::sensors::InertialSensorSpecification::DataInterface

Type	Name
virtual void	set_delta_quantization_impl (const Parameter< SpecificationArray > & param) = 0 Implementation of delta quantization setter. Must validate units and set delta_quantization_ member.

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

See inertialsim::sensors::SensorSpecification::DataInterface

Type	Name
virtual void	set_quantization_impl (const Parameter< SpecificationArray > & specification) = 0 Implementation of quantization setter. Must validate units and set quantization_ member.

Detailed Description¶

The data interface includes the sample rate at which the sensor transmits new data, and digital quantization effects in the raw output. Also supports delta (integrated) output quantization.

Public Functions Documentation¶

function DataInterface¶

Construct with default values.

inline explicit inertialsim::sensors::GyroSpecification::DataInterface::DataInterface (
    int axes
)

Initializes sample rate to 100 Hz and quantization effects to zero.

Parameters:

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

Protected Functions Documentation¶

function set_delta_quantization_impl¶

Implementation of delta quantization setter. Must validate units and set delta_quantization_ member.

virtual void inertialsim::sensors::GyroSpecification::DataInterface::set_delta_quantization_impl (
    const Parameter < SpecificationArray > & param
) override

Implements inertialsim::sensors::InertialSensorSpecification::DataInterface::set_delta_quantization_impl

function set_quantization_impl¶

Implementation of quantization setter. Must validate units and set quantization_ member.

virtual void inertialsim::sensors::GyroSpecification::DataInterface::set_quantization_impl (
    const Parameter < SpecificationArray > & specification
) override

Implements inertialsim::sensors::SensorSpecification::DataInterface::set_quantization_impl

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