open_simulation_interface  master (2c3953b)
osi3::Route Struct Reference

A route in the road network. More...

Collaboration diagram for osi3::Route:

Classes

struct  LogicalLaneSegment
 A segment of a logical lane. More...
 
struct  RouteSegment
 A segment of a route. More...
 

Public Attributes

optional Identifier route_id = 1
 The unique id of the route. More...
 
repeated RouteSegment route_segment = 2
 Route segments that form the route of an agent. More...
 

Detailed Description

A route in the road network.

A route is an e.g. planned or suggested path for an agent to travel from one location to another within the road network. It is composed of a list of route segments, which form a continuous path through the road network and should be traversed in the order they are listed. The route allows the simulation environment to provide agents with high level path information, similar to that of a map or a navigation system, without the need for the agent model to perform complex path planning on its own. This allows for an efficient control of the agent's general direction, while simultaneously giving it enough freedom on how to traverse the path.

Example

The example below shows the route of a vehicle.

Route

The route is composed of three route segments RS1-3, each indicated by a yellow outline. Two of the route segments (RS2 and RS3) only contain a single logical lane segment (highlighted in blue), while RS1 is composed of three logical lane segments (green, blue and red).

Member Data Documentation

◆ route_id

optional Identifier osi3::Route::route_id = 1

The unique id of the route.

Note
This field is mandatory.
This id must be unique within all route messages exchanged with one traffic participant.
Rules\n\code{.unparsed}
is_set

◆ route_segment

repeated RouteSegment osi3::Route::route_segment = 2

Route segments that form the route of an agent.

Consecutive segments should be connected without gaps, meaning that the two of them should form a continuous area.


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