From 402b2af43d67cae9031e53e744b2385b902f8708 Mon Sep 17 00:00:00 2001 From: Thomas Hempen Date: Thu, 2 Nov 2023 08:33:19 +0100 Subject: [PATCH 1/7] Added changeability information --- osi_trafficsign.proto | 73 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) diff --git a/osi_trafficsign.proto b/osi_trafficsign.proto index f15aad856..a65e37dc8 100644 --- a/osi_trafficsign.proto +++ b/osi_trafficsign.proto @@ -16,10 +16,15 @@ message TrafficSignValue // Additional value associated with a traffic sign or road marking, // e.g. value of a speed limit. // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability or + // TrafficSign::SupplementarySign::Classification::cariability + // optional double value = 1; // Unit for additional value. // + // \note Changeability: Static value + // optional Unit value_unit = 2; // Unit for values on traffic sign. @@ -158,6 +163,8 @@ message TrafficSignValue // to the sign is indicated therein. The interpretation of this text is // left to a user-defined procedure. // + // \note: Changeability: Dynamic value + // optional string text = 3; } @@ -175,15 +182,21 @@ message TrafficSign // is_globally_unique // \endrules // + // \note Changeability: Static value + // optional Identifier id = 1; // Main sign, e.g. speed limit 30 km/h // + // \note Changeability: Dynamic value + // optional MainSign main_sign = 2; // Additional supplementary signs, e.g. time limits, modifying the traffic // sign. // + // \note Changeability: Dynamic value + // repeated SupplementarySign supplementary_sign = 3; @@ -210,6 +223,8 @@ message TrafficSign // derived from more than one origin segment. Multiple sources // may be added as reference as well, for example, a map and sensors. // + // \note Changeability: Static value + // repeated ExternalReference source_reference = 4; // @@ -231,10 +246,14 @@ message TrafficSign // This x-axis points from the traffic sign's image in the direction // from where a 'viewer' could see the traffic sign image. // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional BaseStationary base = 1; // The classification of the traffic sign. // + // \note Changeability: Dynamic value + // optional Classification classification = 2; // Opaque reference of an associated 3D model of the traffic sign. @@ -242,6 +261,8 @@ message TrafficSign // \note It is implementation-specific how model_references are resolved to // 3d models. // + // \note Changeability: Static value + // optional string model_reference = 3; // @@ -278,6 +299,8 @@ message TrafficSign // content (e.g., electronic sign bridge) and/or regarding its // position on the road. // + // \note Changeability: Static value + // optional Variability variability = 1; // The type of the traffic sign. @@ -288,6 +311,8 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // + // \note Changeability: Static value + // optional Type type = 2; // Additional value associated with the traffic sign, e.g. value of @@ -296,6 +321,8 @@ message TrafficSign // \note Field need not be set if traffic sign type does not require // it. // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional TrafficSignValue value = 3; // Some traffic signs have an additional arrow symbol as an @@ -325,6 +352,8 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional DirectionScope direction_scope = 4; // The IDs of the lanes that the sign is assigned to. @@ -337,6 +366,8 @@ message TrafficSign // refers_to: Lane // \endrules // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // repeated Identifier assigned_lane_id = 5; // Some traffic signs exist in two variants that have @@ -355,11 +386,15 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // + // \note Changeability: Static value + // optional bool vertically_mirrored = 6; // Boolean flag to indicate that a traffic sign is taken out of service. // This can be achieved by visibly crossing the sign or covering it completely. // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional bool is_out_of_service = 7; // Country specification of the traffic sign catalog specification @@ -371,6 +406,8 @@ message TrafficSign // https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, or the // special OpenDRIVE country for generic signs.
// + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional string country = 8; // Revision specification of the traffic sign catalog specification @@ -381,6 +418,8 @@ message TrafficSign // The year the traffic rules came into force.
// e.g. "2017" // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional string country_revision = 9; // Code specification of the traffic sign catalog specification @@ -393,6 +432,8 @@ message TrafficSign // code is only unique in combination with #country and #country_revision.
// e.g. http://www.vzkat.de/2017/VzKat.htm // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional string code = 10; // Sub-code specification of the traffic sign catalog specification @@ -406,6 +447,8 @@ message TrafficSign // and #code.
// e.g. http://www.vzkat.de/2017/VzKat.htm // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional string sub_code = 11; // Assignment of this object to logical lanes. @@ -413,6 +456,8 @@ message TrafficSign // \note OSI uses singular instead of plural for repeated field // names. // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // repeated LogicalLaneAssignment logical_lane_assignment = 12; // Definition of traffic sign types. @@ -5594,10 +5639,14 @@ message TrafficSign // supplementary traffic sign's image in the direction from where a // 'viewer' could see the supplementary traffic sign image. // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // optional BaseStationary base = 1; // The classification of the supplementary traffic sign. // + // \note Changeability: Dynamic value + // optional Classification classification = 2; // Opaque reference of an associated 3D model of the supplementary traffic sign. @@ -5605,6 +5654,8 @@ message TrafficSign // \note It is implementation-specific how model_references are resolved to // 3d models. // + // \note Changeability: Static value + // optional string model_reference = 3; // @@ -5628,6 +5679,8 @@ message TrafficSign { // Variability. // + // \note Changeability: Static value + // optional Variability variability = 1; // Definition of supplementary sign types. @@ -9081,6 +9134,8 @@ message TrafficSign // \note OSI uses singular instead of plural for repeated field // names. // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // repeated TrafficSignValue value = 3; // The IDs of the lanes that the sign is assigned to. @@ -9093,6 +9148,8 @@ message TrafficSign // refers_to: Lane // \endrules // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // repeated Identifier assigned_lane_id = 4; // This enumerator indicates a traffic actor (e.g. @@ -9105,6 +9162,8 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // repeated Actor actor = 5; // A direction arrow shown on the supplementary sign. @@ -9115,11 +9174,15 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // repeated Arrow arrow = 6; // Boolean flag to indicate that the supplementary traffic sign is taken out of service. // This can be achieved by visibly crossing the sign or covering it completely. // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // optional bool is_out_of_service = 7; // Country specification of the traffic sign catalog specification @@ -9131,6 +9194,8 @@ message TrafficSign // https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, or the // special OpenDRIVE country for generic signs.
// + // \note Changeability: Static value + // optional string country = 8; // Revision specification of the traffic sign catalog specification @@ -9141,6 +9206,8 @@ message TrafficSign // The year the traffic rules came into force.
// e.g. "2017" // + // \note Changeability: Static value + // optional string country_revision = 9; // Code specification of the traffic sign catalog specification @@ -9153,6 +9220,8 @@ message TrafficSign // code is only unique in combination with #country and #country_revision.
// e.g. http://www.vzkat.de/2017/VzKat.htm // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // optional string code = 10; // Sub-code specification of the traffic sign catalog specification @@ -9166,6 +9235,8 @@ message TrafficSign // and #code.
// e.g. http://www.vzkat.de/2017/VzKat.htm // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // optional string sub_code = 11; // Assignment of this object to logical lanes. @@ -9173,6 +9244,8 @@ message TrafficSign // \note OSI uses singular instead of plural for repeated field // names. // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // repeated LogicalLaneAssignment logical_lane_assignment = 12; // Definition of the traffic actors the supplementary sign makes From 3523c0ed3e621922af6507122f68da335327fb37 Mon Sep 17 00:00:00 2001 From: Thomas Hempen Date: Thu, 25 Jan 2024 08:20:24 +0100 Subject: [PATCH 2/7] Revert "Added changeability information" This reverts commit 402b2af43d67cae9031e53e744b2385b902f8708. --- osi_trafficsign.proto | 73 ------------------------------------------- 1 file changed, 73 deletions(-) diff --git a/osi_trafficsign.proto b/osi_trafficsign.proto index a65e37dc8..f15aad856 100644 --- a/osi_trafficsign.proto +++ b/osi_trafficsign.proto @@ -16,15 +16,10 @@ message TrafficSignValue // Additional value associated with a traffic sign or road marking, // e.g. value of a speed limit. // - // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability or - // TrafficSign::SupplementarySign::Classification::cariability - // optional double value = 1; // Unit for additional value. // - // \note Changeability: Static value - // optional Unit value_unit = 2; // Unit for values on traffic sign. @@ -163,8 +158,6 @@ message TrafficSignValue // to the sign is indicated therein. The interpretation of this text is // left to a user-defined procedure. // - // \note: Changeability: Dynamic value - // optional string text = 3; } @@ -182,21 +175,15 @@ message TrafficSign // is_globally_unique // \endrules // - // \note Changeability: Static value - // optional Identifier id = 1; // Main sign, e.g. speed limit 30 km/h // - // \note Changeability: Dynamic value - // optional MainSign main_sign = 2; // Additional supplementary signs, e.g. time limits, modifying the traffic // sign. // - // \note Changeability: Dynamic value - // repeated SupplementarySign supplementary_sign = 3; @@ -223,8 +210,6 @@ message TrafficSign // derived from more than one origin segment. Multiple sources // may be added as reference as well, for example, a map and sensors. // - // \note Changeability: Static value - // repeated ExternalReference source_reference = 4; // @@ -246,14 +231,10 @@ message TrafficSign // This x-axis points from the traffic sign's image in the direction // from where a 'viewer' could see the traffic sign image. // - // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability - // optional BaseStationary base = 1; // The classification of the traffic sign. // - // \note Changeability: Dynamic value - // optional Classification classification = 2; // Opaque reference of an associated 3D model of the traffic sign. @@ -261,8 +242,6 @@ message TrafficSign // \note It is implementation-specific how model_references are resolved to // 3d models. // - // \note Changeability: Static value - // optional string model_reference = 3; // @@ -299,8 +278,6 @@ message TrafficSign // content (e.g., electronic sign bridge) and/or regarding its // position on the road. // - // \note Changeability: Static value - // optional Variability variability = 1; // The type of the traffic sign. @@ -311,8 +288,6 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // - // \note Changeability: Static value - // optional Type type = 2; // Additional value associated with the traffic sign, e.g. value of @@ -321,8 +296,6 @@ message TrafficSign // \note Field need not be set if traffic sign type does not require // it. // - // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability - // optional TrafficSignValue value = 3; // Some traffic signs have an additional arrow symbol as an @@ -352,8 +325,6 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // - // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability - // optional DirectionScope direction_scope = 4; // The IDs of the lanes that the sign is assigned to. @@ -366,8 +337,6 @@ message TrafficSign // refers_to: Lane // \endrules // - // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability - // repeated Identifier assigned_lane_id = 5; // Some traffic signs exist in two variants that have @@ -386,15 +355,11 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // - // \note Changeability: Static value - // optional bool vertically_mirrored = 6; // Boolean flag to indicate that a traffic sign is taken out of service. // This can be achieved by visibly crossing the sign or covering it completely. // - // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability - // optional bool is_out_of_service = 7; // Country specification of the traffic sign catalog specification @@ -406,8 +371,6 @@ message TrafficSign // https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, or the // special OpenDRIVE country for generic signs.
// - // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability - // optional string country = 8; // Revision specification of the traffic sign catalog specification @@ -418,8 +381,6 @@ message TrafficSign // The year the traffic rules came into force.
// e.g. "2017" // - // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability - // optional string country_revision = 9; // Code specification of the traffic sign catalog specification @@ -432,8 +393,6 @@ message TrafficSign // code is only unique in combination with #country and #country_revision.
// e.g. http://www.vzkat.de/2017/VzKat.htm // - // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability - // optional string code = 10; // Sub-code specification of the traffic sign catalog specification @@ -447,8 +406,6 @@ message TrafficSign // and #code.
// e.g. http://www.vzkat.de/2017/VzKat.htm // - // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability - // optional string sub_code = 11; // Assignment of this object to logical lanes. @@ -456,8 +413,6 @@ message TrafficSign // \note OSI uses singular instead of plural for repeated field // names. // - // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability - // repeated LogicalLaneAssignment logical_lane_assignment = 12; // Definition of traffic sign types. @@ -5639,14 +5594,10 @@ message TrafficSign // supplementary traffic sign's image in the direction from where a // 'viewer' could see the supplementary traffic sign image. // - // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability - // optional BaseStationary base = 1; // The classification of the supplementary traffic sign. // - // \note Changeability: Dynamic value - // optional Classification classification = 2; // Opaque reference of an associated 3D model of the supplementary traffic sign. @@ -5654,8 +5605,6 @@ message TrafficSign // \note It is implementation-specific how model_references are resolved to // 3d models. // - // \note Changeability: Static value - // optional string model_reference = 3; // @@ -5679,8 +5628,6 @@ message TrafficSign { // Variability. // - // \note Changeability: Static value - // optional Variability variability = 1; // Definition of supplementary sign types. @@ -9134,8 +9081,6 @@ message TrafficSign // \note OSI uses singular instead of plural for repeated field // names. // - // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability - // repeated TrafficSignValue value = 3; // The IDs of the lanes that the sign is assigned to. @@ -9148,8 +9093,6 @@ message TrafficSign // refers_to: Lane // \endrules // - // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability - // repeated Identifier assigned_lane_id = 4; // This enumerator indicates a traffic actor (e.g. @@ -9162,8 +9105,6 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // - // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability - // repeated Actor actor = 5; // A direction arrow shown on the supplementary sign. @@ -9174,15 +9115,11 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // - // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability - // repeated Arrow arrow = 6; // Boolean flag to indicate that the supplementary traffic sign is taken out of service. // This can be achieved by visibly crossing the sign or covering it completely. // - // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability - // optional bool is_out_of_service = 7; // Country specification of the traffic sign catalog specification @@ -9194,8 +9131,6 @@ message TrafficSign // https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, or the // special OpenDRIVE country for generic signs.
// - // \note Changeability: Static value - // optional string country = 8; // Revision specification of the traffic sign catalog specification @@ -9206,8 +9141,6 @@ message TrafficSign // The year the traffic rules came into force.
// e.g. "2017" // - // \note Changeability: Static value - // optional string country_revision = 9; // Code specification of the traffic sign catalog specification @@ -9220,8 +9153,6 @@ message TrafficSign // code is only unique in combination with #country and #country_revision.
// e.g. http://www.vzkat.de/2017/VzKat.htm // - // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability - // optional string code = 10; // Sub-code specification of the traffic sign catalog specification @@ -9235,8 +9166,6 @@ message TrafficSign // and #code.
// e.g. http://www.vzkat.de/2017/VzKat.htm // - // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability - // optional string sub_code = 11; // Assignment of this object to logical lanes. @@ -9244,8 +9173,6 @@ message TrafficSign // \note OSI uses singular instead of plural for repeated field // names. // - // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability - // repeated LogicalLaneAssignment logical_lane_assignment = 12; // Definition of the traffic actors the supplementary sign makes From fb531375748485d726ff9f7972c18a3da9523811 Mon Sep 17 00:00:00 2001 From: Thomas Hempen Date: Thu, 25 Jan 2024 08:25:10 +0100 Subject: [PATCH 3/7] Added changeability information - Static - Dynamic - Depending to documentation. Signed-off-by: Thomas Hempen --- osi_trafficcommand.proto | 8 +++++ osi_trafficsign.proto | 73 ++++++++++++++++++++++++++++++++++++++++ osi_trafficupdate.proto | 8 +++++ 3 files changed, 89 insertions(+) diff --git a/osi_trafficcommand.proto b/osi_trafficcommand.proto index 6e717e3e8..e1d2ef774 100644 --- a/osi_trafficcommand.proto +++ b/osi_trafficcommand.proto @@ -21,6 +21,8 @@ message TrafficCommand { // The interface version used by the sender (scenario engine). // + // \note Changeability: Static value + // optional InterfaceVersion version = 1; // The data timestamp of the simulation environment. Zero time is arbitrary @@ -33,10 +35,14 @@ message TrafficCommand // There is no inherent latency for traffic command data, as opposed // to sensor data. // + // \note Changeability: Dynamic value + // optional Timestamp timestamp = 2; // The ID of this traffic participant. // + // \note Changeability: Dynamic value + // optional Identifier traffic_participant_id = 3; // Commanded traffic action(s) if any. @@ -44,6 +50,8 @@ message TrafficCommand // \note If more than one action is supplied in one command message // all actions are executed in parallel. // + // \note Changeability: Dynamic value + // repeated TrafficAction action = 4; } diff --git a/osi_trafficsign.proto b/osi_trafficsign.proto index f15aad856..a65e37dc8 100644 --- a/osi_trafficsign.proto +++ b/osi_trafficsign.proto @@ -16,10 +16,15 @@ message TrafficSignValue // Additional value associated with a traffic sign or road marking, // e.g. value of a speed limit. // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability or + // TrafficSign::SupplementarySign::Classification::cariability + // optional double value = 1; // Unit for additional value. // + // \note Changeability: Static value + // optional Unit value_unit = 2; // Unit for values on traffic sign. @@ -158,6 +163,8 @@ message TrafficSignValue // to the sign is indicated therein. The interpretation of this text is // left to a user-defined procedure. // + // \note: Changeability: Dynamic value + // optional string text = 3; } @@ -175,15 +182,21 @@ message TrafficSign // is_globally_unique // \endrules // + // \note Changeability: Static value + // optional Identifier id = 1; // Main sign, e.g. speed limit 30 km/h // + // \note Changeability: Dynamic value + // optional MainSign main_sign = 2; // Additional supplementary signs, e.g. time limits, modifying the traffic // sign. // + // \note Changeability: Dynamic value + // repeated SupplementarySign supplementary_sign = 3; @@ -210,6 +223,8 @@ message TrafficSign // derived from more than one origin segment. Multiple sources // may be added as reference as well, for example, a map and sensors. // + // \note Changeability: Static value + // repeated ExternalReference source_reference = 4; // @@ -231,10 +246,14 @@ message TrafficSign // This x-axis points from the traffic sign's image in the direction // from where a 'viewer' could see the traffic sign image. // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional BaseStationary base = 1; // The classification of the traffic sign. // + // \note Changeability: Dynamic value + // optional Classification classification = 2; // Opaque reference of an associated 3D model of the traffic sign. @@ -242,6 +261,8 @@ message TrafficSign // \note It is implementation-specific how model_references are resolved to // 3d models. // + // \note Changeability: Static value + // optional string model_reference = 3; // @@ -278,6 +299,8 @@ message TrafficSign // content (e.g., electronic sign bridge) and/or regarding its // position on the road. // + // \note Changeability: Static value + // optional Variability variability = 1; // The type of the traffic sign. @@ -288,6 +311,8 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // + // \note Changeability: Static value + // optional Type type = 2; // Additional value associated with the traffic sign, e.g. value of @@ -296,6 +321,8 @@ message TrafficSign // \note Field need not be set if traffic sign type does not require // it. // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional TrafficSignValue value = 3; // Some traffic signs have an additional arrow symbol as an @@ -325,6 +352,8 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional DirectionScope direction_scope = 4; // The IDs of the lanes that the sign is assigned to. @@ -337,6 +366,8 @@ message TrafficSign // refers_to: Lane // \endrules // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // repeated Identifier assigned_lane_id = 5; // Some traffic signs exist in two variants that have @@ -355,11 +386,15 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // + // \note Changeability: Static value + // optional bool vertically_mirrored = 6; // Boolean flag to indicate that a traffic sign is taken out of service. // This can be achieved by visibly crossing the sign or covering it completely. // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional bool is_out_of_service = 7; // Country specification of the traffic sign catalog specification @@ -371,6 +406,8 @@ message TrafficSign // https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, or the // special OpenDRIVE country for generic signs.
// + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional string country = 8; // Revision specification of the traffic sign catalog specification @@ -381,6 +418,8 @@ message TrafficSign // The year the traffic rules came into force.
// e.g. "2017" // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional string country_revision = 9; // Code specification of the traffic sign catalog specification @@ -393,6 +432,8 @@ message TrafficSign // code is only unique in combination with #country and #country_revision.
// e.g. http://www.vzkat.de/2017/VzKat.htm // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional string code = 10; // Sub-code specification of the traffic sign catalog specification @@ -406,6 +447,8 @@ message TrafficSign // and #code.
// e.g. http://www.vzkat.de/2017/VzKat.htm // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // optional string sub_code = 11; // Assignment of this object to logical lanes. @@ -413,6 +456,8 @@ message TrafficSign // \note OSI uses singular instead of plural for repeated field // names. // + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // repeated LogicalLaneAssignment logical_lane_assignment = 12; // Definition of traffic sign types. @@ -5594,10 +5639,14 @@ message TrafficSign // supplementary traffic sign's image in the direction from where a // 'viewer' could see the supplementary traffic sign image. // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // optional BaseStationary base = 1; // The classification of the supplementary traffic sign. // + // \note Changeability: Dynamic value + // optional Classification classification = 2; // Opaque reference of an associated 3D model of the supplementary traffic sign. @@ -5605,6 +5654,8 @@ message TrafficSign // \note It is implementation-specific how model_references are resolved to // 3d models. // + // \note Changeability: Static value + // optional string model_reference = 3; // @@ -5628,6 +5679,8 @@ message TrafficSign { // Variability. // + // \note Changeability: Static value + // optional Variability variability = 1; // Definition of supplementary sign types. @@ -9081,6 +9134,8 @@ message TrafficSign // \note OSI uses singular instead of plural for repeated field // names. // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // repeated TrafficSignValue value = 3; // The IDs of the lanes that the sign is assigned to. @@ -9093,6 +9148,8 @@ message TrafficSign // refers_to: Lane // \endrules // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // repeated Identifier assigned_lane_id = 4; // This enumerator indicates a traffic actor (e.g. @@ -9105,6 +9162,8 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // repeated Actor actor = 5; // A direction arrow shown on the supplementary sign. @@ -9115,11 +9174,15 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // repeated Arrow arrow = 6; // Boolean flag to indicate that the supplementary traffic sign is taken out of service. // This can be achieved by visibly crossing the sign or covering it completely. // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // optional bool is_out_of_service = 7; // Country specification of the traffic sign catalog specification @@ -9131,6 +9194,8 @@ message TrafficSign // https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, or the // special OpenDRIVE country for generic signs.
// + // \note Changeability: Static value + // optional string country = 8; // Revision specification of the traffic sign catalog specification @@ -9141,6 +9206,8 @@ message TrafficSign // The year the traffic rules came into force.
// e.g. "2017" // + // \note Changeability: Static value + // optional string country_revision = 9; // Code specification of the traffic sign catalog specification @@ -9153,6 +9220,8 @@ message TrafficSign // code is only unique in combination with #country and #country_revision.
// e.g. http://www.vzkat.de/2017/VzKat.htm // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // optional string code = 10; // Sub-code specification of the traffic sign catalog specification @@ -9166,6 +9235,8 @@ message TrafficSign // and #code.
// e.g. http://www.vzkat.de/2017/VzKat.htm // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // optional string sub_code = 11; // Assignment of this object to logical lanes. @@ -9173,6 +9244,8 @@ message TrafficSign // \note OSI uses singular instead of plural for repeated field // names. // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // repeated LogicalLaneAssignment logical_lane_assignment = 12; // Definition of the traffic actors the supplementary sign makes diff --git a/osi_trafficupdate.proto b/osi_trafficupdate.proto index 5b157c668..592ba7bf8 100644 --- a/osi_trafficupdate.proto +++ b/osi_trafficupdate.proto @@ -27,6 +27,8 @@ message TrafficUpdate { // The interface version used by the sender (traffic participant model). // + // \note Changeability: Static value + // optional InterfaceVersion version = 1; // The data timestamp of the simulation environment. Zero time is arbitrary @@ -39,6 +41,8 @@ message TrafficUpdate // There is no inherent latency for moving object update data, as opposed // to sensor data. // + // \note Changeability: Dynamic value + // optional Timestamp timestamp = 2; // Updated traffic participant data @@ -52,6 +56,8 @@ message TrafficUpdate // a vehicle, see MovingObject::VehicleClassification::has_trailer and // MovingObject::VehicleClassification::trailer_id. // + // \note Changeability: Dynamic value + // repeated MovingObject update = 3; // Internal state for each vehicle. @@ -67,5 +73,7 @@ message TrafficUpdate // \note The id field from this should match the id in the update field // above where the same vehicle is being referenced. // + // \note Changeability: Dynamic value + // repeated HostVehicleData internal_state = 4; } From f8b8468607cbd4ce71bc2444126e7140900563c6 Mon Sep 17 00:00:00 2001 From: Thomas Hempen Date: Thu, 25 Jan 2024 09:29:17 +0100 Subject: [PATCH 4/7] Update on changeability documentation - removed comments on traffic command - this is basically a request-reply message / event - changed some documentation on traffic signs Signed-off-by: Thomas Hempen --- osi_trafficcommand.proto | 8 -------- osi_trafficlight.proto | 12 ++++++++++++ 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/osi_trafficcommand.proto b/osi_trafficcommand.proto index e1d2ef774..ccdc079e9 100644 --- a/osi_trafficcommand.proto +++ b/osi_trafficcommand.proto @@ -21,8 +21,6 @@ message TrafficCommand { // The interface version used by the sender (scenario engine). // - // \note Changeability: Static value - // optional InterfaceVersion version = 1; // The data timestamp of the simulation environment. Zero time is arbitrary @@ -35,22 +33,16 @@ message TrafficCommand // There is no inherent latency for traffic command data, as opposed // to sensor data. // - // \note Changeability: Dynamic value - // optional Timestamp timestamp = 2; // The ID of this traffic participant. // - // \note Changeability: Dynamic value - // optional Identifier traffic_participant_id = 3; // Commanded traffic action(s) if any. // // \note If more than one action is supplied in one command message // all actions are executed in parallel. - // - // \note Changeability: Dynamic value // repeated TrafficAction action = 4; } diff --git a/osi_trafficlight.proto b/osi_trafficlight.proto index 887a99fd4..9d3f4fbfb 100644 --- a/osi_trafficlight.proto +++ b/osi_trafficlight.proto @@ -18,6 +18,8 @@ message TrafficLight { // The ID of the traffic light. // + // \note Changeability: Static value + // // \rules // is_globally_unique // \endrules @@ -26,6 +28,8 @@ message TrafficLight // The base parameters of the traffic light. // + // \note Changeability: Static value + // // \c BaseStationary::orientation x-axis is view normal of the traffic // light's icon. // @@ -33,10 +37,14 @@ message TrafficLight // The classification data for the traffic light. // + // \note Changeability: Dynamic value + // optional Classification classification = 3; // Opaque reference of an associated 3D model of the traffic light. // + // \note Changeability: Static value + // // \note It is implementation-specific how model_references are resolved to // 3d models. // @@ -61,6 +69,8 @@ message TrafficLight // derived from more than one origin segment. Multiple sources // may be added as reference as well, for example, a map and sensors. // + // \note Changeability: Static value + // repeated ExternalReference source_reference = 5; // The visual color of the traffic light. @@ -69,6 +79,8 @@ message TrafficLight // appearance. For semantic classification of the traffic light use the color // field in \c Classification. // + // \note Changeability: Dynamic value + // optional ColorDescription color_description = 6; // From a817f0460d24579fda052a4c59c56f39d76d9319 Mon Sep 17 00:00:00 2001 From: Thomas Hempen Date: Thu, 25 Jan 2024 09:40:10 +0100 Subject: [PATCH 5/7] Update on documentation - trafficsign - changed some documentation on traffic signs Signed-off-by: Thomas Hempen --- osi_trafficsign.proto | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/osi_trafficsign.proto b/osi_trafficsign.proto index a65e37dc8..4b2cff895 100644 --- a/osi_trafficsign.proto +++ b/osi_trafficsign.proto @@ -311,7 +311,7 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // - // \note Changeability: Static value + // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability // optional Type type = 2; @@ -406,7 +406,7 @@ message TrafficSign // https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, or the // special OpenDRIVE country for generic signs.
// - // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // \note Changeability: Static value // optional string country = 8; @@ -418,7 +418,7 @@ message TrafficSign // The year the traffic rules came into force.
// e.g. "2017" // - // \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability + // \note Changeability: Static value // optional string country_revision = 9; @@ -9123,6 +9123,8 @@ message TrafficSign // introduced 4-tupel traffic sign catalog specification as used in // OpenDRIVE. // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // optional Type type = 2; // Additional value(s) associated with the traffic sign, e.g. @@ -9468,10 +9470,14 @@ message TrafficSign // refers_to: Lane // \endrules // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // repeated Identifier lane_id = 1; // The direction to which the arrow points to // + // \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability + // repeated Direction direction = 2; // The direction to which the arrow points to From 9aa795e4d199732efa1c04740b45cc17cfd18fb2 Mon Sep 17 00:00:00 2001 From: Thomas Hempen Date: Thu, 25 Jan 2024 09:58:37 +0100 Subject: [PATCH 6/7] Update on documentation trafficlight Added changeability information. Signed-off-by: Thomas Hempen --- osi_trafficlight.proto | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/osi_trafficlight.proto b/osi_trafficlight.proto index 9d3f4fbfb..85d481d6d 100644 --- a/osi_trafficlight.proto +++ b/osi_trafficlight.proto @@ -79,7 +79,7 @@ message TrafficLight // appearance. For semantic classification of the traffic light use the color // field in \c Classification. // - // \note Changeability: Dynamic value + // \note Changeability: Static value // optional ColorDescription color_description = 6; @@ -100,14 +100,20 @@ message TrafficLight // light is off ( \c #mode = \c #MODE_OFF), then \c #color = \c // #COLOR_OTHER . // + // \note Changeability: Static value + // optional Color color = 1; // The icon of the traffic light. // + // \note Changeability: Static value + // optional Icon icon = 2; // The operating mode of the traffic light. // + // \note Changeability: Dynamic value + // optional Mode mode = 3; // The value of the countdown counter. @@ -119,6 +125,8 @@ message TrafficLight // is_greater_than_or_equal_to: 0 // \endrules // + // \note Changeability: Dynamic value + // optional double counter = 4; // The IDs of the lanes that the traffic light is assigned to. @@ -131,18 +139,24 @@ message TrafficLight // refers_to: Lane // \endrules // + // \note Changeability: Static value + // repeated Identifier assigned_lane_id = 5; // Boolean flag to indicate that the traffic light is taken out of service. // This can be achieved by visibly crossing the light, covering it completely // or swiching the traffic light off. // + // \note Changeability: Dynamic value + // optional bool is_out_of_service = 6; // Assignment of this object to logical lanes. // // \note OSI uses singular instead of plural for repeated field names. // + // \note Changeability: Static value + // repeated LogicalLaneAssignment logical_lane_assignment = 7; // Definition of semantic colors for traffic lights. From 2add63786d73c78f6a3f46c789d3408575aa31bc Mon Sep 17 00:00:00 2001 From: Thomas Hempen Date: Thu, 25 Jan 2024 10:17:05 +0100 Subject: [PATCH 7/7] Update on documentation streamingupdate The messages are by default dynamic. Just the interface version is static throughout a simulation. Signed-off-by: Thomas Hempen --- osi_streamingupdate.proto | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/osi_streamingupdate.proto b/osi_streamingupdate.proto index b1ad1121a..b06fe443c 100644 --- a/osi_streamingupdate.proto +++ b/osi_streamingupdate.proto @@ -30,6 +30,8 @@ message StreamingUpdate { // The interface version used by the sender. // + // \note Changeability: Static value + // optional InterfaceVersion version = 1; // The data timestamp where the information of contained objects is calculated. @@ -38,27 +40,39 @@ message StreamingUpdate // Zero time does not need to coincide with the UNIX epoch. // Recommended is the starting time point of the simulation. // + // \note Changeability: Dynamic value + // optional Timestamp timestamp = 2; // The list of stationary objects (excluding traffic signs and traffic // lights). // + // \note Changeability: Dynamic value + // repeated StationaryObject stationary_object_update = 3; // The list of moving objects. // + // \note Changeability: Dynamic value + // repeated MovingObject moving_object_update = 4; // The list of traffic signs. // + // \note Changeability: Dynamic value + // repeated TrafficSign traffic_sign_update = 5; // The list of traffic lights. // + // \note Changeability: Dynamic value + // repeated TrafficLight traffic_light_update = 6; // Conditions of the environment. // + // \note Changeability: Dynamic value + // optional EnvironmentalConditions environmental_conditions_update = 7; // Host vehicle data. @@ -69,6 +83,8 @@ message StreamingUpdate // // The ID inside this message allows an association to moving object data. // + // \note Changeability: Dynamic value + // repeated HostVehicleData host_vehicle_data_update = 8; // Entities that will no longer be updated, because they are considered @@ -76,5 +92,7 @@ message StreamingUpdate // // \note IDs are globally unique. // + // \note Changeability: Dynamic value + // repeated Identifier obsolete_id = 9; }