Class inertialsim::sensors::INSSpecification::DataInterface

ClassList > inertialsim > sensors > INSSpecification > DataInterface

INS data interface specification.More...

• #include <ins_specification.h>

Public Functions

Type	Name
	DataInterface () Construct with default values.
const Parameter< double > &	sample_rate () const Get current sample rate.
void	set_sample_rate (const Parameter< double > & rate) Set sample rate.

Detailed Description

The data interface includes the sample rate at which the sensor transmits new data.

Public Functions Documentation

function DataInterface

Construct with default values.

inline inertialsim::sensors::INSSpecification::DataInterface::DataInterface () 

Initializes sample rate to 100 Hz.

---

function sample_rate

Get current sample rate.

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

Returns:

Parameter with sample rate in Hz.

---

function set_sample_rate

Set sample rate.

void inertialsim::sensors::INSSpecification::DataInterface::set_sample_rate (
    const Parameter < double > & rate
) 

Parameters:

• rate Parameter with units of Hz.

Exception:

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

---

---

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