Class inertialsim::sensors::SensorSpecification::DataInterface¶

ClassList > inertialsim > sensors > SensorSpecification > DataInterface

Data interface specification. More...

#include <specification.h>

Inherited by the following classes: inertialsim::sensors::InertialSensorSpecification::DataInterface, inertialsim::sensors::MagnetometerSpecification::DataInterface

Public Functions¶

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¶

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

Protected Functions¶

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 of the sensor, including sample rate and quantization.

Public Functions Documentation¶

function DataInterface¶

Construct with default values.

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

Parameters:

axes Number of sensor axes.

function quantization¶

Get current quantization (if set).

inline const std::optional< Parameter < SpecificationArray > > & inertialsim::sensors::SensorSpecification::DataInterface::quantization () const

Returns:

Optional parameter with quantization, or empty if not set.

function sample_rate¶

Get current sample rate.

inline const Parameter < double > & inertialsim::sensors::SensorSpecification::DataInterface::sample_rate () const

Returns:

Parameter with sample rate in Hz.

function set_quantization [½]¶

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

function set_quantization [2/2]¶

Clear quantization.

inline void inertialsim::sensors::SensorSpecification::DataInterface::set_quantization (
    std::nullopt_t
)

Parameters:

param std::nullopt to clear quantization.

function set_sample_rate¶

Set sample rate.

void inertialsim::sensors::SensorSpecification::DataInterface::set_sample_rate (
    const Parameter < double > & specification
)

Parameters:

specification Parameter with units of Hz.

Exception:

std::invalid_argument if units are invalid or value is non-positive.

function ~DataInterface¶

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

Protected Attributes Documentation¶

variable axes_¶

int inertialsim::sensors::SensorSpecification::DataInterface::axes_;

variable quantization_¶

std::optional<Parameter<SpecificationArray> > inertialsim::sensors::SensorSpecification::DataInterface::quantization_;

variable sample_rate_¶

Parameter<double> inertialsim::sensors::SensorSpecification::DataInterface::sample_rate_;

Protected Functions Documentation¶

function set_quantization_impl¶

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

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

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