Skip to content

Commit c4e82a5

Browse files
committed
Generalize GroundTruth init parameter across models
Signed-off-by: Pierre R. Mai <[email protected]>
1 parent cf890b4 commit c4e82a5

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

doc/specification.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,9 @@ can be packaged as FMUs:
3636
implement surrounding traffic in simplified ways. Optionally traffic
3737
participant models can consume ``osi::TrafficCommand`` as input, to
3838
allow control by a scenario engine as part of the simulation.
39-
Traffic Participant models can consume a global ``osi::GroundTruth``
40-
during initialization.
39+
40+
All models can optionally also consume a global ``osi::GroundTruth``
41+
during initialization.
4142

4243
Additionally complex models that combine various aspects of the model
4344
kinds above are possible, however configuration and setup of such FMUs
@@ -384,20 +385,20 @@ Sensor Data Inputs
384385
processes that generated the data, i.e. the exact details of the
385386
contents will depend on the processing pipeline.
386387

387-
Traffic Participant Initialization
388-
----------------------------------
388+
GroundTruth Initialization Parameters
389+
-------------------------------------
389390

390-
- Traffic Participant models CAN consume an ``osi::GroundTruth`` as an
391+
- All models CAN optionally consume an ``osi::GroundTruth`` as an
391392
initialization parameter.
392393

393-
- If the traffic participant needs a ground truth during initialization, it
394-
MUST have a parameter named ``OSMPGroundTruthInit``. Its purpose is to
395-
provide the Traffic Participant model with a view of the static environment
396-
(i.e. the map), in the OSI format.
394+
- If a model needs a ground truth during initialization, it MUST have
395+
a parameter named ``OSMPGroundTruthInit``. Its purpose is to provide
396+
the model with a view of the static environment (i.e. the map), in
397+
OSI format.
397398

398399
- ``OSMPGroundTruthInit`` MUST be defined as a notional discrete binary
399-
input variable, as specified above, with ``causality="parameter"``,
400-
``variability="fixed"`` and ``initial="exact"``.
400+
input parameter variable, as specified above, with
401+
``causality="parameter"``, ``variability="fixed"`` and ``initial="exact"``.
401402

402403
- The MIME type of the variable MUST specify the ``type=GroundTruth``, e.g.
403404
``application/x-open-simulation-interface; type=GroundTruth; version=3.2.0``.
@@ -410,7 +411,7 @@ Traffic Participant Initialization
410411
it contains MUST NOT be used and has no specified semantics.
411412

412413
- The Ids of objects in ``OSMPGroundTruthInit`` MUST be identical to the Ids of
413-
the same objects contained in later ``OSMPSensorViewIn`` input.
414+
the same objects contained in later ``OSMPSensorViewIn`` or other input data.
414415

415416
- If the model is instantiated multiple times, then all instantiations SHOULD
416417
receive the exact same content stored in the ``OSMPGroundTruthInit``

0 commit comments

Comments
 (0)