Skip to content

Commit 02cb115

Browse files
committed
Minor refactoring for clarity and portability
Signed-off-by: Pierre R. Mai <pmai@pmsf.de>
1 parent e009b3a commit 02cb115

4 files changed

Lines changed: 12 additions & 19 deletions

File tree

doc/misc/example.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
= Example: Simple sensor-model FMU
1+
= Example: Simple sensor model FMU
22

33
Then following example shows the content of a `modelDescription.xml` file that satisfies the requirements of OSMP.
4-
The example describes a sensor-model FMU with one input, one output, and no additional features:
4+
The example describes a sensor model FMU with one input, one output, and no additional features:
55

66
[source]
77
----

doc/setup/build_install_example.adoc

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
OSMP includes three examples located in `_osmp_/examples`:
44

55
`OSMPDummySensor/`::
6-
Can be used as a simple dummy sensor model, demonstrating the use of OSI for sensor models consuming sensor-view data and generating sensor-data output.
6+
Can be used as a simple dummy sensor model, demonstrating the use of OSI for sensor models consuming sensor view data and generating sensor data output.
77

88
`OSMPDummySource/`::
9-
Can be used as a simple source of sensor-view data and ground-truth data.
9+
Can be used as a simple source of sensor view data and ground-truth data.
1010
It can be connected to the input of an `OSMPDummySensor` model, for simple testing and demonstration purposes.
1111

1212
`OSMPCNetworkProxy/`::
@@ -68,16 +68,9 @@ cd build
6868
cmake ..
6969
----
7070
+
71-
. Run _make_.
71+
. Run _cmake_ build.
7272
+
7373
[source]
7474
----
75-
make
76-
----
77-
+
78-
. Install the examples.
79-
+
80-
[source]
81-
----
82-
sudo make install
75+
cmake --build .
8376
----

doc/spec/sensor_view_input_configuration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Sensor view input configurations shall be named with the following prefix:
1515
OSMPSensorViewInConfig
1616
----
1717

18-
Sensor view input-configuration requests shall be named with the following prefix:
18+
Sensor view input configuration requests shall be named with the following prefix:
1919

2020
[source]
2121
----
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Traffic update outputs
22

3-
Traffic-update outputs are present in traffic participant models.
3+
Traffic update outputs are present in traffic participant models.
44

55
**Prefix**
66

@@ -13,10 +13,10 @@ Traffic update outputs shall be named with the following prefix:
1313

1414
**Rules**
1515

16-
* If only one traffic-update output is configured, the prefix shall only be `OSMPTrafficUpdateOut`.
17-
* If more than one traffic-update output is configured, the prefix shall be extended by an array index, for example `OSMPTrafficUpdateOut[1]` and `OSMPTrafficUpdateOut[2]`.
16+
* If only one traffic update output is configured, the prefix shall only be `OSMPTrafficUpdateOut`.
17+
* If more than one traffic update output is configured, the prefix shall be extended by an array index, for example `OSMPTrafficUpdateOut[1]` and `OSMPTrafficUpdateOut[2]`.
1818
* Array indices shall start at 1 and shall be consecutive.
19-
* Each traffic-update output shall be defined as a notional discrete binary output variable with a `@causality="output"` and a `@variability="discrete"`.
19+
* Each traffic update output shall be defined as a notional discrete binary output variable with a `@causality="output"` and a `@variability="discrete"`.
2020
* The MIME type of the variable shall specify the `type=TrafficUpdate` as part of the MIME type parameters.
2121
* Traffic updates shall be encoded as `osi3::TrafficUpdate`.
22-
* The guaranteed lifetime of the traffic-update protocol-buffer pointer provided as output by the FMU shall be from the end of the call to `fmi2DoStep` that calculated this buffer until the beginning of the second `fmi2DoStep` call after that.
22+
* The guaranteed lifetime of the traffic update protocol-buffer pointer provided as output by the FMU shall be from the end of the call to `fmi2DoStep` that calculated this buffer until the beginning of the second `fmi2DoStep` call after that.

0 commit comments

Comments
 (0)