@@ -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+ //
224226message 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
0 commit comments