open_simulation_interface  v3.4.0 (2021-11-18)
osi3::DetectedEntityHeader Struct Reference

The header attributes of each detected entity. More...

Collaboration diagram for osi3::DetectedEntityHeader:

Public Types

enum  DataQualifier {
  DATA_QUALIFIER_UNKNOWN = 0 , DATA_QUALIFIER_OTHER = 1 , DATA_QUALIFIER_AVAILABLE = 2 , DATA_QUALIFIER_AVAILABLE_REDUCED = 3 ,
  DATA_QUALIFIER_NOT_AVAILABLE = 4 , DATA_QUALIFIER_BLINDNESS = 5 , DATA_QUALIFIER_TEMPORARY_AVAILABLE = 6
}
 

Public Attributes

optional Timestamp measurement_time = 1
 
optional uint64 cycle_counter = 2
 
optional DataQualifier data_qualifier = 3
 

Detailed Description

The header attributes of each detected entity.

Member Enumeration Documentation

◆ DataQualifier

Data qualifier communicates the overall availability of the interface.

Enumerator
DATA_QUALIFIER_UNKNOWN 

Unknown (must not be used in ground truth).

DATA_QUALIFIER_OTHER 

Other (unspecified but known).

DATA_QUALIFIER_AVAILABLE 

Data is available.

DATA_QUALIFIER_AVAILABLE_REDUCED 

Reduced data is available.

DATA_QUALIFIER_NOT_AVAILABLE 

Data is not available.

DATA_QUALIFIER_BLINDNESS 

Sensor is blind.

DATA_QUALIFIER_TEMPORARY_AVAILABLE 

Sensor temporary available.

Member Data Documentation

◆ cycle_counter

optional uint64 osi3::DetectedEntityHeader::cycle_counter = 2

Continuous up counter to identify the cycle.

◆ data_qualifier

optional DataQualifier osi3::DetectedEntityHeader::data_qualifier = 3

Data Qualifier expresses to what extent the content of this event can be relied on.

◆ measurement_time

optional Timestamp osi3::DetectedEntityHeader::measurement_time = 1

Time stamp at which the measurement was taken (not the time at which it was processed or at which it is transmitted) in the global synchronized time.

Note
See SensorData::timestamp and SensorData::last_measurement_time for detailed discussions on the semantics of time-related fields.

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