Skip to content

Commit e2b2aee

Browse files
DerBaertigepmai
authored andcommitted
Second part from code review
Signed-off-by: Georg Seifert <georg.seifert@carissma.eu>
1 parent e7f323f commit e2b2aee

File tree

7 files changed

+41
-9
lines changed

7 files changed

+41
-9
lines changed

osi_common.proto

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -221,20 +221,39 @@ message Identifier
221221
// This could be other OpenX standards, 3rd-party standards or user-defined objects.
222222
// simulation environments.
223223
//
224+
// \note The ExternalReference is an optional value and can be left empty.
225+
//
224226
message ExternalReference
225227
{
226228
// The source of the external references
227229
//
228-
// Defines the original source of an object as an URI.
229-
// The URI should be follow the syntax according to
230+
// Defines the original source of an object as uniquely identifiable reference.
231+
// In case of using \c GroundTruth::map_reference or
232+
// \c GroundTruth::model_reference, the reference can be left empty.
233+
// If not otherwise required, an URI is suggested and should follow the syntax according to
230234
// \link https://tools.ietf.org/html/rfc3986 RFC 3986\endlink.
231235
//
236+
//
232237
optional string reference = 1;
233238

234239
// The type of the external references
235240
//
236241
// Must be used to describe the type of the original source.
237242
//
243+
// For OpenX/ASAM standards it is specified as follows,
244+
// the PATCH-Value is optional:
245+
// - OpenDRIVE 1.6
246+
// - OpenDRIVE 1.6.0
247+
// - OpenDRIVE 1.6.1
248+
// - OpenSCENARIO 1.0
249+
// - OpenSCENARIO 1.0.0
250+
// - OpenSCENARIO 1.1
251+
// - OpenSCENARIO 1.1.0
252+
//
253+
// For third-party standards and user-defined objects the
254+
// Reverse Domain Name Notation is suggested, to guarantee unique
255+
// and interoperable identifications.
256+
//
238257
optional string type = 2;
239258

240259
// The external identifier reference value.
@@ -245,6 +264,19 @@ message ExternalReference
245264
// E.g. referencing a unique lane in OpenDRIVE
246265
// (RoadId --> String, S-Value of LaneSection --> Double, LaneId --> Int)
247266
//
267+
// \note The detailed description of the identifiers and how they are
268+
// used for referencing external objects are given in the individual
269+
// messages, where it is deployed.
270+
//
271+
// \see EnvironmentalConditions::source_reference
272+
// \see Lane::source_reference
273+
// \see LaneBoundary::source_reference
274+
// \see StationaryObject::source_reference
275+
// \see MovingObject::source_reference
276+
// \see RoadMarking::source_reference
277+
// \see TrafficLight::source_reference
278+
// \see TrafficSign::source_reference
279+
//
248280
repeated string identifier = 3;
249281
}
250282

osi_environment.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ message EnvironmentalConditions
8888
//
8989
optional Fog fog = 7;
9090

91-
// External Reference to the Environmental Condition Sources
91+
// Optional external Reference to the Environmental Condition Sources
9292
//
9393
// \note For OpenDRIVE and OpenSECNARIO there is no direct counterpart.
9494
//

osi_lane.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ message Lane
5050
//
5151
optional Classification classification = 2;
5252

53-
// External Reference to the Lane Source
53+
// Optional external Reference to the Lane Source
5454
//
5555
// The ExternalReference point to the source of the lane, if it is derived
5656
// from one or more objects or external references. An example here is the
@@ -750,7 +750,7 @@ message LaneBoundary
750750
//
751751
optional Classification classification = 3;
752752

753-
// External Reference to the Lane Boundary Source
753+
// Optional external Reference to the Lane Boundary Source
754754
//
755755
// \note For OpenDRIVE 1.6 there is no direct possibility to reference the
756756
// RoadMark, as there is no unique identifier in this sub-object.

osi_object.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ message MovingObject
392392
//
393393
optional MovingObjectClassification moving_object_classification = 9;
394394

395-
// External Reference to the MovingObject Source
395+
// Optional external Reference to the MovingObject Source
396396
//
397397
// The ExternalReference point to the source of an moving object, if it
398398
// is derived from an external sources like OpenSCENARIO.

osi_roadmarking.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ message RoadMarking
5555
//
5656
optional Classification classification = 3;
5757

58-
// External Reference to the Roadmarking Source
58+
// Optional external Reference to the Roadmarking Source
5959
//
6060
// The ExternalReference point to the source of the surface marking, if it
6161
// is derived from one or more objects or external references. An example

osi_trafficlight.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ message TrafficLight
4242
//
4343
optional string model_reference = 4;
4444

45-
// External Reference to the Traffic Light Source
45+
// Optional external Reference to the Traffic Light Source
4646
//
4747
// The ExternalReference point to the source of the traffic light, if it is
4848
// derived from one or more objects or external references. An example here

osi_trafficsign.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ message TrafficSign
157157
repeated SupplementarySign supplementary_sign = 3;
158158

159159

160-
// External Reference to the Traffic Sign Source
160+
// Optional external Reference to the Traffic Sign Source
161161
//
162162
// The ExternalReference point to the source of the traffic sign, if it is
163163
// derived from one or more objects or external references. An example here

0 commit comments

Comments
 (0)