Skip to content

Add rules according to notes in the documentation #806

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 6, 2024
Merged

Add rules according to notes in the documentation #806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
70d830e
Add rules according to notes in the documentation
ClemensLinnhoff May 3, 2024
6d61dce
Apply suggestions from code review
ClemensLinnhoff May 6, 2024
de45ac8
Remove spaces at end of line
ClemensLinnhoff May 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion osi_common.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,11 @@ message ExternalReference
// reverse domain name notation with lower-case type field
// is recommended to guarantee unique and interoperable identification.
//
optional string type = 2;
// \rules
// is_set
// \endrules
//
optional string type = 2;

// The external identifier reference value.
//
Expand Down
12 changes: 12 additions & 0 deletions osi_detectedobject.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,10 @@ message DetectedMovingObject
// \note This field is mandatory if the \c CandidateMovingObject::type
// is \c MovingObject::TYPE_VEHICLE .
//
// \rules
// check_if this.type is_equal_to 2 else do_check is_set
// \endrules
//
optional MovingObject.VehicleClassification vehicle_classification = 3;

// Pedestrian head pose for behavior prediction. Describes the head
Expand All @@ -339,6 +343,10 @@ message DetectedMovingObject
// \note This field is mandatory if the \c CandidateMovingObject.type is
// \c MovingObject::TYPE_PEDESTRIAN
//
// \rules
// check_if this.type is_equal_to 3 else do_check is_set
// \endrules
//
// \par Reference:
//
// [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.
Expand All @@ -358,6 +366,10 @@ message DetectedMovingObject
// \note This field is mandatory if the \c CandidateMovingObject::type
// is \c MovingObject::TYPE_PEDESTRIAN
//
// \rules
// check_if this.type is_equal_to 3 else do_check is_set
// \endrules
//
// \par Reference:
// [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.
//
Expand Down
4 changes: 4 additions & 0 deletions osi_trafficcommand.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,10 @@ message TrafficAction
// \note This id must be unique within all traffic command
// messages exchanged with one traffic participant.
//
// \rules
// is_set
// \endrules
//
optional Identifier action_id = 1;
}

Expand Down