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

Classification data for a road surface marking. More...

Collaboration diagram for osi3::RoadMarking::Classification:

Public Types

enum  Type {
  TYPE_UNKNOWN = 0 , TYPE_OTHER = 1 , TYPE_PAINTED_TRAFFIC_SIGN = 2 , TYPE_SYMBOLIC_TRAFFIC_SIGN = 3 ,
  TYPE_TEXTUAL_TRAFFIC_SIGN = 4 , TYPE_GENERIC_SYMBOL = 5 , TYPE_GENERIC_LINE = 6 , TYPE_GENERIC_TEXT = 7
}
 
enum  Color {
  COLOR_UNKNOWN = 0 , COLOR_OTHER = 1 , COLOR_WHITE = 2 , COLOR_YELLOW = 3 ,
  COLOR_BLUE = 5 , COLOR_RED = 6 , COLOR_GREEN = 7 , COLOR_VIOLET = 8 ,
  COLOR_ORANGE = 9
}
 

Public Attributes

optional Type type = 1
 
optional TrafficSign::MainSign::Classification::Type traffic_main_sign_type = 2
 
optional Color monochrome_color = 3
 
optional TrafficSignValue value = 4
 
optional string value_text = 5
 
repeated Identifier assigned_lane_id = 6
 
optional bool is_out_of_service = 7
 
optional string country = 8
 
optional string country_revision = 9
 
optional string code = 10
 
optional string sub_code = 11
 

Detailed Description

Classification data for a road surface marking.

Member Enumeration Documentation

◆ Color

Definition of semantic road marking colors

Note
The color types represent the semantic classification of road markings only. They do not represent an actual visual appearance.
Enumerator
COLOR_UNKNOWN 

Color of road marking is unknown (must not be used in ground truth).

COLOR_OTHER 

Marking with another (unspecified but known) color.

COLOR_WHITE 

Marking with white color.

COLOR_YELLOW 

Marking with yellow / orange-yellow color.

COLOR_BLUE 

Marking with blue color.

COLOR_RED 

Marking with red color.

COLOR_GREEN 

Marking with green color.

COLOR_VIOLET 

Marking with violet color.

COLOR_ORANGE 

Marking with orange color.

◆ Type

Definition of road marking types.

Enumerator
TYPE_UNKNOWN 

Type of road marking is unknown (must not be used in ground truth).

TYPE_OTHER 

Other (unspecified but known) type of road marking.

TYPE_PAINTED_TRAFFIC_SIGN 

Paint on the road surface indicating a color image of a traffic sign.

TYPE_SYMBOLIC_TRAFFIC_SIGN 

Paint on the road surface indicating a monochrome logical symbol of a traffic sign (e.g. digits 50 as start of speed limit 50 or stop line for stop sign).

TYPE_TEXTUAL_TRAFFIC_SIGN 

Paint on the road surface as a character string (e.g. BUS as bus only lane).

TYPE_GENERIC_SYMBOL 

Paint on the road surface indicating a generic symbol.

TYPE_GENERIC_LINE 

Paint on the road surface indicating a generic line.

TYPE_GENERIC_TEXT 

Paint on the road surface indicating a generic character string.

Member Data Documentation

◆ assigned_lane_id

repeated Identifier osi3::RoadMarking::Classification::assigned_lane_id = 6

The ID(s) of the lane(s) that the road marking is assigned to. May be multiple if the road marking goes across multiple lanes.

Note
OSI uses singular instead of plural for repeated field names.

\rules refers_to: Lane \endrules

◆ code

optional string osi3::RoadMarking::Classification::code = 10

Code specification of the traffic sign catalog specification that identifies the actual traffic sign. This is part of the 4-tupel traffic sign catalog specification as used in OpenDRIVE.

Code identifier according to country and country revision, corresponds to the type field of OpenDRIVE.
code is only unique in combination with country and country_revision.
e.g. http://www.vzkat.de/2017/VzKat.htm

Note
Field is set if ( type == TYPE_PAINTED_TRAFFIC_SIGN or TYPE_SYMBOLIC_TRAFFIC_SIGN or TYPE_TEXTUAL_TRAFFIC_SIGN ).
Field need not be set (or set to TYPE_OTHER) if road marking type (type) does not require it.

\rules check_if this.type is_greater_than_or_equal_to 2 else do_check is_set check_if this.type is_less_than_or_equal_to 4 else do_check is_set \endrules

◆ country

optional string osi3::RoadMarking::Classification::country = 8

