Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change 'static' to 'not changing' in the specification of GroundTruthInit #108

Merged
merged 4 commits into from
Apr 4, 2024
Merged

Change 'static' to 'not changing' in the specification of GroundTruthInit #108

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
245630a
Change 'static' to 'constant' in the specification to differentiate b…
ClemensLinnhoff Mar 22, 2024
5305d10
Change constant to 'does not change'
ClemensLinnhoff Mar 25, 2024
ed06f86
Further rewording
ClemensLinnhoff Mar 25, 2024
84927bb
Apply suggestions from code review
ClemensLinnhoff Mar 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/spec/ground_truth_init_parameters.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ 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 a view of the static environment, for example the map, in OSI format.
Its purpose is to provide the model with information that is constant throughout the simulation, for example the map in OSI format or the model_reference of a MovingObject.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's discuss the wording for static/constant/moving/dynamic for changes in OSI3.8, as it also touches topics as in OpenSimulationInterface/open-simulation-interface#768.

How about: 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the sentence.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I generally changed 'static'/'constant' to not 'changing'


`OSMPGroundTruthInit` contains all static data encountered by the model during a simulation run, for example, roads.
All data provided in this message can be assumed by the receiver to be static during the simulation run.
`OSMPGroundTruthInit` contains all constant data encountered by the model during a simulation run, for example, roads.
All data provided in this message can be assumed by the receiver to be constant 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 only once during initialization, and to share the calculated data between multiple instantiations.
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.

**Prefix**

Ground truth initialization paramters shall be named with the following prefix:
Ground truth initialization parameters shall be named with the following prefix:

[source,protobuf]
----
Expand All @@ -28,7 +28,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 static data encountered by the model during a simulation run.
* `OSMPGroundTruthInit` shall contain all constant data encountered by the model 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.
Loading