Skip to content

Commit 70d830e

Browse files
ClemensLinnhoffpmai
authored andcommitted
Add rules according to notes in the documentation
Signed-off-by: ClemensLinnhoff <[email protected]>
1 parent e64338c commit 70d830e

File tree

4 files changed

+23
-1
lines changed

4 files changed

+23
-1
lines changed

osi_common.proto

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ message ExternalReference
235235

236236
// The type of the external references.
237237
//
238-
// Mandatory value describing the type of the original source.
238+
// Value describing the type of the original source.
239239
//
240240
// For OpenX/ASAM standards it is specified as follows:
241241
// - net.asam.opendrive
@@ -245,6 +245,10 @@ message ExternalReference
245245
// reverse domain name notation with lower-case type field
246246
// is recommended to guarantee unique and interoperable identification.
247247
//
248+
// \rules
249+
// is_set
250+
// \endrules
251+
//
248252
optional string type = 2;
249253

250254
// The external identifier reference value.

osi_detectedobject.proto

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,10 @@ message DetectedMovingObject
325325
// \note This field is mandatory if the \c CandidateMovingObject::type
326326
// is \c MovingObject::TYPE_VEHICLE .
327327
//
328+
// \rules
329+
// check_if this.type is_equal_to 2 else do_check is_set
330+
// \endrules
331+
//
328332
optional MovingObject.VehicleClassification vehicle_classification = 3;
329333

330334
// Pedestrian head pose for behavior prediction. Describes the head
@@ -339,6 +343,10 @@ message DetectedMovingObject
339343
// \note This field is mandatory if the \c CandidateMovingObject.type is
340344
// \c MovingObject::TYPE_PEDESTRIAN
341345
//
346+
// \rules
347+
// check_if this.type is_equal_to 3 else do_check is_set
348+
// \endrules
349+
//
342350
// \par Reference:
343351
//
344352
// [1] Patton, K. T. & Thibodeau, G. A. (2015). <em>Anatomy & Physiology</em>. 9th Edition. Elsevier. Missouri, U.S.A. ISBN 978-0-323-34139-4. p. 1229.
@@ -358,6 +366,10 @@ message DetectedMovingObject
358366
// \note This field is mandatory if the \c CandidateMovingObject::type
359367
// is \c MovingObject::TYPE_PEDESTRIAN
360368
//
369+
// \rules
370+
// check_if this.type is_equal_to 3 else do_check is_set
371+
// \endrules
372+
//
361373
// \par Reference:
362374
// [1] Patton, K. T. & Thibodeau, G. A. (2015). <em>Anatomy & Physiology</em>. 9th Edition. Elsevier. Missouri, U.S.A. ISBN 978-0-323-34139-4. p. 1229.
363375
//

osi_route.proto

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ message Route
4242
//
4343
// \rules
4444
// is_set
45+
// is_globally_unique
4546
// \endrules
4647
//
4748
optional Identifier route_id = 1;

osi_trafficcommand.proto

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,11 @@ message TrafficAction
142142
// \note This id must be unique within all traffic command
143143
// messages exchanged with one traffic participant.
144144
//
145+
// \rules
146+
// is_set
147+
// is_globally_unique
148+
// \endrules
149+
//
145150
optional Identifier action_id = 1;
146151
}
147152

0 commit comments

Comments
 (0)