Merge pull request #818 from OpenSimulationInterface/817-support-more-top-level-messages-in-ositrace

Add more top-level messages to OSITrace

Author: pmai

doc/architecture/architecture_overview.adoc

@@ -8,7 +8,7 @@ OSI contains an object-based environment description that uses the message forma
 Google developed and maintains the Protocol Buffer library.
 OSI defines top-level messages that are used to exchange data between separate models.
 Top-level messages define the `GroundTruth` interface, the `SensorData` interface, and – since OSI version 3.0.0 – the interfaces `SensorView` and `SensorViewConfiguration`.
-Further top-level messages that were added in later versions of OSI are `TrafficCommand`, `TrafficUpdate`, `MotionRequest`, and `StreamingUpdate`.
+Further top-level messages that were added in later versions of OSI are `HostVehicleData`, `TrafficCommand`, `TrafficCommandUpdate`, `TrafficUpdate`, `MotionRequest`, and `StreamingUpdate`.
 
 The following figure shows the interfaces and models involved in modeling a sensor.
 

doc/architecture/trace_file_naming.adoc

@@ -14,23 +14,35 @@ The names of OSI trace files should have the following format:
 
 **Types**
 
-`sd`::
-Trace file contains `SensorData` messages.
-
 `sv`::
 Trace file contains `SensorView` messages.
 
+`svc`::
+Trace file contains `SensorViewConfiguration` messages.
+
 `gt`::
 Trace file contains `GroundTruth` messages.
 
-`tu`::
-Trace file contains `TrafficUpdate` messages.
+`hvd`::
+Trace file contains `HostVehicleData` messages.
+
+`sd`::
+Trace file contains `SensorData` messages.
 
 `tc`::
 Trace file contains `TrafficCommand` messages.
 
-`hvd`::
-Trace file contains `HostVehicleData` messages.
+`tcu`::
+Trace file contains `TrafficCommandUpdate` messages.
+
+`tu`::
+Trace file contains `TrafficUpdate` messages.
+
+`mr`::
+Trace file contains `MotionRequest` messages.
+
+`su`::
+Trace file contains `StreamingUpdate` messages.
 
 **Example**
 

osi3trace/osi2read.py

@@ -28,7 +28,7 @@ def command_line_arguments():
         "--type",
         "-t",
         help="Name of the type used to serialize data.",
-        choices=["SensorView", "GroundTruth", "SensorData"],
+        choices=OSITrace.message_types(),
         default="SensorView",
         type=str,
         required=False,

osi3trace/osi_trace.py

@@ -6,14 +6,28 @@
 import struct
 
 from osi3.osi_sensorview_pb2 import SensorView
+from osi3.osi_sensorviewconfiguration_pb2 import SensorViewConfiguration
 from osi3.osi_groundtruth_pb2 import GroundTruth
+from osi3.osi_hostvehicledata_pb2 import HostVehicleData
 from osi3.osi_sensordata_pb2 import SensorData
+from osi3.osi_trafficcommand_pb2 import TrafficCommand
+from osi3.osi_trafficcommandupdate_pb2 import TrafficCommandUpdate
+from osi3.osi_trafficupdate_pb2 import TrafficUpdate
+from osi3.osi_motionrequest_pb2 import MotionRequest
+from osi3.osi_streamingupdate_pb2 import StreamingUpdate
 
 
 MESSAGES_TYPE = {
     "SensorView": SensorView,
+    "SensorViewConfiguration": SensorViewConfiguration,
     "GroundTruth": GroundTruth,
+    "HostVehicleData": HostVehicleData,
     "SensorData": SensorData,
+    "TrafficCommand": TrafficCommand,
+    "TrafficCommandUpdate": TrafficCommandUpdate,
+    "TrafficUpdate": TrafficUpdate,
+    "MotionRequest": MotionRequest,
+    "StreamingUpdate": StreamingUpdate,
 }
 
 
@@ -25,6 +39,11 @@ def map_message_type(type_name):
         """Map the type name to the protobuf message type."""
         return MESSAGES_TYPE[type_name]
 
+    @staticmethod
+    def message_types():
+        """Message types that OSITrace supports."""
+        return list(MESSAGES_TYPE.keys())
+
     def __init__(self, path=None, type_name="SensorView", cache_messages=False):
         self.type = self.map_message_type(type_name)
         self.file = None