Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Pierre R. Mai <[email protected]>
  • Loading branch information
ClemensLinnhoff and pmai authored Mar 27, 2024
1 parent ed06f86 commit 84927bb
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions doc/spec/ground_truth_init_parameters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ endif::[]
= Ground truth initialization parameters

All models can optionally consume `osi3::GroundTruth` via an initialization parameter called `OSMPGroundTruthInit`.
Its purpose is to provide the model with information that does not change throughout the simulation, for example the map in OSI format or the model_reference of a MovingObject.
Its purpose is to provide the model with information in OSI format that does not change throughout the simulation, i.e. is considered static.
This can encompass, for example, the road network or referenced 3D models.

`OSMPGroundTruthInit` contains all data encountered by the model that does not change during a simulation run, for example, roads.
All data provided in this message can be assumed by the receiver to not change during the simulation run.
`OSMPGroundTruthInit` contains only data encountered by the model that does not change during a simulation run.
All data provided in this message can be assumed by the receiver to be static during the simulation run.

If the model is instantiated multiple times, all instantiations should receive the exact same content.
This allows a model to do expensive map calculations or loading 3D assets only once during initialization, and to share the calculated data between multiple instantiations.
Expand All @@ -28,7 +29,7 @@ OSMPGroundTruthInit
* `OSMPGroundTruthInit` shall be defined as a notional discrete binary input parameter variable, with `@causality="parameter"`, `@variability="fixed"` and `@initial="exact"`.
* The MIME type of the variable shall specify the `type=GroundTruth` as part of the MIME type parameters.
* `OSMPGroundTruthInit` shall be encoded as `osi3::GroundTruth`.
* `OSMPGroundTruthInit` shall contain all data encountered by the model that does not change during a simulation run.
* `OSMPGroundTruthInit` shall contain only data encountered by the model that does not change during a simulation run.
* The IDs of objects in `OSMPGroundTruthInit` shall be identical to the IDs of the same objects contained in later `OSMPSensorViewIn` or other input data.
* If the model is instantiated multiple times, then all instantiations should receive the exact same content stored in the `OSMPGroundTruthInit` parameter.
* The guaranteed lifetime of the ground-truth protocol-buffer pointer provided as input to the FMU shall be from the time of the call to `fmi2SetInteger` that provides those values until the end of the following `fmi2ExitInitializationMode` call.

0 comments on commit 84927bb

Please sign in to comment.