Skip to content

Commit 402b2af

Browse files
committed
Added changeability information
1 parent 296c549 commit 402b2af

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

osi_trafficsign.proto

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,15 @@ message TrafficSignValue
1616
// Additional value associated with a traffic sign or road marking,
1717
// e.g. value of a speed limit.
1818
//
19+
// \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability or
20+
// TrafficSign::SupplementarySign::Classification::cariability
21+
//
1922
optional double value = 1;
2023

2124
// Unit for additional value.
2225
//
26+
// \note Changeability: Static value
27+
//
2328
optional Unit value_unit = 2;
2429

2530
// Unit for values on traffic sign.
@@ -158,6 +163,8 @@ message TrafficSignValue
158163
// to the sign is indicated therein. The interpretation of this text is
159164
// left to a user-defined procedure.
160165
//
166+
// \note: Changeability: Dynamic value
167+
//
161168
optional string text = 3;
162169
}
163170

@@ -175,15 +182,21 @@ message TrafficSign
175182
// is_globally_unique
176183
// \endrules
177184
//
185+
// \note Changeability: Static value
186+
//
178187
optional Identifier id = 1;
179188

180189
// Main sign, e.g. speed limit 30 km/h
181190
//
191+
// \note Changeability: Dynamic value
192+
//
182193
optional MainSign main_sign = 2;
183194

184195
// Additional supplementary signs, e.g. time limits, modifying the traffic
185196
// sign.
186197
//
198+
// \note Changeability: Dynamic value
199+
//
187200
repeated SupplementarySign supplementary_sign = 3;
188201

189202

@@ -210,6 +223,8 @@ message TrafficSign
210223
// derived from more than one origin segment. Multiple sources
211224
// may be added as reference as well, for example, a map and sensors.
212225
//
226+
// \note Changeability: Static value
227+
//
213228
repeated ExternalReference source_reference = 4;
214229

215230
//
@@ -231,17 +246,23 @@ message TrafficSign
231246
// This x-axis points from the traffic sign's image in the direction
232247
// from where a 'viewer' could see the traffic sign image.
233248
//
249+
// \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability
250+
//
234251
optional BaseStationary base = 1;
235252

236253
// The classification of the traffic sign.
237254
//
255+
// \note Changeability: Dynamic value
256+
//
238257
optional Classification classification = 2;
239258

240259
// Opaque reference of an associated 3D model of the traffic sign.
241260
//
242261
// \note It is implementation-specific how model_references are resolved to
243262
// 3d models.
244263
//
264+
// \note Changeability: Static value
265+
//
245266
optional string model_reference = 3;
246267

247268
//
@@ -278,6 +299,8 @@ message TrafficSign
278299
// content (e.g., electronic sign bridge) and/or regarding its
279300
// position on the road.
280301
//
302+
// \note Changeability: Static value
303+
//
281304
optional Variability variability = 1;
282305

283306
// The type of the traffic sign.
@@ -288,6 +311,8 @@ message TrafficSign
288311
// introduced 4-tupel traffic sign catalog specification as used in
289312
// <a href="https://releases.asam.net/OpenDRIVE/1.6.0/ASAM_OpenDRIVE_BS_V1-6-0.html#_signals">OpenDRIVE</a>.
290313
//
314+
// \note Changeability: Static value
315+
//
291316
optional Type type = 2;
292317

293318
// Additional value associated with the traffic sign, e.g. value of
@@ -296,6 +321,8 @@ message TrafficSign
296321
// \note Field need not be set if traffic sign type does not require
297322
// it.
298323
//
324+
// \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability
325+
//
299326
optional TrafficSignValue value = 3;
300327

301328
// Some traffic signs have an additional arrow symbol as an
@@ -325,6 +352,8 @@ message TrafficSign
325352
// introduced 4-tupel traffic sign catalog specification as used in
326353
// <a href="https://releases.asam.net/OpenDRIVE/1.6.0/ASAM_OpenDRIVE_BS_V1-6-0.html#_signals">OpenDRIVE</a>.
327354
//
355+
// \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability
356+
//
328357
optional DirectionScope direction_scope = 4;
329358

330359
// The IDs of the lanes that the sign is assigned to.
@@ -337,6 +366,8 @@ message TrafficSign
337366
// refers_to: Lane
338367
// \endrules
339368
//
369+
// \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability
370+
//
340371
repeated Identifier assigned_lane_id = 5;
341372

342373
// Some traffic signs exist in two variants that have
@@ -355,11 +386,15 @@ message TrafficSign
355386
// introduced 4-tupel traffic sign catalog specification as used in
356387
// <a href="https://releases.asam.net/OpenDRIVE/1.6.0/ASAM_OpenDRIVE_BS_V1-6-0.html#_signals">OpenDRIVE</a>.
357388
//
389+
// \note Changeability: Static value
390+
//
358391
optional bool vertically_mirrored = 6;
359392

360393
// Boolean flag to indicate that a traffic sign is taken out of service.
361394
// This can be achieved by visibly crossing the sign or covering it completely.
362395
//
396+
// \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability
397+
//
363398
optional bool is_out_of_service = 7;
364399

365400
// Country specification of the traffic sign catalog specification
@@ -371,6 +406,8 @@ message TrafficSign
371406
// https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, or the
372407
// special OpenDRIVE country for generic signs.<br>
373408
//
409+
// \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability
410+
//
374411
optional string country = 8;
375412

376413
// Revision specification of the traffic sign catalog specification
@@ -381,6 +418,8 @@ message TrafficSign
381418
// The year the traffic rules came into force. <br>
382419
// e.g. "2017"
383420
//
421+
// \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability
422+
//
384423
optional string country_revision = 9;
385424

