diff --git a/doc/architecture/architecture_overview.adoc b/doc/architecture/architecture_overview.adoc index 13e5d70b9..f0d8b4f9b 100644 --- a/doc/architecture/architecture_overview.adoc +++ b/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. \ No newline at end of file diff --git a/osi_datarecording.proto b/osi_datarecording.proto index 18cf33f77..a44bf5a3d 100644 --- a/osi_datarecording.proto +++ b/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; } diff --git a/osi_detectedlane.proto b/osi_detectedlane.proto index 34cf5e0b2..6c8159d18 100644 --- a/osi_detectedlane.proto +++ b/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 diff --git a/osi_detectedobject.proto b/osi_detectedobject.proto index 078ee7e00..41d0f240b 100644 --- a/osi_detectedobject.proto +++ b/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. diff --git a/osi_detectedoccupant.proto b/osi_detectedoccupant.proto index 86bacb8c0..001c7e473 100644 --- a/osi_detectedoccupant.proto +++ b/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; // diff --git a/osi_detectedroadmarking.proto b/osi_detectedroadmarking.proto index f142a9449..cb72f39b5 100644 --- a/osi_detectedroadmarking.proto +++ b/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. diff --git a/osi_detectedtrafficlight.proto b/osi_detectedtrafficlight.proto index acaa425a1..f8edb3530 100644 --- a/osi_detectedtrafficlight.proto +++ b/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. diff --git a/osi_detectedtrafficsign.proto b/osi_detectedtrafficsign.proto index 4d7320d76..1183536f2 100644 --- a/osi_detectedtrafficsign.proto +++ b/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; // diff --git a/osi_featuredata.proto b/osi_featuredata.proto index 27d7bcbf9..f5d49993f 100644 --- a/osi_featuredata.proto +++ b/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; } diff --git a/osi_groundtruth.proto b/osi_groundtruth.proto index 8b7d8ceb6..5cf5477b5 100644 --- a/osi_groundtruth.proto +++ b/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. diff --git a/osi_logicaldetectiondata.proto b/osi_logicaldetectiondata.proto index b28f8f03b..b7b3865d5 100644 --- a/osi_logicaldetectiondata.proto +++ b/osi_logicaldetectiondata.proto @@ -29,8 +29,6 @@ message LogicalDetectionData // Logical detections are given with respect to the reference frame of the logical/virtual sensor // \c SensorView::mounting_position (e.g. center of rear axle of the ego car) // - // \note OSI uses singular instead of plural for repeated field names. - // repeated LogicalDetection logical_detection = 3; } diff --git a/osi_object.proto b/osi_object.proto index fc2aa9bde..b69e9f6f6 100644 --- a/osi_object.proto +++ b/osi_object.proto @@ -408,8 +408,6 @@ message MovingObject // \note Might be multiple if the object is switching lanes or moving from // one lane into another following lane. // - // \note OSI uses singular instead of plural for repeated field names. - // // \note DEPRECATED: Use assigned_lane_id in MovingObjectClassification // instead. // diff --git a/osi_sensordata.proto b/osi_sensordata.proto index a6e3ac365..689149370 100644 --- a/osi_sensordata.proto +++ b/osi_sensordata.proto @@ -198,8 +198,6 @@ message SensorData // for reference purposes. For complex sensors or logic models this // can be multiple copies. // - // \note OSI uses singular instead of plural for repeated field names. - // repeated SensorView sensor_view = 8; // The timestamp of the last real-world measurement (e.g. GT input) that @@ -226,8 +224,6 @@ message SensorData // The list of moving objects detected by the sensor as perceived by // the sensor. // - // \note OSI uses singular instead of plural for repeated field names. - // repeated DetectedMovingObject moving_object = 13; // General information about the \c DetectedTrafficSign . @@ -236,8 +232,6 @@ message SensorData // The list of traffic signs detected by the sensor. // - // \note OSI uses singular instead of plural for repeated field names. - // repeated DetectedTrafficSign traffic_sign = 15; // General information about the \c DetectedTrafficLight . @@ -246,8 +240,6 @@ message SensorData // The list of traffic lights detected by the sensor. // - // \note OSI uses singular instead of plural for repeated field names. - // repeated DetectedTrafficLight traffic_light = 17; // General information about the \c DetectedRoadMarking . @@ -257,8 +249,6 @@ message SensorData // The list of road markings detected by the sensor. // This excludes lane boundary markings. // - // \note OSI uses singular instead of plural for repeated field names. - // repeated DetectedRoadMarking road_marking = 19; // General information about the \c DetectedLaneBoundary . @@ -267,8 +257,6 @@ message SensorData // The list of lane boundary markings detected by the sensor. // - // \note OSI uses singular instead of plural for repeated field names. - // repeated DetectedLaneBoundary lane_boundary = 21; // General information about the \c DetectedLane . @@ -277,8 +265,6 @@ message SensorData // The list of lanes detected by the sensor // - // \note OSI uses singular instead of plural for repeated field names. - // repeated DetectedLane lane = 23; // General information about the \c DetectedOccupant . @@ -287,8 +273,6 @@ message SensorData // The list of occupants of the host vehicle // - // \note OSI uses singular instead of plural for repeated field names. - // repeated DetectedOccupant occupant = 25; // Low level feature data interface. diff --git a/osi_sensorview.proto b/osi_sensorview.proto index e6331cb76..a890261a7 100644 --- a/osi_sensorview.proto +++ b/osi_sensorview.proto @@ -131,32 +131,22 @@ message SensorView // Generic SensorView(s). // - // \note OSI uses singular instead of plural for repeated field names. - // repeated GenericSensorView generic_sensor_view = 1000; // Radar-specific SensorView(s). // - // \note OSI uses singular instead of plural for repeated field names. - // repeated RadarSensorView radar_sensor_view = 1001; // Lidar-specific SensorView(s). // - // \note OSI uses singular instead of plural for repeated field names. - // repeated LidarSensorView lidar_sensor_view = 1002; // Camera-specific SensorView(s). // - // \note OSI uses singular instead of plural for repeated field names. - // repeated CameraSensorView camera_sensor_view = 1003; // Ultrasonic-specific SensorView(s). // - // \note OSI uses singular instead of plural for repeated field names. - // repeated UltrasonicSensorView ultrasonic_sensor_view = 1004; } @@ -188,8 +178,6 @@ message RadarSensorView // This field includes one entry for each ray, in left-to-right, // top-to-bottom order (think of scan lines in a TV). // - // \note OSI uses singular instead of plural for repeated field names. - // repeated Reflection reflection = 2; // @@ -261,8 +249,6 @@ message LidarSensorView // This field includes one entry for each ray, in left-to-right, // top-to-bottom order (think of scan lines in a TV). // - // \note OSI uses singular instead of plural for repeated field names. - // repeated Reflection reflection = 2; // diff --git a/osi_sensorviewconfiguration.proto b/osi_sensorviewconfiguration.proto index 5af4a7a91..e5c45c8f7 100644 --- a/osi_sensorviewconfiguration.proto +++ b/osi_sensorviewconfiguration.proto @@ -201,36 +201,26 @@ message SensorViewConfiguration // Generic Sensor View Configuration(s). // - // \note OSI uses singular instead of plural for repeated field names. - // repeated GenericSensorViewConfiguration generic_sensor_view_configuration = 1000; // Radar-specific Sensor View Configuration(s). // - // \note OSI uses singular instead of plural for repeated field names. - // repeated RadarSensorViewConfiguration radar_sensor_view_configuration = 1001; // Lidar-specific Sensor View Configuration(s). // - // \note OSI uses singular instead of plural for repeated field names. - // repeated LidarSensorViewConfiguration lidar_sensor_view_configuration = 1002; // Camera-specific Sensor View Configuration(s). // - // \note OSI uses singular instead of plural for repeated field names. - // repeated CameraSensorViewConfiguration camera_sensor_view_configuration = 1003; // Ultrasonic-specific Sensor View Configuration(s). // - // \note OSI uses singular instead of plural for repeated field names. - // repeated UltrasonicSensorViewConfiguration ultrasonic_sensor_view_configuration = 1004; } @@ -426,14 +416,10 @@ message RadarSensorViewConfiguration // This represents the TX antenna diagram // - // \note OSI uses singular instead of plural for repeated field names. - // repeated AntennaDiagramEntry tx_antenna_diagram = 10; // This represents the RX antenna diagram // - // \note OSI uses singular instead of plural for repeated field names. - // repeated AntennaDiagramEntry rx_antenna_diagram = 11; // diff --git a/osi_trafficsign.proto b/osi_trafficsign.proto index 5be493ebc..b3136e4d9 100644 --- a/osi_trafficsign.proto +++ b/osi_trafficsign.proto @@ -152,8 +152,6 @@ message TrafficSign // Additional supplementary signs, e.g. time limits, modifying the traffic // sign. // - // \note OSI uses singular instead of plural for repeated field names. - // repeated SupplementarySign supplementary_sign = 3;