point_one::fusion_engine::messages::MeasurementTimestamps Struct Reference

The time of applicability for an incoming sensor measurement. More...

#include <point_one/fusion_engine/messages/measurements.h>

Public Attributes

Timestamp measurement_time
 The measurement time of applicability, if available, in a user-specified time base. More...
 
SystemTimeSource measurement_time_source = SystemTimeSource::INVALID
 The source for measurement_time. More...
 
Timestamp p1_time
 The P1 time corresponding with the measurement time of applicability, if available. More...
 

Detailed Description

The time of applicability for an incoming sensor measurement.

By convention this will be the first member of any measurement definition intended to be externally sent by the user to the device.

The measurement_time field stores time of applicability/reception for the measurement data, expressed in one of the available source time bases (see SystemTimeSource). The timestamp will be converted to P1 time automatically by FusionEngine using an internal model of P1 vs source time. The converted value will be assigned to p1_time for usage and logging purposes.

On most platforms, incoming sensor measurements are timestamped automatically by FusionEngine when they arrive. To request timestamp on arrival, set measurement_time to invalid, and set the measurement_time_source to SystemTimeSource::INVALID.

On some platforms, incoming sensor measurements may be timestamped externally by the user prior to arrival, either in GPS time (SystemTimeSource::GPS_TIME), or using a monotonic clock controlled by the user system (SystemTimeSource::SENDER_SYSTEM_TIME).

Note
Use of an external monotonic clock requires additional coordination with the target FusionEngine device.

Measurements may only be timestamped externally using P1 time (SystemTimeSource::P1_TIME) if the external system supports remote synchronization of the P1 time clock model.

Definition at line 118 of file measurements.h.

Member Data Documentation

◆ measurement_time

Timestamp point_one::fusion_engine::messages::MeasurementTimestamps::measurement_time

The measurement time of applicability, if available, in a user-specified time base.

The source of this value is specified in measurement_time_source. The timestamp will be converted to P1 time automatically before use.

Definition at line 125 of file measurements.h.

◆ measurement_time_source

SystemTimeSource point_one::fusion_engine::messages::MeasurementTimestamps::measurement_time_source = SystemTimeSource::INVALID

The source for measurement_time.

Definition at line 130 of file measurements.h.

◆ p1_time

Timestamp point_one::fusion_engine::messages::MeasurementTimestamps::p1_time

The P1 time corresponding with the measurement time of applicability, if available.

Note
Do not modify this field when sending measurements to FusionEngine. It will be populated automatically on arrival. Any previously specified value will be overwritten. To specify a known P1 time, specify the value in measurement_time and set measurement_time_source to SystemTimeSource::P1_TIME.

Definition at line 145 of file measurements.h.


The documentation for this struct was generated from the following file: