osi3::ExternalReference Struct Reference

References to external objects. More...

Collaboration diagram for osi3::ExternalReference:

Public Attributes

optional string reference = 1
 The source of the external references. More...
 
optional string type = 2
 The type of the external references. More...
 
repeated string identifier = 3
 The external identifier reference value. More...
 

Detailed Description

References to external objects.

The external reference is an optional recommendation to refer to objects defined outside of OSI. This could be other OpenX standards, 3rd-party standards or user-defined objects.

Note
ExternalReference is optional and can be left empty.

Member Data Documentation

◆ reference

optional string osi3::ExternalReference::reference = 1

The source of the external references.

Defines the original source of an object as uniquely identifiable reference. In case of using GroundTruth::map_reference or GroundTruth::model_reference, the reference can be left empty. If not otherwise required, an URI is suggested. The syntax should follow RFC 3986.

◆ type

optional string osi3::ExternalReference::type = 2

The type of the external references.

Mandatory value describing the type of the original source.

For OpenX/ASAM standards it is specified as follows:

  • net.asam.opendrive
  • net.asam.openscenario

For third-party standards and user-defined objects, reverse domain name notation with lower-case type field is recommended to guarantee unique and interoperable identification.

Rules
is_set

◆ identifier

repeated string osi3::ExternalReference::identifier = 3

The external identifier reference value.

The repeated string is chosen as a common description of the external identifier, because a variety of identifier types could be involved .

For example, referencing a unique lane in OpenDRIVE requires the following identifiers:

  • RoadId: String
  • S-Value of LaneSection: Double
  • LaneId: Int
Note
The detailed description of the identifiers and how they are used for referencing external objects is given in the individual messages where the external identifier is used.
See also
EnvironmentalConditions::source_reference
Lane::source_reference
LaneBoundary::source_reference
StationaryObject::source_reference
MovingObject::source_reference
RoadMarking::source_reference
TrafficLight::source_reference
TrafficSign::source_reference

  • osi_common.proto