Country specification of the traffic sign catalog specification that identifies the actual traffic sign. This is part of the 4-tupel traffic sign catalog specification as used in OpenDRIVE.

Country is specified using the ISO 3166-1, alpha-2 code https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, or the special OpenDRIVE country for generic signs.

\rules check_if this.type is_greater_than_or_equal_to 2 else do_check is_set check_if this.type is_less_than_or_equal_to 4 else do_check is_set \endrules

◆ country_revision

optional string osi3::RoadMarking::Classification::country_revision = 9

Revision specification of the traffic sign catalog specification that identifies the actual traffic sign. This is part of the 4-tupel traffic sign catalog specification as used in OpenDRIVE.

The year the traffic rules came into force.
e.g. "2017"

Note
Field is set if ( type == TYPE_PAINTED_TRAFFIC_SIGN or TYPE_SYMBOLIC_TRAFFIC_SIGN or TYPE_TEXTUAL_TRAFFIC_SIGN ).
Field need not be set (or set to TYPE_OTHER) if road marking type (type) does not require it.

\rules check_if this.type is_greater_than_or_equal_to 2 else do_check is_set check_if this.type is_less_than_or_equal_to 4 else do_check is_set \endrules

◆ is_out_of_service

optional bool osi3::RoadMarking::Classification::is_out_of_service = 7

Boolean flag to indicate that the road marking is taken out of service. This can be achieved by visibly crossing the road marking with stripes, or completely covering a road marking making it not visible.

◆ monochrome_color

optional Color osi3::RoadMarking::Classification::monochrome_color = 3

The semantic monochrome color of the road marking.

Note
The color types represent the semantic color classification of road markings only. They do not represent an actual visual appearance.
Field need not be set (or set to COLOR_OTHER) if road marking type does not require it (e.g. for type == TYPE_PAINTED_TRAFFIC_SIGN).

\rules check_if this.type is_equal_to 2 else do_check is_set check_if this.monochrome_color is_equal_to 1 else do_check is_set \endrules

◆ sub_code

optional string osi3::RoadMarking::Classification::sub_code = 11

Sub-code specification of the traffic sign catalog specification that identifies the actual traffic sign. This is part of the 4-tupel traffic sign catalog specification as used in OpenDRIVE.

Sub-code identifier according to country, country revision and code, corresponds to the subtype field of OpenDRIVE.
sub_code is only unique in combination with country, country_revision, and code.
e.g. http://www.vzkat.de/2017/VzKat.htm

Note
Field is set if ( type == TYPE_PAINTED_TRAFFIC_SIGN or TYPE_SYMBOLIC_TRAFFIC_SIGN or TYPE_TEXTUAL_TRAFFIC_SIGN ).
Field need not be set (or set to TYPE_OTHER) if road marking type (type) does not require it.

\rules check_if this.type is_greater_than_or_equal_to 2 else do_check is_set check_if this.type is_less_than_or_equal_to 4 else do_check is_set \endrules

◆ traffic_main_sign_type

optional TrafficSign::MainSign::Classification::Type osi3::RoadMarking::Classification::traffic_main_sign_type = 2

Traffic sign as road marking (color image, monochrome image or character string).

Note
Field is set if ( type == TYPE_PAINTED_TRAFFIC_SIGN or TYPE_SYMBOLIC_TRAFFIC_SIGN or TYPE_TEXTUAL_TRAFFIC_SIGN ).
Field need not be set (or set to TYPE_OTHER) if road marking type (type) does not require it.
Attention
Deprecated: A revision is planned for version 4.0.0 to replace the type enum with a more semantically defined enumeration, with the exact sign specification being relegated to the newly introduced 4-tupel traffic sign catalog specification as used in OpenDRIVE.

\rules check_if this.type is_greater_than_or_equal_to 2 else do_check is_set check_if this.type is_less_than_or_equal_to 4 else do_check is_set \endrules

◆ type

optional Type osi3::RoadMarking::Classification::type = 1

The type of the road marking.

◆ value

optional TrafficSignValue osi3::RoadMarking::Classification::value = 4

Additional value associated with the road marking, e.g. value of the speed limit.

Note
Field need not be set if road marking type does not require it.
OSI 3 uses value_text and not TrafficSignValue for simple chars.

◆ value_text

optional string osi3::RoadMarking::Classification::value_text = 5

Additional text value as road marking, e.g. BUS, TAXI etc.

Note
Field need not be set if road marking type does not require it.

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