Skip to content

Commit f2c837f

Browse files
thomassedlmayerpmai
authored andcommitted
Add StreamingUpdate description
Signed-off-by: Thomas Sedlmayer <tsedlmayer@pmsfit.de>
1 parent 5324e14 commit f2c837f

File tree

1 file changed

+15
-22
lines changed

1 file changed

+15
-22
lines changed

osi_streaming.proto renamed to osi_streamingupdate.proto

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
syntax = "proto2";
2+
23
option optimize_for = SPEED;
4+
35
import "osi_version.proto";
46
import "osi_common.proto";
57
import "osi_object.proto";
@@ -9,21 +11,20 @@ import "osi_hostvehicledata.proto";
911
package osi3;
1012

1113
//
12-
// \brief This message is about partial updates from simulation entities.
13-
//
14-
// First time message is being sent:
14+
// \brief The streaming update interface enables simulation entities to send
15+
// partial updates to other modules that favor performance (especially latency)
16+
// over data completeness/consistency (e.g. visualization applications).
1517
//
16-
// ToDo
18+
// Static and/or non-relevant objects can be omitted as required for the
19+
// specific use case. Adding an object's unique id to the repeated field \c
20+
// obsolete_id indicates that it will no longer be updated from then on.
1721
//
18-
// Afterwards:
19-
// As streaming update this message contains objects of which at least one
20-
// property has changed. Unchanged properties are nevertheless sent.
22+
// \note The receiver of partial streaming update messages can only rely on the
23+
// most up-to-date information at the corresponding timestamp.
2124
//
22-
//
23-
//
24-
message Streaming
25+
message StreamingUpdate
2526
{
26-
// The interface version used by the sender (traffic participant model).
27+
// The interface version used by the sender.
2728
//
2829
optional InterfaceVersion version = 1;
2930

@@ -40,21 +41,13 @@ message Streaming
4041
//
4142
repeated StationaryObject stationary_object_update = 4;
4243

43-
// \note It is not expected that static fields are populated. If they
44-
// are, they may be ignored by the receiver of this message, for example, dimensions,
45-
// or vehicle category. All dynamic fields should be populated where known,
46-
// for example, velocity, light states, or future trajectory.
47-
//
48-
// ToDo: how to handle trailers?
49-
// \note The field is repeated because it is possible to have a trailer attached to
50-
// a vehicle, see MovingObject::VehicleClassification::has_trailer and
51-
// MovingObject::VehicleClassification::trailer_id.
44+
// The list of moving objects.
5245
//
5346
repeated MovingObject moving_object_update = 5;
5447

5548
// The list of traffic signs.
5649
//
57-
repeated TrafficSign traffic_sign = 6;
50+
repeated TrafficSign traffic_sign_update = 6;
5851

5952
// The list of traffic lights.
6053
//
@@ -75,7 +68,7 @@ message Streaming
7568
// Entities that will no longer be updated, because they are considered
7669
// obsolete by the sender.
7770
//
78-
// Note: IDs are globally unique.
71+
// \note IDs are globally unique.
7972
//
8073
repeated Identifier obsolete_id = 30;
8174
}

0 commit comments

Comments
 (0)