386425
// Code specification of the traffic sign catalog specification
@@ -393,6 +432,8 @@ message TrafficSign
393432
// code is only unique in combination with #country and #country_revision. <br>
394433
// e.g. http://www.vzkat.de/2017/VzKat.htm
395434
//
435+
// \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability
436+
//
396437
optional string code = 10;
397438

398439
// Sub-code specification of the traffic sign catalog specification
@@ -406,13 +447,17 @@ message TrafficSign
406447
// and #code. <br>
407448
// e.g. http://www.vzkat.de/2017/VzKat.htm
408449
//
450+
// \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability
451+
//
409452
optional string sub_code = 11;
410453

411454
// Assignment of this object to logical lanes.
412455
//
413456
// \note OSI uses singular instead of plural for repeated field
414457
// names.
415458
//
459+
// \note Changeability: Depending: See \c TrafficSign::MainSign::Classification::variability
460+
//
416461
repeated LogicalLaneAssignment logical_lane_assignment = 12;
417462

418463
// Definition of traffic sign types.
@@ -5594,17 +5639,23 @@ message TrafficSign
55945639
// supplementary traffic sign's image in the direction from where a
55955640
// 'viewer' could see the supplementary traffic sign image.
55965641
//
5642+
// \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability
5643+
//
55975644
optional BaseStationary base = 1;
55985645

55995646
// The classification of the supplementary traffic sign.
56005647
//
5648+
// \note Changeability: Dynamic value
5649+
//
56015650
optional Classification classification = 2;
56025651

56035652
// Opaque reference of an associated 3D model of the supplementary traffic sign.
56045653
//
56055654
// \note It is implementation-specific how model_references are resolved to
56065655
// 3d models.
56075656
//
5657+
// \note Changeability: Static value
5658+
//
56085659
optional string model_reference = 3;
56095660

56105661
//
@@ -5628,6 +5679,8 @@ message TrafficSign
56285679
{
56295680
// Variability.
56305681
//
5682+
// \note Changeability: Static value
5683+
//
56315684
optional Variability variability = 1;
56325685

56335686
// Definition of supplementary sign types.
@@ -9081,6 +9134,8 @@ message TrafficSign
90819134
// \note OSI uses singular instead of plural for repeated field
90829135
// names.
90839136
//
9137+
// \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability
9138+
//
90849139
repeated TrafficSignValue value = 3;
90859140

90869141
// The IDs of the lanes that the sign is assigned to.
@@ -9093,6 +9148,8 @@ message TrafficSign
90939148
// refers_to: Lane
90949149
// \endrules
90959150
//
9151+
// \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability
9152+
//
90969153
repeated Identifier assigned_lane_id = 4;
90979154

90989155
// This enumerator indicates a traffic actor (e.g.
@@ -9105,6 +9162,8 @@ message TrafficSign
91059162
// introduced 4-tupel traffic sign catalog specification as used in
91069163
// <a href="https://releases.asam.net/OpenDRIVE/1.6.0/ASAM_OpenDRIVE_BS_V1-6-0.html#_signals">OpenDRIVE</a>.
91079164
//
9165+
// \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability
9166+
//
91089167
repeated Actor actor = 5;
91099168

91109169
// A direction arrow shown on the supplementary sign.
@@ -9115,11 +9174,15 @@ message TrafficSign
91159174
// introduced 4-tupel traffic sign catalog specification as used in
91169175
// <a href="https://releases.asam.net/OpenDRIVE/1.6.0/ASAM_OpenDRIVE_BS_V1-6-0.html#_signals">OpenDRIVE</a>.
91179176
//
9177+
// \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability
9178+
//
91189179
repeated Arrow arrow = 6;
91199180

91209181
// Boolean flag to indicate that the supplementary traffic sign is taken out of service.
91219182
// This can be achieved by visibly crossing the sign or covering it completely.
91229183
//
9184+
// \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability
9185+
//
91239186
optional bool is_out_of_service = 7;
91249187

91259188
// Country specification of the traffic sign catalog specification
@@ -9131,6 +9194,8 @@ message TrafficSign
91319194
// https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, or the
91329195
// special OpenDRIVE country for generic signs.<br>
91339196
//
9197+
// \note Changeability: Static value
9198+
//
91349199
optional string country = 8;
91359200

91369201
// Revision specification of the traffic sign catalog specification
@@ -9141,6 +9206,8 @@ message TrafficSign
91419206
// The year the traffic rules came into force. <br>
91429207
// e.g. "2017"
91439208
//
9209+
// \note Changeability: Static value
9210+
//
91449211
optional string country_revision = 9;
91459212

91469213
// Code specification of the traffic sign catalog specification
@@ -9153,6 +9220,8 @@ message TrafficSign
91539220
// code is only unique in combination with #country and #country_revision. <br>
91549221
// e.g. http://www.vzkat.de/2017/VzKat.htm
91559222
//
9223+
// \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability
9224+
//
91569225
optional string code = 10;
91579226

91589227
// Sub-code specification of the traffic sign catalog specification
@@ -9166,13 +9235,17 @@ message TrafficSign
91669235
// and #code. <br>
91679236
// e.g. http://www.vzkat.de/2017/VzKat.htm
91689237
//
9238+
// \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability
9239+
//
91699240
optional string sub_code = 11;
91709241

91719242
// Assignment of this object to logical lanes.
91729243
//
91739244
// \note OSI uses singular instead of plural for repeated field
91749245
// names.
91759246
//
9247+
// \note Changeability: Depending: See \c TrafficSign::SupplementarySign::Classification::variability
9248+
//
91769249
repeated LogicalLaneAssignment logical_lane_assignment = 12;
91779250

91789251
// Definition of the traffic actors the supplementary sign makes

0 commit comments

Comments
 (0)