Class inertialsim::sensors::SensorSpecification

ClassList > inertialsim > sensors > SensorSpecification

Base sensor specification class. More...

• #include <specification.h>

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

Classes

Type	Name
class	Bias Bias specification.
class	DataInterface Data interface specification.
class	InputLimits Input limits specification.
class	Misalignment Misalignment specification.
class	Noise Noise specification.
class	ScaleFactor Scale factor specification.

Public Attributes

Type	Name
std::string	manufacturer = ""
std::string	model = ""
std::string	version = ""

Public Functions

Type	Name
	SensorSpecification (int axes=geometry::kNumCartesianAxes) Construct with specified number of axes.
int	axes () const Get number of sensor axes.
virtual Bias &	bias () = 0 Get bias specification.
virtual const Bias &	bias () const = 0
virtual DataInterface &	data_interface () = 0 Get data interface specification.
virtual const DataInterface &	data_interface () const = 0
virtual InputLimits &	input_limits () = 0 Get input limits specification.
virtual const InputLimits &	input_limits () const = 0
Misalignment &	misalignment () Get misalignment specification.
const Misalignment &	misalignment () const
virtual Noise &	noise () = 0 Get noise specification.
virtual const Noise &	noise () const = 0
ScaleFactor &	scale_factor () Get scale factor specification.
const ScaleFactor &	scale_factor () const
virtual	~SensorSpecification () = default

Detailed Description

Abstract base class containing nested specification types for sensor data interface, input limits, noise, bias, scale factor, and misalignment.

Public Attributes Documentation

variable manufacturer

std::string inertialsim::sensors::SensorSpecification::manufacturer;

---

variable model

std::string inertialsim::sensors::SensorSpecification::model;

---

variable version

std::string inertialsim::sensors::SensorSpecification::version;

---

Public Functions Documentation

function SensorSpecification

Construct with specified number of axes.

inline explicit inertialsim::sensors::SensorSpecification::SensorSpecification (
    int axes=geometry::kNumCartesianAxes
) 

Parameters:

• axes Number of sensor axes (default: 3 for tri-axial).

---

function axes

Get number of sensor axes.

inline int inertialsim::sensors::SensorSpecification::axes () const

Returns:

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

---

function bias [½]

Get bias specification.

virtual Bias & inertialsim::sensors::SensorSpecification::bias () = 0

Returns:

Reference to bias specification.

---

function bias [2/2]

virtual const Bias & inertialsim::sensors::SensorSpecification::bias () const = 0

---

function data_interface [½]

Get data interface specification.

virtual DataInterface & inertialsim::sensors::SensorSpecification::data_interface () = 0

Returns:

Reference to data interface specification.

---

function data_interface [2/2]

virtual const DataInterface & inertialsim::sensors::SensorSpecification::data_interface () const = 0

---

function input_limits [½]

Get input limits specification.

virtual InputLimits & inertialsim::sensors::SensorSpecification::input_limits () = 0

Returns:

Reference to input limits specification.

---

function input_limits [2/2]

virtual const InputLimits & inertialsim::sensors::SensorSpecification::input_limits () const = 0

---

function misalignment [½]

Get misalignment specification.

inline Misalignment & inertialsim::sensors::SensorSpecification::misalignment () 

Returns:

Reference to misalignment specification.

---

function misalignment [2/2]

inline const Misalignment & inertialsim::sensors::SensorSpecification::misalignment () const

---

function noise [½]

Get noise specification.

virtual Noise & inertialsim::sensors::SensorSpecification::noise () = 0

Returns:

Reference to noise specification.

---

function noise [2/2]

virtual const Noise & inertialsim::sensors::SensorSpecification::noise () const = 0

---

function scale_factor [½]

Get scale factor specification.

inline ScaleFactor & inertialsim::sensors::SensorSpecification::scale_factor () 

Returns:

Reference to scale factor specification.

---

function scale_factor [2/2]

inline const ScaleFactor & inertialsim::sensors::SensorSpecification::scale_factor () const

---

function ~SensorSpecification

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

---

---

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