You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/spec/ground_truth_init_parameters.adoc
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,11 @@ endif::[]
5
5
= Ground truth initialization parameters
6
6
7
7
All models can optionally consume `osi3::GroundTruth` via an initialization parameter called `OSMPGroundTruthInit`.
8
-
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.
8
+
Its purpose is to provide the model with information in OSI format that does not change throughout the simulation, i.e. is considered static.
9
+
This can encompass, for example, the road network or referenced 3D models.
9
10
10
-
`OSMPGroundTruthInit` contains all data encountered by the model that does not change during a simulation run, for example, roads.
11
-
All data provided in this message can be assumed by the receiver to not change during the simulation run.
11
+
`OSMPGroundTruthInit` contains only data encountered by the model that does not change during a simulation run.
12
+
All data provided in this message can be assumed by the receiver to be static during the simulation run.
12
13
13
14
If the model is instantiated multiple times, all instantiations should receive the exact same content.
14
15
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.
@@ -28,7 +29,7 @@ OSMPGroundTruthInit
28
29
* `OSMPGroundTruthInit` shall be defined as a notional discrete binary input parameter variable, with `@causality="parameter"`, `@variability="fixed"` and `@initial="exact"`.
29
30
* The MIME type of the variable shall specify the `type=GroundTruth` as part of the MIME type parameters.
30
31
* `OSMPGroundTruthInit` shall be encoded as `osi3::GroundTruth`.
31
-
* `OSMPGroundTruthInit` shall contain all data encountered by the model that does not change during a simulation run.
32
+
* `OSMPGroundTruthInit` shall contain only data encountered by the model that does not change during a simulation run.
32
33
* The IDs of objects in `OSMPGroundTruthInit` shall be identical to the IDs of the same objects contained in later `OSMPSensorViewIn` or other input data.
33
34
* If the model is instantiated multiple times, then all instantiations should receive the exact same content stored in the `OSMPGroundTruthInit` parameter.
34
35
* 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 commit comments