Merge pull request #610 from OpenSimulationInterface/docu/remove_note_on_singular-plural

Docu/remove note on singular plural

Author: pmai

doc/architecture/architecture_overview.adoc

@@ -29,13 +29,16 @@ The `HostVehicleData` interface describes the measured internal states of a traf
 OSI currently provides only limited support for data structures that describe measured internal states of traffic participants.
 Actuator intentions are currently not covered by OSI and must be handled using a different data description format.
 
-All fields in an interface are set to `optional`.
+NOTE: OSI uses singular instead of plural for `repeated` field names.
+
+NOTE: All fields in an interface are set to `optional`.
 `required` is not used.
+
 This has been done to allow backward-compatible changes in the field.
 Additionally, this is the default behavior in Protocol Buffer version 3 that no longer has the `required` type.
 Setting all fields to `optional` thus ensures update compatibility.
 However, this does not mean that it is optional to fill the field.
 For the purpose of providing a complete interface, all existing fields should be set, unless not setting a field carries a specific meaning, as indicated in the accompanying comment.
 
-All field numbers equal to or greater than 10000 are available for user-specific extensions via custom fields.
+NOTE: All field numbers equal to or greater than 10000 are available for user-specific extensions via custom fields.
 No future evolution of OSI will therefore use field numbers equal to or greater than 10000.

osi_datarecording.proto

@@ -14,8 +14,6 @@ message SensorDataSeries
 {
     // List of sensor data messages for subsequent time steps.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated SensorData sensor_data = 1;
 }
 
@@ -27,7 +25,5 @@ message SensorDataSeriesList
 {
     // List of sensor data for multiple sensors at subsequent time steps.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated SensorDataSeries sensor = 1;
 }

osi_detectedlane.proto

@@ -19,8 +19,6 @@ message DetectedLane
 
     // A list of candidates for this lane as estimated by the sensor.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated CandidateLane candidate = 2;
 
     //
@@ -65,8 +63,6 @@ message DetectedLaneBoundary
     // A list of candidates for this lane boundary as estimated by the
     // sensor.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated CandidateLaneBoundary candidate = 2;
 
     // The list of individual points defining the location of the lane boundary

osi_detectedobject.proto

@@ -21,8 +21,6 @@ message DetectedItemHeader
 
     // The ID of the original detected item in the ground truth.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated Identifier ground_truth_id = 2;
 
     // The estimated probability that this detected item really exists, not
@@ -63,8 +61,6 @@ message DetectedItemHeader
     // detections ( \c ...Detection::object_id = 'this detected item' ) and
     // the sensors (their IDs) to which these detections belong.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated Identifier sensor_id = 6;
 
     // Definition of measurement states.
@@ -116,8 +112,6 @@ message DetectedStationaryObject
     // A list of candidates for this stationary object as estimated by the
     // sensor.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated CandidateStationaryObject candidate = 4;
 
     // The dominating color of the material of the structure.
@@ -221,8 +215,6 @@ message DetectedMovingObject
     // A list of candidates for this moving object as estimated by the
     // sensor (e.g. pedestrian, car).
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated CandidateMovingObject candidate = 8;
 
     // The dominating color of the material of the moving object.

osi_detectedoccupant.proto

@@ -19,8 +19,6 @@ message DetectedOccupant
     // A list of candidates for this occupant as estimated by the
     // sensor.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated CandidateOccupant candidate = 2;
 
     //

osi_detectedroadmarking.proto

@@ -55,8 +55,6 @@ message DetectedRoadMarking
     // A list of candidates for this road marking as estimated by the
     // sensor.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated CandidateRoadMarking candidate = 4;
 
     // The visual color of the material of the road marking.

osi_detectedtrafficlight.proto

@@ -39,8 +39,6 @@ message DetectedTrafficLight
     // A list of candidates for this traffic light as estimated by the
     // sensor.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated CandidateTrafficLight candidate = 4;
 
     // The visual color of the traffic light.

osi_detectedtrafficsign.proto

@@ -25,8 +25,6 @@ message DetectedTrafficSign
 
     // A list of additional supplementary sign(s) as detected by the sensor.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated DetectedSupplementarySign supplementary_sign = 3;
 
     //

osi_featuredata.proto

@@ -26,20 +26,14 @@ message FeatureData
 
     // Radar detections for multiple radar sensors (sensor fusion).
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated RadarDetectionData radar_sensor = 2;
 
     // Lidar detections for multiple lidar sensors (sensor fusion).
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated LidarDetectionData lidar_sensor = 3;
 
     // Ultrasonic detections for multiple ultrasonic sensors (sensor fusion).
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     // \note Required for ultrasonic sensors: Detections will be send by the
     // emitting ultrasonic sensor, including all indirect detections received
     // by neighbouring sensors.
@@ -48,8 +42,6 @@ message FeatureData
 
     // Camera detections for multiple camera sensors (sensor fusion).
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated CameraDetectionData camera_sensor = 5;
 }
 
@@ -249,8 +241,6 @@ message RadarDetectionData
 
     // List of radar detections constituting the radar detection list.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated RadarDetection detection = 2;
 }
 
@@ -358,8 +348,6 @@ message LidarDetectionData
 
     // List of lidar detections.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated LidarDetection detection = 2;
 }
 
@@ -519,15 +507,11 @@ message UltrasonicDetectionData
 
     // List of ultrasonic detections.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated UltrasonicDetection detection = 2;
 
     // List of ultrasonic indirect detections (sender and receiver sensors are
     // not the same).
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated UltrasonicIndirectDetection indirect_detection = 4;
 }
 
@@ -676,14 +660,10 @@ message CameraDetectionData
 
     // List of camera detections.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated CameraDetection detection = 2;
 
     // List of points which are used by detections.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated CameraPoint point = 4;
 }
 

osi_groundtruth.proto

@@ -75,51 +75,35 @@ message GroundTruth
     // The list of stationary objects (excluding traffic signs and traffic
     // lights).
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated StationaryObject stationary_object = 4;
 
     // The list of all other moving objects including all (host) vehicles.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated MovingObject moving_object = 5;
 
     // The list of traffic signs.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated TrafficSign traffic_sign = 6;
 
     // The list of traffic lights.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated TrafficLight traffic_light = 7;
 
     // The list of road surface markings (lane markings are excluded and
     // defined as \c LaneBoundary).
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated RoadMarking road_marking = 8;
 
     // The list of lane boundaries.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated LaneBoundary lane_boundary = 9;
 
     // The list of lanes forming a road network.
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated Lane lane = 10;
 
     // The list of passengers in the (host) vehicle(s).
     //
-    // \note OSI uses singular instead of plural for repeated field names.
-    //
     repeated Occupant occupant = 11;
 
     // Conditions of the environment.