From 34302550191751d5e7a2f66e3ebae5ef659ca5ac Mon Sep 17 00:00:00 2001 From: Georg Seifert Date: Mon, 25 Jan 2021 16:45:36 +0100 Subject: [PATCH 01/14] Extension of an additional Identifier for external references Signed-off-by: Georg Seifert --- osi_common.proto | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/osi_common.proto b/osi_common.proto index 7ab5852ec..4553f8a66 100644 --- a/osi_common.proto +++ b/osi_common.proto @@ -215,6 +215,31 @@ message Identifier optional uint64 value = 1; } +// \brief References to external objects +// +// The external reference is used to identify objects defined in non-OSI +// descriptions. This could be other OpenX-Standards as well as user defined +// simulation environments. +// +message ExternalReference +{ + // The external identifier reference value. + // + // For a common description of the external identifier, where a wide range + // of identification types could be represented, the repeded string is chosen. + // + // E.g. referencing a unique lane in OpenDRIVE + // (RoadId --> String, S-Value of LaneSection --> Double, LaneId --> Int) + // + repeated string value = 1; + + // The source of the references + // + // Can be used to describe the original source, e.g. OpenDRIVE 1.6 + // + optional string source_reference = 2; +} + // // \brief Specifies the mounting position of a sensor. // From a2fe89221822ab55264c24cd77df6a7aa3188901 Mon Sep 17 00:00:00 2001 From: Georg Seifert Date: Tue, 23 Mar 2021 08:19:43 +0100 Subject: [PATCH 02/14] Update the ExternalReference message by adding the possibility to define a URI to the origin source. Signed-off-by: Georg Seifert --- osi_common.proto | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/osi_common.proto b/osi_common.proto index 4553f8a66..6c3fe3f79 100644 --- a/osi_common.proto +++ b/osi_common.proto @@ -223,6 +223,20 @@ message Identifier // message ExternalReference { + // The source of the external references + // + // Defines the original source of an object as an URI. + // The URI should be follow the syntax according to + // \link https://tools.ietf.org/html/rfc3986 RFC 3986\endlink. + // + optional string reference = 1; + + // The type of the external references + // + // Can be used to describe the original source, e.g. OpenDRIVE 1.6 + // + optional string type = 2; + // The external identifier reference value. // // For a common description of the external identifier, where a wide range @@ -231,13 +245,7 @@ message ExternalReference // E.g. referencing a unique lane in OpenDRIVE // (RoadId --> String, S-Value of LaneSection --> Double, LaneId --> Int) // - repeated string value = 1; - - // The source of the references - // - // Can be used to describe the original source, e.g. OpenDRIVE 1.6 - // - optional string source_reference = 2; + repeated string identifier = 3; } // From 2f0fb36f4d417d4570287b5440b634785dda1adb Mon Sep 17 00:00:00 2001 From: Georg Seifert Date: Tue, 23 Mar 2021 09:52:48 +0100 Subject: [PATCH 03/14] First usage of ExternalReference in Lane, StationaryObject and MovingObject Signed-off-by: Georg Seifert --- osi_lane.proto | 26 ++++++++++++++++++++++ osi_object.proto | 56 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+) diff --git a/osi_lane.proto b/osi_lane.proto index 3fed17271..b73607ac2 100644 --- a/osi_lane.proto +++ b/osi_lane.proto @@ -50,6 +50,32 @@ message Lane // optional Classification classification = 2; + // External Reference to the Lane Source + // + // The ExternalReference point to the source of the lane, if it is derived + // from one or more objects or external references. An exaple here is the + // reference to the lane defined in a OpenDRIVE map. + // + // For OpenDRIVE 1.6 the items should be set as following: + // * reference = URI to map, can remain empty if identical with definiton + // in \c GroundTruth::map_reference + // * type = "OpenDRIVE 1.6" + // * identifier[0] = id of t_road + // * identifier[1] = s of t_road_lanes_laneSection + // * identifier[2] = id of t_road_lanes_laneSection_left_lane, + // t_road_lanes_laneSection_right_lane or + // t_road_lanes_laneSection_center_lane + // + // \note For non-ASAM Standards, it is implementation-specific how + // source_reference is resolved. + // + // \note The value has to be repeated, as it cannot guarantee, that one + // Lane-Segment is derived from only one origin segment. It is also + // possible, that multiple sources (map, sensor) should be added as + // reference. + // + repeated ExternalReference source_reference = 3; + // // \brief \c Classification of a lane. // diff --git a/osi_object.proto b/osi_object.proto index b44066f0f..6a408f7ec 100644 --- a/osi_object.proto +++ b/osi_object.proto @@ -40,6 +40,39 @@ message StationaryObject // optional string model_reference = 4; + // External Reference to the StationaryObject Source + // + // The ExternalReference point to the source of an stationary object, if it + // is derived from an external sources like OpenDRIVE or OpenSCENARIO. + // + // For OpenDRIVE 1.6 the objects should be set as following: + // * reference = URI to map, can remain empty if identical with definiton + // in \c GroundTruth::map_reference + // * type = "OpenDRIVE 1.6" + // * identifier[0] = "object" for t_road_objects_object and + // "bridge" for t_road_objects_bridge + // * identifier[1] = id of t_road_objects_object or t_road_objects_bridge + // + // For OpenSCENARIO 1.0 the entities of the type MiscObject, which describes + // partly stationary objecs should be set as following: + // * reference = URI to the OpenSCENARIO File + // * type = "OpenSCENARIO 1.0" + // * identifier[0] = Entity-Type ("MiscObject") + // * identifier[1] = name of MiscObject in Entity + // + // \note The following rule, described in OpenDRIVE, should also apply here: + // * Objects derived from OpenSCENARIO shall not be mixed with objects + // described in OpenDRIVE. + // + // \note For non-ASAM Standards, it is implementation-specific how + // source_reference is resolved. + // + // \note The value has to be repeated, as it cannot guarantee, that one + // object is derived from only one origin source, like from one + // scernario file and and from the sensors. + // + repeated ExternalReference source_reference = 5; + // // \brief Classification data for a stationary object. // @@ -359,6 +392,29 @@ message MovingObject // optional MovingObjectClassification moving_object_classification = 9; + // External Reference to the MovingObject Source + // + // The ExternalReference point to the source of an moving object, if it + // is derived from an external sources like OpenSCENARIO. + // + // For OpenSCENARIO 1.0 the entities of the type Vehicle or Pedestrian, + // which describes moving objecs should be set as following: + // * reference = URI to the OpenSCENARIO File + // * type = "OpenSCENARIO 1.0" + // * identifier[0] = Entity-Type ("Vehicle" or "Pedestrian") + // * identifier[1] = name of Vehicle/Pedestrian in Entity + // + // \todo OpenSCENARIO 1.0 currently does not provide an animal type. + // + // \note For non-ASAM Standards, it is implementation-specific how + // source_reference is resolved. + // + // \note The value has to be repeated, as it cannot guarantee, that one + // object is derived from only one origin source, like from one map + // and from the sensors. + // + repeated ExternalReference source_reference = 10; + // Definition of object types. // enum Type From 6fd607285f47b7f7cd73a00dce545c3294ea9c2d Mon Sep 17 00:00:00 2001 From: Georg Seifert Date: Thu, 25 Mar 2021 13:10:01 +0100 Subject: [PATCH 04/14] Remove t_road_lanes_laneSection_center_lane from the Lane::ExternalReference Example, as the center lane is not driving lane Signed-off-by: Georg Seifert --- osi_lane.proto | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/osi_lane.proto b/osi_lane.proto index b73607ac2..84e288dc5 100644 --- a/osi_lane.proto +++ b/osi_lane.proto @@ -63,8 +63,7 @@ message Lane // * identifier[0] = id of t_road // * identifier[1] = s of t_road_lanes_laneSection // * identifier[2] = id of t_road_lanes_laneSection_left_lane, - // t_road_lanes_laneSection_right_lane or - // t_road_lanes_laneSection_center_lane + // t_road_lanes_laneSection_right_lane // // \note For non-ASAM Standards, it is implementation-specific how // source_reference is resolved. From abc661453b05f2e6815e6f3dea04e1f74e027149 Mon Sep 17 00:00:00 2001 From: Georg Seifert Date: Thu, 22 Apr 2021 08:41:29 +0200 Subject: [PATCH 05/14] External References added to TrafficSign, TrafficLight and Road Marking Signed-off-by: Georg Seifert --- osi_roadmarking.proto | 29 +++++++++++++++++++++++++++++ osi_trafficlight.proto | 22 ++++++++++++++++++++++ osi_trafficsign.proto | 27 +++++++++++++++++++++++++++ 3 files changed, 78 insertions(+) diff --git a/osi_roadmarking.proto b/osi_roadmarking.proto index 7afbf4f77..b20e2e95b 100644 --- a/osi_roadmarking.proto +++ b/osi_roadmarking.proto @@ -55,6 +55,35 @@ message RoadMarking // optional Classification classification = 3; + // External Reference to the Roadmarking Source + // + // The ExternalReference point to the source of the surface marking, if it + // is derived from one or more objects or external references. An example + // here is the reference to the signal defined in a OpenDRIVE map. + // + // For OpenDRIVE 1.6 the items should be set as following: + // * reference = URI to map, can remain empty if identical with definiton + // in \c GroundTruth::map_reference + // * type = "OpenDRIVE 1.6" + // * identifier[0] = id of t_road_signals_signal + // + // \note In OpenDRIVE 1.6 there is also the possibility to define surface + // markings as an object. In this case, the associated object is + // usually referenced within OpenDRIVE using the reference + // t_road_signals_signal_reference, which allows it to be + // identifiable. + // An additional reference to the object is therefore not necessary. + // + // \note For non-ASAM Standards, it is implementation-specific how + // source_reference is resolved. + // + // \note The value has to be repeated, as it cannot guarantee, that one + // Lane-Segment is derived from only one origin segment. It is also + // possible, that multiple sources (map, sensor) should be added as + // reference. + // + repeated ExternalReference source_reference = 4; + // // \brief \c Classification data for a road surface marking. // diff --git a/osi_trafficlight.proto b/osi_trafficlight.proto index 0aef80e7c..e411ee648 100644 --- a/osi_trafficlight.proto +++ b/osi_trafficlight.proto @@ -42,6 +42,28 @@ message TrafficLight // optional string model_reference = 4; + // External Reference to the Traffic Light Source + // + // The ExternalReference point to the source of the traffic light, if it is + // derived from one or more objects or external references. An example here + // is the reference to the signal defined in a OpenDRIVE map. + // + // For OpenDRIVE 1.6 the items should be set as following: + // * reference = URI to map, can remain empty if identical with definiton + // in \c GroundTruth::map_reference + // * type = "OpenDRIVE 1.6" + // * identifier[0] = id of t_road_signals_signal + // + // \note For non-ASAM Standards, it is implementation-specific how + // source_reference is resolved. + // + // \note The value has to be repeated, as it cannot guarantee, that one + // Lane-Segment is derived from only one origin segment. It is also + // possible, that multiple sources (map, sensor) should be added as + // reference. + // + repeated ExternalReference source_reference = 5; + // // \brief \c Classification data for a traffic light. // diff --git a/osi_trafficsign.proto b/osi_trafficsign.proto index 3c9ac589b..1e87fe8ca 100644 --- a/osi_trafficsign.proto +++ b/osi_trafficsign.proto @@ -156,6 +156,33 @@ message TrafficSign // repeated SupplementarySign supplementary_sign = 3; + + // External Reference to the Traffic Sign Source + // + // The ExternalReference point to the source of the traffic sign, if it is + // derived from one or more objects or external references. An example here + // is the reference to the signal defined in a OpenDRIVE map. + // + // For OpenDRIVE 1.6 the items should be set as following: + // * reference = URI to map, can remain empty if identical with definiton + // in \c GroundTruth::map_reference + // * type = "OpenDRIVE 1.6" + // * identifier[0] = id of t_road_signals_signal + // + // \note For non-ASAM Standards, it is implementation-specific how + // source_reference is resolved. + // + // \note If an individual identification of MainSign and SupplementarySign + // is be necessary, this sould be defined via multiple individual + // entries of this source_reference. + // + // \note The value has to be repeated, as it cannot guarantee, that one + // Lane-Segment is derived from only one origin segment. It is also + // possible, that multiple sources (map, sensor) should be added as + // reference. + // + repeated ExternalReference source_reference = 4; + // // \brief Main sign of the traffic sign. // From d2e10b6fa9e49e276f1aed4a04a22ea5a519bfa1 Mon Sep 17 00:00:00 2001 From: Georg Seifert Date: Thu, 22 Apr 2021 10:37:57 +0200 Subject: [PATCH 06/14] Add external reference to EnvironmentalConditions, Occupant, LaneBoundary. Signed-off-by: Georg Seifert --- osi_environment.proto | 13 +++++++++++++ osi_lane.proto | 16 +++++++++++++++- osi_occupant.proto | 13 +++++++++++++ 3 files changed, 41 insertions(+), 1 deletion(-) diff --git a/osi_environment.proto b/osi_environment.proto index be5d830a8..dd43ca969 100644 --- a/osi_environment.proto +++ b/osi_environment.proto @@ -85,6 +85,19 @@ message EnvironmentalConditions // Description of the fog. // optional Fog fog = 7; + + // External Reference to the Environmental Condition Sources + // + // \note For OpenDRIVE and OpenSECNARIO there is no no direct counterpart. + // + // \note For non-ASAM Standards, it is implementation-specific how + // source_reference is resolved. + // + // \note The value has to be repeated, as it cannot guarantee, that one + // object is derived from only one origin source, like from one + // scernario file and and from the sensors. + // + repeated ExternalReference source_reference = 8; // Definition of discretized precipitation states according to [1]. // (I = Intensity of precipitation in mm per hour mm/h) diff --git a/osi_lane.proto b/osi_lane.proto index 84e288dc5..d100d6c09 100644 --- a/osi_lane.proto +++ b/osi_lane.proto @@ -53,7 +53,7 @@ message Lane // External Reference to the Lane Source // // The ExternalReference point to the source of the lane, if it is derived - // from one or more objects or external references. An exaple here is the + // from one or more objects or external references. An example here is the // reference to the lane defined in a OpenDRIVE map. // // For OpenDRIVE 1.6 the items should be set as following: @@ -749,6 +749,20 @@ message LaneBoundary // The classification of the lane boundary. // optional Classification classification = 3; + + // External Reference to the Lane Boundary Source + // + // \note For OpenDRIVE 1.6 there is no direct possibility to reference the + // RoadMark, as there is no unique identifier in this sub-object. + // + // \note For non-ASAM Standards, it is implementation-specific how + // source_reference is resolved. + // + // \note The value has to be repeated, as it cannot guarantee, that one + // object is derived from only one origin source, like from one + // scernario file and and from the sensors. + // + repeated ExternalReference source_reference = 3; // // \brief A single point of a lane boundary. diff --git a/osi_occupant.proto b/osi_occupant.proto index 131e109fa..61d5abace 100644 --- a/osi_occupant.proto +++ b/osi_occupant.proto @@ -23,6 +23,19 @@ message Occupant // optional Classification classification = 2; + // External Reference to the Occupant Source + // + // \note For OpenDRIVE and OpenSECNARIO there is no no direct counterpart. + // + // \note For non-ASAM Standards, it is implementation-specific how + // source_reference is resolved. + // + // \note The value has to be repeated, as it cannot guarantee, that one + // object is derived from only one origin source, like from one + // scernario file and and from the sensors. + // + repeated ExternalReference source_reference = 3; + // // \brief Information regarding the classification of the occupant. // From 76bb1ace16e16c409a916ab175131a6bddf959a0 Mon Sep 17 00:00:00 2001 From: Georg Seifert Date: Thu, 22 Apr 2021 14:05:10 +0200 Subject: [PATCH 07/14] Correct mismatch of protobuf continuous IDs and add osi_common to osi_environment Signed-off-by: Georg Seifert --- osi_environment.proto | 4 +++- osi_lane.proto | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/osi_environment.proto b/osi_environment.proto index dd43ca969..1cca71716 100644 --- a/osi_environment.proto +++ b/osi_environment.proto @@ -2,6 +2,8 @@ syntax = "proto2"; option optimize_for = SPEED; +import "osi_common.proto"; + package osi3; // @@ -97,7 +99,7 @@ message EnvironmentalConditions // object is derived from only one origin source, like from one // scernario file and and from the sensors. // - repeated ExternalReference source_reference = 8; + repeated ExternalReference source_reference = 9; // Definition of discretized precipitation states according to [1]. // (I = Intensity of precipitation in mm per hour mm/h) diff --git a/osi_lane.proto b/osi_lane.proto index d100d6c09..bf5465bc7 100644 --- a/osi_lane.proto +++ b/osi_lane.proto @@ -762,7 +762,7 @@ message LaneBoundary // object is derived from only one origin source, like from one // scernario file and and from the sensors. // - repeated ExternalReference source_reference = 3; + repeated ExternalReference source_reference = 4; // // \brief A single point of a lane boundary. From e7f323fad4eea1528c67c8c3994643bdd6c7ab38 Mon Sep 17 00:00:00 2001 From: Georg Seifert Date: Fri, 7 May 2021 09:02:34 +0200 Subject: [PATCH 08/14] Apply suggestions from code review Signed-off-by: Georg Seifert Co-authored-by: Kmeid --- osi_common.proto | 9 ++++----- osi_environment.proto | 4 ++-- osi_object.proto | 4 ++-- osi_occupant.proto | 2 +- 4 files changed, 9 insertions(+), 10 deletions(-) diff --git a/osi_common.proto b/osi_common.proto index 6c3fe3f79..c74735793 100644 --- a/osi_common.proto +++ b/osi_common.proto @@ -217,8 +217,8 @@ message Identifier // \brief References to external objects // -// The external reference is used to identify objects defined in non-OSI -// descriptions. This could be other OpenX-Standards as well as user defined +// 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. // simulation environments. // message ExternalReference @@ -233,14 +233,14 @@ message ExternalReference // The type of the external references // - // Can be used to describe the original source, e.g. OpenDRIVE 1.6 + // Must be used to describe the type of the original source. // optional string type = 2; // The external identifier reference value. // // For a common description of the external identifier, where a wide range - // of identification types could be represented, the repeded string is chosen. + // of identification types could be represented, the repeated string is chosen. // // E.g. referencing a unique lane in OpenDRIVE // (RoadId --> String, S-Value of LaneSection --> Double, LaneId --> Int) @@ -550,4 +550,3 @@ message WavelengthData // optional double samples_number = 3; } - diff --git a/osi_environment.proto b/osi_environment.proto index 1cca71716..a9cf257fc 100644 --- a/osi_environment.proto +++ b/osi_environment.proto @@ -90,14 +90,14 @@ message EnvironmentalConditions // External Reference to the Environmental Condition Sources // - // \note For OpenDRIVE and OpenSECNARIO there is no no direct counterpart. + // \note For OpenDRIVE and OpenSECNARIO there is no direct counterpart. // // \note For non-ASAM Standards, it is implementation-specific how // source_reference is resolved. // // \note The value has to be repeated, as it cannot guarantee, that one // object is derived from only one origin source, like from one - // scernario file and and from the sensors. + // scernario file and from the sensors. // repeated ExternalReference source_reference = 9; diff --git a/osi_object.proto b/osi_object.proto index 6a408f7ec..a217ee29e 100644 --- a/osi_object.proto +++ b/osi_object.proto @@ -54,7 +54,7 @@ message StationaryObject // * identifier[1] = id of t_road_objects_object or t_road_objects_bridge // // For OpenSCENARIO 1.0 the entities of the type MiscObject, which describes - // partly stationary objecs should be set as following: + // partly stationary objects should be set as following: // * reference = URI to the OpenSCENARIO File // * type = "OpenSCENARIO 1.0" // * identifier[0] = Entity-Type ("MiscObject") @@ -69,7 +69,7 @@ message StationaryObject // // \note The value has to be repeated, as it cannot guarantee, that one // object is derived from only one origin source, like from one - // scernario file and and from the sensors. + // scenario file and and from the sensors. // repeated ExternalReference source_reference = 5; diff --git a/osi_occupant.proto b/osi_occupant.proto index 61d5abace..0c195dfdc 100644 --- a/osi_occupant.proto +++ b/osi_occupant.proto @@ -25,7 +25,7 @@ message Occupant // External Reference to the Occupant Source // - // \note For OpenDRIVE and OpenSECNARIO there is no no direct counterpart. + // \note For OpenDRIVE and OpenSCENARIO there is no no direct counterpart. // // \note For non-ASAM Standards, it is implementation-specific how // source_reference is resolved. From e2b2aee4569c33de01d0490b41700209025c7e91 Mon Sep 17 00:00:00 2001 From: Georg Seifert Date: Mon, 10 May 2021 07:29:39 +0200 Subject: [PATCH 09/14] Second part from code review Signed-off-by: Georg Seifert --- osi_common.proto | 36 ++++++++++++++++++++++++++++++++++-- osi_environment.proto | 2 +- osi_lane.proto | 4 ++-- osi_object.proto | 2 +- osi_roadmarking.proto | 2 +- osi_trafficlight.proto | 2 +- osi_trafficsign.proto | 2 +- 7 files changed, 41 insertions(+), 9 deletions(-) diff --git a/osi_common.proto b/osi_common.proto index c74735793..d01092fe9 100644 --- a/osi_common.proto +++ b/osi_common.proto @@ -221,20 +221,39 @@ message Identifier // This could be other OpenX standards, 3rd-party standards or user-defined objects. // simulation environments. // +// \note The ExternalReference is an optional value and can be left empty. +// message ExternalReference { // The source of the external references // - // Defines the original source of an object as an URI. - // The URI should be follow the syntax according to + // Defines the original source of an object as uniquely identifiable reference. + // In case of using \c GroundTruth::map_reference or + // \c GroundTruth::model_reference, the reference can be left empty. + // If not otherwise required, an URI is suggested and should follow the syntax according to // \link https://tools.ietf.org/html/rfc3986 RFC 3986\endlink. // + // optional string reference = 1; // The type of the external references // // Must be used to describe the type of the original source. // + // For OpenX/ASAM standards it is specified as follows, + // the PATCH-Value is optional: + // - OpenDRIVE 1.6 + // - OpenDRIVE 1.6.0 + // - OpenDRIVE 1.6.1 + // - OpenSCENARIO 1.0 + // - OpenSCENARIO 1.0.0 + // - OpenSCENARIO 1.1 + // - OpenSCENARIO 1.1.0 + // + // For third-party standards and user-defined objects the + // Reverse Domain Name Notation is suggested, to guarantee unique + // and interoperable identifications. + // optional string type = 2; // The external identifier reference value. @@ -245,6 +264,19 @@ message ExternalReference // E.g. referencing a unique lane in OpenDRIVE // (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 are given in the individual + // messages, where it is deployed. + // + // \see EnvironmentalConditions::source_reference + // \see Lane::source_reference + // \see LaneBoundary::source_reference + // \see StationaryObject::source_reference + // \see MovingObject::source_reference + // \see RoadMarking::source_reference + // \see TrafficLight::source_reference + // \see TrafficSign::source_reference + // repeated string identifier = 3; } diff --git a/osi_environment.proto b/osi_environment.proto index a9cf257fc..6d8beb772 100644 --- a/osi_environment.proto +++ b/osi_environment.proto @@ -88,7 +88,7 @@ message EnvironmentalConditions // optional Fog fog = 7; - // External Reference to the Environmental Condition Sources + // Optional external Reference to the Environmental Condition Sources // // \note For OpenDRIVE and OpenSECNARIO there is no direct counterpart. // diff --git a/osi_lane.proto b/osi_lane.proto index bf5465bc7..1e8d8d79c 100644 --- a/osi_lane.proto +++ b/osi_lane.proto @@ -50,7 +50,7 @@ message Lane // optional Classification classification = 2; - // External Reference to the Lane Source + // Optional external Reference to the Lane Source // // The ExternalReference point to the source of the lane, if it is derived // from one or more objects or external references. An example here is the @@ -750,7 +750,7 @@ message LaneBoundary // optional Classification classification = 3; - // External Reference to the Lane Boundary Source + // Optional external Reference to the Lane Boundary Source // // \note For OpenDRIVE 1.6 there is no direct possibility to reference the // RoadMark, as there is no unique identifier in this sub-object. diff --git a/osi_object.proto b/osi_object.proto index a217ee29e..04c469d32 100644 --- a/osi_object.proto +++ b/osi_object.proto @@ -392,7 +392,7 @@ message MovingObject // optional MovingObjectClassification moving_object_classification = 9; - // External Reference to the MovingObject Source + // Optional external Reference to the MovingObject Source // // The ExternalReference point to the source of an moving object, if it // is derived from an external sources like OpenSCENARIO. diff --git a/osi_roadmarking.proto b/osi_roadmarking.proto index b20e2e95b..abc972eaf 100644 --- a/osi_roadmarking.proto +++ b/osi_roadmarking.proto @@ -55,7 +55,7 @@ message RoadMarking // optional Classification classification = 3; - // External Reference to the Roadmarking Source + // Optional external Reference to the Roadmarking Source // // The ExternalReference point to the source of the surface marking, if it // is derived from one or more objects or external references. An example diff --git a/osi_trafficlight.proto b/osi_trafficlight.proto index e411ee648..5fa32a2cc 100644 --- a/osi_trafficlight.proto +++ b/osi_trafficlight.proto @@ -42,7 +42,7 @@ message TrafficLight // optional string model_reference = 4; - // External Reference to the Traffic Light Source + // Optional external Reference to the Traffic Light Source // // The ExternalReference point to the source of the traffic light, if it is // derived from one or more objects or external references. An example here diff --git a/osi_trafficsign.proto b/osi_trafficsign.proto index 1e87fe8ca..716aa38f2 100644 --- a/osi_trafficsign.proto +++ b/osi_trafficsign.proto @@ -157,7 +157,7 @@ message TrafficSign repeated SupplementarySign supplementary_sign = 3; - // External Reference to the Traffic Sign Source + // Optional external Reference to the Traffic Sign Source // // The ExternalReference point to the source of the traffic sign, if it is // derived from one or more objects or external references. An example here From 3ae6ec8297b66e371ececcf50145f41cf85c567f Mon Sep 17 00:00:00 2001 From: Georg Seifert Date: Wed, 12 May 2021 11:42:53 +0200 Subject: [PATCH 10/14] Remove the version from the comment for OpenX description and use also rDNS. Point out to use lower case field. Signed-off-by: Georg Seifert --- osi_common.proto | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/osi_common.proto b/osi_common.proto index d01092fe9..cee755a4b 100644 --- a/osi_common.proto +++ b/osi_common.proto @@ -240,19 +240,13 @@ message ExternalReference // // Must be used to describe the type of the original source. // - // For OpenX/ASAM standards it is specified as follows, - // the PATCH-Value is optional: - // - OpenDRIVE 1.6 - // - OpenDRIVE 1.6.0 - // - OpenDRIVE 1.6.1 - // - OpenSCENARIO 1.0 - // - OpenSCENARIO 1.0.0 - // - OpenSCENARIO 1.1 - // - OpenSCENARIO 1.1.0 + // For OpenX/ASAM standards it is specified as follows: + // - net.asam.opendrive + // - net.asam.openscenario // // For third-party standards and user-defined objects the - // Reverse Domain Name Notation is suggested, to guarantee unique - // and interoperable identifications. + // Reverse Domain Name Notation, with lower case type field, + // is suggested, to guarantee unique and interoperable identifications. // optional string type = 2; From eb4e2e1afbf9cde2ee69c41fbaeb704e84d95c55 Mon Sep 17 00:00:00 2001 From: Georg Seifert Date: Mon, 17 May 2021 07:17:48 +0200 Subject: [PATCH 11/14] Update the OpenX-Examples to rDNS. Signed-off-by: Georg Seifert --- osi_lane.proto | 6 +++--- osi_object.proto | 14 +++++++------- osi_roadmarking.proto | 6 +++--- osi_trafficlight.proto | 4 ++-- osi_trafficsign.proto | 6 +++--- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/osi_lane.proto b/osi_lane.proto index 1e8d8d79c..0cbd38906 100644 --- a/osi_lane.proto +++ b/osi_lane.proto @@ -56,10 +56,10 @@ message Lane // from one or more objects or external references. An example here is the // reference to the lane defined in a OpenDRIVE map. // - // For OpenDRIVE 1.6 the items should be set as following: + // For OpenDRIVE the items should be set as following: // * reference = URI to map, can remain empty if identical with definiton // in \c GroundTruth::map_reference - // * type = "OpenDRIVE 1.6" + // * type = "net.asam.opendrive" // * identifier[0] = id of t_road // * identifier[1] = s of t_road_lanes_laneSection // * identifier[2] = id of t_road_lanes_laneSection_left_lane, @@ -752,7 +752,7 @@ message LaneBoundary // Optional external Reference to the Lane Boundary Source // - // \note For OpenDRIVE 1.6 there is no direct possibility to reference the + // \note For OpenDRIVE there is no direct possibility to reference the // RoadMark, as there is no unique identifier in this sub-object. // // \note For non-ASAM Standards, it is implementation-specific how diff --git a/osi_object.proto b/osi_object.proto index 04c469d32..05fb8a9c9 100644 --- a/osi_object.proto +++ b/osi_object.proto @@ -45,18 +45,18 @@ message StationaryObject // The ExternalReference point to the source of an stationary object, if it // is derived from an external sources like OpenDRIVE or OpenSCENARIO. // - // For OpenDRIVE 1.6 the objects should be set as following: + // For OpenDRIVE the objects should be set as following: // * reference = URI to map, can remain empty if identical with definiton // in \c GroundTruth::map_reference - // * type = "OpenDRIVE 1.6" + // * type = "net.asam.opendrive" // * identifier[0] = "object" for t_road_objects_object and // "bridge" for t_road_objects_bridge // * identifier[1] = id of t_road_objects_object or t_road_objects_bridge // - // For OpenSCENARIO 1.0 the entities of the type MiscObject, which describes + // For OpenSCENARIO the entities of the type MiscObject, which describes // partly stationary objects should be set as following: // * reference = URI to the OpenSCENARIO File - // * type = "OpenSCENARIO 1.0" + // * type = "net.asam.openscenario" // * identifier[0] = Entity-Type ("MiscObject") // * identifier[1] = name of MiscObject in Entity // @@ -397,14 +397,14 @@ message MovingObject // The ExternalReference point to the source of an moving object, if it // is derived from an external sources like OpenSCENARIO. // - // For OpenSCENARIO 1.0 the entities of the type Vehicle or Pedestrian, + // For OpenSCENARIO the entities of the type Vehicle or Pedestrian, // which describes moving objecs should be set as following: // * reference = URI to the OpenSCENARIO File - // * type = "OpenSCENARIO 1.0" + // * type = "net.asam.openscenario" // * identifier[0] = Entity-Type ("Vehicle" or "Pedestrian") // * identifier[1] = name of Vehicle/Pedestrian in Entity // - // \todo OpenSCENARIO 1.0 currently does not provide an animal type. + // \todo OpenSCENARIO currently does not provide an animal type. // // \note For non-ASAM Standards, it is implementation-specific how // source_reference is resolved. diff --git a/osi_roadmarking.proto b/osi_roadmarking.proto index abc972eaf..dda153b3a 100644 --- a/osi_roadmarking.proto +++ b/osi_roadmarking.proto @@ -61,13 +61,13 @@ message RoadMarking // is derived from one or more objects or external references. An example // here is the reference to the signal defined in a OpenDRIVE map. // - // For OpenDRIVE 1.6 the items should be set as following: + // For OpenDRIVE the items should be set as following: // * reference = URI to map, can remain empty if identical with definiton // in \c GroundTruth::map_reference - // * type = "OpenDRIVE 1.6" + // * type = "net.asam.opendrive" // * identifier[0] = id of t_road_signals_signal // - // \note In OpenDRIVE 1.6 there is also the possibility to define surface + // \note In OpenDRIVE there is also the possibility to define surface // markings as an object. In this case, the associated object is // usually referenced within OpenDRIVE using the reference // t_road_signals_signal_reference, which allows it to be diff --git a/osi_trafficlight.proto b/osi_trafficlight.proto index 5fa32a2cc..b3143ce9c 100644 --- a/osi_trafficlight.proto +++ b/osi_trafficlight.proto @@ -48,10 +48,10 @@ message TrafficLight // derived from one or more objects or external references. An example here // is the reference to the signal defined in a OpenDRIVE map. // - // For OpenDRIVE 1.6 the items should be set as following: + // For OpenDRIVE the items should be set as following: // * reference = URI to map, can remain empty if identical with definiton // in \c GroundTruth::map_reference - // * type = "OpenDRIVE 1.6" + // * type = "net.asam.opendrive" // * identifier[0] = id of t_road_signals_signal // // \note For non-ASAM Standards, it is implementation-specific how diff --git a/osi_trafficsign.proto b/osi_trafficsign.proto index 716aa38f2..a5590e457 100644 --- a/osi_trafficsign.proto +++ b/osi_trafficsign.proto @@ -163,10 +163,10 @@ message TrafficSign // derived from one or more objects or external references. An example here // is the reference to the signal defined in a OpenDRIVE map. // - // For OpenDRIVE 1.6 the items should be set as following: - // * reference = URI to map, can remain empty if identical with definiton + // For OpenDRIVE the items should be set as following: + // * reference = URI to map, can remain empty if identical with definition // in \c GroundTruth::map_reference - // * type = "OpenDRIVE 1.6" + // * type = "net.asam.opendrive" // * identifier[0] = id of t_road_signals_signal // // \note For non-ASAM Standards, it is implementation-specific how From a2d284cf5544ea9e20511306885be0f59aefc1fc Mon Sep 17 00:00:00 2001 From: Maximilian Rosin Date: Tue, 18 May 2021 17:08:41 +0200 Subject: [PATCH 12/14] fix(docs): Doc review Signed-off-by: Maximilian Rosin --- osi_common.proto | 34 +++++++++++++++++++--------------- osi_environment.proto | 10 +++++----- osi_lane.proto | 27 +++++++++++++-------------- osi_object.proto | 32 ++++++++++++++++---------------- osi_occupant.proto | 10 +++++----- osi_roadmarking.proto | 19 ++++++++----------- osi_trafficlight.proto | 19 +++++++++---------- osi_trafficsign.proto | 19 +++++++++---------- 8 files changed, 84 insertions(+), 86 deletions(-) diff --git a/osi_common.proto b/osi_common.proto index cee755a4b..ebb9b1803 100644 --- a/osi_common.proto +++ b/osi_common.proto @@ -215,52 +215,56 @@ message Identifier optional uint64 value = 1; } -// \brief References to external objects +// \brief 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. // simulation environments. // -// \note The ExternalReference is an optional value and can be left empty. +// \note ExternalReference is optional and can be left empty. // message ExternalReference { - // The source of the external references + // The source of the external references. // // Defines the original source of an object as uniquely identifiable reference. // In case of using \c GroundTruth::map_reference or // \c GroundTruth::model_reference, the reference can be left empty. - // If not otherwise required, an URI is suggested and should follow the syntax according to + // If not otherwise required, an URI is suggested. The syntax should follow // \link https://tools.ietf.org/html/rfc3986 RFC 3986\endlink. // // optional string reference = 1; - // The type of the external references + // The type of the external references. // - // Must be used to describe the type of the original source. + // 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 the - // Reverse Domain Name Notation, with lower case type field, - // is suggested, to guarantee unique and interoperable identifications. + // 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. // optional string type = 2; // The external identifier reference value. // - // For a common description of the external identifier, where a wide range - // of identification types could be represented, the repeated string is chosen. + // The repeated string is chosen as a common description of the external + // identifier, because a variety of identificatier types could be + // involved . // - // E.g. referencing a unique lane in OpenDRIVE - // (RoadId --> String, S-Value of LaneSection --> Double, LaneId --> Int) + // 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 are given in the individual - // messages, where it is deployed. + // used for referencing external objects is given in the individual + // messages where the external identifier is used. // // \see EnvironmentalConditions::source_reference // \see Lane::source_reference diff --git a/osi_environment.proto b/osi_environment.proto index 6d8beb772..5aafe2cac 100644 --- a/osi_environment.proto +++ b/osi_environment.proto @@ -88,16 +88,16 @@ message EnvironmentalConditions // optional Fog fog = 7; - // Optional external Reference to the Environmental Condition Sources + // Optional external reference to the environmental condition sources. // // \note For OpenDRIVE and OpenSECNARIO there is no direct counterpart. // - // \note For non-ASAM Standards, it is implementation-specific how + // \note For non-ASAM standards, it is implementation-specific how // source_reference is resolved. // - // \note The value has to be repeated, as it cannot guarantee, that one - // object is derived from only one origin source, like from one - // scernario file and from the sensors. + // \note The value has to be repeated because one object may be derived + // from more than one origin source, for example, from a scenario file + // and from sensors. // repeated ExternalReference source_reference = 9; diff --git a/osi_lane.proto b/osi_lane.proto index 0cbd38906..ce63abd47 100644 --- a/osi_lane.proto +++ b/osi_lane.proto @@ -50,13 +50,13 @@ message Lane // optional Classification classification = 2; - // Optional external Reference to the Lane Source + // Optional external reference to the lane source. // - // The ExternalReference point to the source of the lane, if it is derived - // from one or more objects or external references. An example here is the - // reference to the lane defined in a OpenDRIVE map. + // The external reference points to the source of the lane, if it is derived + // from one or more objects or external references. // - // For OpenDRIVE the items should be set as following: + // For example, to reference a lane defined in an OpenDRIVE map + // the items should be set as following: // * reference = URI to map, can remain empty if identical with definiton // in \c GroundTruth::map_reference // * type = "net.asam.opendrive" @@ -68,10 +68,9 @@ message Lane // \note For non-ASAM Standards, it is implementation-specific how // source_reference is resolved. // - // \note The value has to be repeated, as it cannot guarantee, that one - // Lane-Segment is derived from only one origin segment. It is also - // possible, that multiple sources (map, sensor) should be added as - // reference. + // \note The value has to be repeated, because one lane segment may be + // derived from more than one origin segment. Multiple sources + // may be added as reference as well, for example, a map and sensors. // repeated ExternalReference source_reference = 3; @@ -750,17 +749,17 @@ message LaneBoundary // optional Classification classification = 3; - // Optional external Reference to the Lane Boundary Source + // Optional external reference to the lane boundary source. // - // \note For OpenDRIVE there is no direct possibility to reference the + // \note For OpenDRIVE, there is no direct possibility to reference the // RoadMark, as there is no unique identifier in this sub-object. // // \note For non-ASAM Standards, it is implementation-specific how // source_reference is resolved. // - // \note The value has to be repeated, as it cannot guarantee, that one - // object is derived from only one origin source, like from one - // scernario file and and from the sensors. + // \note The value has to be repeated because one object may be derived + // from more than one origin source, for example, from a scenario file + // and from sensors. // repeated ExternalReference source_reference = 4; diff --git a/osi_object.proto b/osi_object.proto index 05fb8a9c9..e4cab2af9 100644 --- a/osi_object.proto +++ b/osi_object.proto @@ -40,12 +40,12 @@ message StationaryObject // optional string model_reference = 4; - // External Reference to the StationaryObject Source + // External reference to the stationary-object source. // - // The ExternalReference point to the source of an stationary object, if it + // The external reference points to the source of a stationary object, if it // is derived from an external sources like OpenDRIVE or OpenSCENARIO. // - // For OpenDRIVE the objects should be set as following: + // For OpenDRIVE, references to objects should be set as following: // * reference = URI to map, can remain empty if identical with definiton // in \c GroundTruth::map_reference // * type = "net.asam.opendrive" @@ -53,23 +53,23 @@ message StationaryObject // "bridge" for t_road_objects_bridge // * identifier[1] = id of t_road_objects_object or t_road_objects_bridge // - // For OpenSCENARIO the entities of the type MiscObject, which describes - // partly stationary objects should be set as following: + // For OpenSCENARIO, references to entities of the type MiscObject, which + // describes partly stationary objects, should be set as following: // * reference = URI to the OpenSCENARIO File // * type = "net.asam.openscenario" // * identifier[0] = Entity-Type ("MiscObject") // * identifier[1] = name of MiscObject in Entity // - // \note The following rule, described in OpenDRIVE, should also apply here: + // \note The following rule, described in OpenDRIVE, also applies: // * Objects derived from OpenSCENARIO shall not be mixed with objects // described in OpenDRIVE. // // \note For non-ASAM Standards, it is implementation-specific how // source_reference is resolved. // - // \note The value has to be repeated, as it cannot guarantee, that one - // object is derived from only one origin source, like from one - // scenario file and and from the sensors. + // \note The value has to be repeated because one object may be derived + // from more than one origin source, for example, from a scenario file + // and from sensors. // repeated ExternalReference source_reference = 5; @@ -392,13 +392,13 @@ message MovingObject // optional MovingObjectClassification moving_object_classification = 9; - // Optional external Reference to the MovingObject Source + // Optional external reference to the moving-object source // - // The ExternalReference point to the source of an moving object, if it + // The external reference points to the source of an moving object, if it // is derived from an external sources like OpenSCENARIO. // - // For OpenSCENARIO the entities of the type Vehicle or Pedestrian, - // which describes moving objecs should be set as following: + // For OpenSCENARIO, references to entities of the type Vehicle or + // Pedestrian, which describe moving objects, should be set as following: // * reference = URI to the OpenSCENARIO File // * type = "net.asam.openscenario" // * identifier[0] = Entity-Type ("Vehicle" or "Pedestrian") @@ -409,9 +409,9 @@ message MovingObject // \note For non-ASAM Standards, it is implementation-specific how // source_reference is resolved. // - // \note The value has to be repeated, as it cannot guarantee, that one - // object is derived from only one origin source, like from one map - // and from the sensors. + // \note The value has to be repeated because one object may be derived + // from more than one origin source, for example, from a scenario file + // and from sensors. // repeated ExternalReference source_reference = 10; diff --git a/osi_occupant.proto b/osi_occupant.proto index 0c195dfdc..8b7f6ea83 100644 --- a/osi_occupant.proto +++ b/osi_occupant.proto @@ -23,16 +23,16 @@ message Occupant // optional Classification classification = 2; - // External Reference to the Occupant Source + // External reference to the occupant source. // - // \note For OpenDRIVE and OpenSCENARIO there is no no direct counterpart. + // \note For OpenDRIVE and OpenSCENARIO there is no direct counterpart. // // \note For non-ASAM Standards, it is implementation-specific how // source_reference is resolved. // - // \note The value has to be repeated, as it cannot guarantee, that one - // object is derived from only one origin source, like from one - // scernario file and and from the sensors. + // \note The value has to be repeated because one object may be derived + // from more than one origin source, for example, from a scenario file + // and from sensors. // repeated ExternalReference source_reference = 3; diff --git a/osi_roadmarking.proto b/osi_roadmarking.proto index dda153b3a..5057f178e 100644 --- a/osi_roadmarking.proto +++ b/osi_roadmarking.proto @@ -55,9 +55,9 @@ message RoadMarking // optional Classification classification = 3; - // Optional external Reference to the Roadmarking Source + // Optional external reference to the road-marking source. // - // The ExternalReference point to the source of the surface marking, if it + // The external reference points to the source of the surface marking, if it // is derived from one or more objects or external references. An example // here is the reference to the signal defined in a OpenDRIVE map. // @@ -67,20 +67,17 @@ message RoadMarking // * type = "net.asam.opendrive" // * identifier[0] = id of t_road_signals_signal // - // \note In OpenDRIVE there is also the possibility to define surface - // markings as an object. In this case, the associated object is - // usually referenced within OpenDRIVE using the reference - // t_road_signals_signal_reference, which allows it to be - // identifiable. + // \note With OpenDRIVE, surface markings can also be defined as objects. + // In this case, the associated object is usually referenced within + // OpenDRIVE using the reference t_road_signals_signal_reference. // An additional reference to the object is therefore not necessary. // // \note For non-ASAM Standards, it is implementation-specific how // source_reference is resolved. // - // \note The value has to be repeated, as it cannot guarantee, that one - // Lane-Segment is derived from only one origin segment. It is also - // possible, that multiple sources (map, sensor) should be added as - // reference. + // \note The value has to be repeated, because one lane segment may be + // derived from more than one origin segment. Multiple sources + // may be added as reference as well, for example, a map and sensors. // repeated ExternalReference source_reference = 4; diff --git a/osi_trafficlight.proto b/osi_trafficlight.proto index b3143ce9c..eaf7e11a4 100644 --- a/osi_trafficlight.proto +++ b/osi_trafficlight.proto @@ -42,14 +42,14 @@ message TrafficLight // optional string model_reference = 4; - // Optional external Reference to the Traffic Light Source + // Optional external reference to the traffic light source. // - // The ExternalReference point to the source of the traffic light, if it is - // derived from one or more objects or external references. An example here - // is the reference to the signal defined in a OpenDRIVE map. + // The external reference points to the source of the traffic light, if it + // is derived from one or more objects or external references. // - // For OpenDRIVE the items should be set as following: - // * reference = URI to map, can remain empty if identical with definiton + // For example, to reference a signal defined in an OpenDRIVE map + // the items should be set as following: + // * reference = URI to map, can remain empty if identical with definition // in \c GroundTruth::map_reference // * type = "net.asam.opendrive" // * identifier[0] = id of t_road_signals_signal @@ -57,10 +57,9 @@ message TrafficLight // \note For non-ASAM Standards, it is implementation-specific how // source_reference is resolved. // - // \note The value has to be repeated, as it cannot guarantee, that one - // Lane-Segment is derived from only one origin segment. It is also - // possible, that multiple sources (map, sensor) should be added as - // reference. + // \note The value has to be repeated, because one lane segment may be + // derived from more than one origin segment. Multiple sources + // may be added as reference as well, for example, a map and sensors. // repeated ExternalReference source_reference = 5; diff --git a/osi_trafficsign.proto b/osi_trafficsign.proto index a5590e457..4977e25bc 100644 --- a/osi_trafficsign.proto +++ b/osi_trafficsign.proto @@ -157,13 +157,13 @@ message TrafficSign repeated SupplementarySign supplementary_sign = 3; - // Optional external Reference to the Traffic Sign Source + // Optional external reference to the traffic sign source. // - // The ExternalReference point to the source of the traffic sign, if it is - // derived from one or more objects or external references. An example here - // is the reference to the signal defined in a OpenDRIVE map. + // The external reference point to the source of the traffic sign, if it is + // derived from one or more objects or external references. // - // For OpenDRIVE the items should be set as following: + // For example, to reference a signal defined in an OpenDRIVE map + // the items should be set as following: // * reference = URI to map, can remain empty if identical with definition // in \c GroundTruth::map_reference // * type = "net.asam.opendrive" @@ -173,13 +173,12 @@ message TrafficSign // source_reference is resolved. // // \note If an individual identification of MainSign and SupplementarySign - // is be necessary, this sould be defined via multiple individual + // is necessary, this should be done via multiple individual // entries of this source_reference. // - // \note The value has to be repeated, as it cannot guarantee, that one - // Lane-Segment is derived from only one origin segment. It is also - // possible, that multiple sources (map, sensor) should be added as - // reference. + // \note The value has to be repeated, because one lane segment may be + // derived from more than one origin segment. Multiple sources + // may be added as reference as well, for example, a map and sensors. // repeated ExternalReference source_reference = 4; From f1911d462abecb1d2fdaf1e113f773786a695f80 Mon Sep 17 00:00:00 2001 From: Maximilian Rosin Date: Wed, 26 May 2021 11:32:21 +0200 Subject: [PATCH 13/14] fix(docs): Remove stray line (#465) Signed-off-by: Maximilian Rosin --- osi_common.proto | 1 - 1 file changed, 1 deletion(-) diff --git a/osi_common.proto b/osi_common.proto index ebb9b1803..9a2c2868b 100644 --- a/osi_common.proto +++ b/osi_common.proto @@ -219,7 +219,6 @@ message Identifier // // 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. -// simulation environments. // // \note ExternalReference is optional and can be left empty. // From 3f287349da280a19149355d32f744388b73c3821 Mon Sep 17 00:00:00 2001 From: Maximilian Rosin Date: Wed, 26 May 2021 11:45:31 +0200 Subject: [PATCH 14/14] fix(docs): Align wording across files (#465) Signed-off-by: Maximilian Rosin --- osi_lane.proto | 2 +- osi_object.proto | 13 ++++++++----- osi_roadmarking.proto | 3 ++- osi_trafficlight.proto | 2 +- osi_trafficsign.proto | 2 +- 5 files changed, 13 insertions(+), 9 deletions(-) diff --git a/osi_lane.proto b/osi_lane.proto index ce63abd47..05e4bbcdf 100644 --- a/osi_lane.proto +++ b/osi_lane.proto @@ -56,7 +56,7 @@ message Lane // from one or more objects or external references. // // For example, to reference a lane defined in an OpenDRIVE map - // the items should be set as following: + // the items should be set as follows: // * reference = URI to map, can remain empty if identical with definiton // in \c GroundTruth::map_reference // * type = "net.asam.opendrive" diff --git a/osi_object.proto b/osi_object.proto index e4cab2af9..1578f7bf3 100644 --- a/osi_object.proto +++ b/osi_object.proto @@ -45,7 +45,8 @@ message StationaryObject // The external reference points to the source of a stationary object, if it // is derived from an external sources like OpenDRIVE or OpenSCENARIO. // - // For OpenDRIVE, references to objects should be set as following: + // For example, to reference an object defined in an OpenDRIVE map + // the items should be set as follows: // * reference = URI to map, can remain empty if identical with definiton // in \c GroundTruth::map_reference // * type = "net.asam.opendrive" @@ -53,8 +54,9 @@ message StationaryObject // "bridge" for t_road_objects_bridge // * identifier[1] = id of t_road_objects_object or t_road_objects_bridge // - // For OpenSCENARIO, references to entities of the type MiscObject, which - // describes partly stationary objects, should be set as following: + // For example, to reference OpenSCENARIO entities of the type MiscObject, + // which describe partly stationary objects, the items should be set as + // follows: // * reference = URI to the OpenSCENARIO File // * type = "net.asam.openscenario" // * identifier[0] = Entity-Type ("MiscObject") @@ -397,8 +399,9 @@ message MovingObject // The external reference points to the source of an moving object, if it // is derived from an external sources like OpenSCENARIO. // - // For OpenSCENARIO, references to entities of the type Vehicle or - // Pedestrian, which describe moving objects, should be set as following: + // For example, to reference OpenSCENARIO entities of the type Vehicle or + // Pedestrian, which describe moving objects, the items should be set as + // follows: // * reference = URI to the OpenSCENARIO File // * type = "net.asam.openscenario" // * identifier[0] = Entity-Type ("Vehicle" or "Pedestrian") diff --git a/osi_roadmarking.proto b/osi_roadmarking.proto index 5057f178e..a2acd3716 100644 --- a/osi_roadmarking.proto +++ b/osi_roadmarking.proto @@ -61,7 +61,8 @@ message RoadMarking // is derived from one or more objects or external references. An example // here is the reference to the signal defined in a OpenDRIVE map. // - // For OpenDRIVE the items should be set as following: + // For example, to reference a signal defined in an OpenDRIVE map + // the items should be set as follows: // * reference = URI to map, can remain empty if identical with definiton // in \c GroundTruth::map_reference // * type = "net.asam.opendrive" diff --git a/osi_trafficlight.proto b/osi_trafficlight.proto index eaf7e11a4..d88528cf7 100644 --- a/osi_trafficlight.proto +++ b/osi_trafficlight.proto @@ -48,7 +48,7 @@ message TrafficLight // is derived from one or more objects or external references. // // For example, to reference a signal defined in an OpenDRIVE map - // the items should be set as following: + // the items should be set as follows: // * reference = URI to map, can remain empty if identical with definition // in \c GroundTruth::map_reference // * type = "net.asam.opendrive" diff --git a/osi_trafficsign.proto b/osi_trafficsign.proto index 4977e25bc..999510696 100644 --- a/osi_trafficsign.proto +++ b/osi_trafficsign.proto @@ -163,7 +163,7 @@ message TrafficSign // derived from one or more objects or external references. // // For example, to reference a signal defined in an OpenDRIVE map - // the items should be set as following: + // the items should be set as follows: // * reference = URI to map, can remain empty if identical with definition // in \c GroundTruth::map_reference // * type = "net.asam.opendrive"