Skip to content

Commit 24f08b6

Browse files
pmaipmai
authored
Merge pull request #57 from OpenSimulationInterface/fix/update-version-for-1-1-0
Fix/update versions for Release 1.1.0
2 parents 3d1fa58 + fbd3c20 commit 24f08b6

File tree

6 files changed

+70
-62
lines changed

6 files changed

+70
-62
lines changed

‎doc/specification.rst

+34-34
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,24 @@ Kinds of Models
2020
The current specification supports the following kinds of models, that
2121
can be packaged as FMUs:
2222

23-
- Environmental effect models, which consume ``osi::SensorView`` as input
24-
and produce ``osi::SensorView`` as output,
23+
- Environmental effect models, which consume ``osi3::SensorView`` as input
24+
and produce ``osi3::SensorView`` as output,
2525

26-
- Sensor models, which consume ``osi::SensorView`` as input and generate
27-
``osi::SensorData`` as output,
26+
- Sensor models, which consume ``osi3::SensorView`` as input and generate
27+
``osi3::SensorData`` as output,
2828

2929
- Logical models, like e.g. sensor fusion models, which consume
30-
``osi::SensorData`` as input and produce ``osi::SensorData`` as output.
30+
``osi3::SensorData`` as input and produce ``osi3::SensorData`` as output.
3131

32-
- Traffic Participant models, which consume ``osi::SensorView`` as input
33-
and generate ``osi::TrafficUpdate`` as output. These models can
32+
- Traffic Participant models, which consume ``osi3::SensorView`` as input
33+
and generate ``osi3::TrafficUpdate`` as output. These models can
3434
internally use e.g. Environmental effect, Sensor and/or Logical models
3535
as part of a modeled autonomous vehicle, but they can also be used to
3636
implement surrounding traffic in simplified ways. Optionally, traffic
37-
participant models can consume ``osi::TrafficCommand`` as input, to
37+
participant models can consume ``osi3::TrafficCommand`` as input, to
3838
allow control by a scenario engine as part of the simulation.
3939

40-
All models can optionally also consume a global ``osi::GroundTruth``
40+
All models can optionally also consume a global ``osi3::GroundTruth``
4141
during initialization.
4242

4343
Additionally complex models that combine various aspects of the model
@@ -64,7 +64,7 @@ The following basic conventions apply:
6464

6565
.. code:: XML
6666
67-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp version="1.0.0" osi-version="3.0.0"/></Tool>
67+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp version="1.1.0" osi-version="3.3.0"/></Tool>
6868
6969
where the ``osi-version`` attribute SHOULD contain the major, minor
7070
and patch version number of the open simulation interface
@@ -163,10 +163,10 @@ the following convention is used to define such variables for FMI 2.0:
163163
``<mime-type>``, which MUST be a valid MIME type specification.
164164

165165
In the case of OSI-specified data, the MIME type MUST be of the form
166-
``application/x-open-simulation-interface; type=SensorView; version=3.0.0``
166+
``application/x-open-simulation-interface; type=SensorView; version=3.3.0``
167167
indicating that the binary content is conformant to a given OSI
168-
version (3.0.0 in this example), containing a message of the type
169-
given in the ``type`` parameter (````osi::SensorView```` in this
168+
version (3.3.0 in this example), containing a message of the type
169+
given in the ``type`` parameter (````osi3::SensorView```` in this
170170
example).
171171

172172
The version parameter given for the MIME type
@@ -206,9 +206,9 @@ Sensor View Inputs
206206

207207
- The MIME type of the variable MUST specify the ``type=SensorView``,
208208
e.g.
209-
``application/x-open-simulation-interface; type=SensorView; version=3.0.0``.
209+
``application/x-open-simulation-interface; type=SensorView; version=3.3.0``.
210210

211-
- The sensor view MUST be encoded as ``osi::SensorView`` (see the OSI
211+
- The sensor view MUST be encoded as ``osi3::SensorView`` (see the OSI
212212
specification documentation for more details).
213213

214214
- The guaranteed lifetime of the sensor view protocol buffer pointer
@@ -245,9 +245,9 @@ Sensor View Input Configuration
245245

246246
- The MIME type of both variables MUST specify the
247247
``type=SensorViewConfiguration``, e.g.
248-
``application/x-open-simulation-interface; type=SensorViewConfiguration; version=3.0.0``.
248+
``application/x-open-simulation-interface; type=SensorViewConfiguration; version=3.3.0``.
249249

250-
- The variables values MUST be encoded as ``osi::SensorViewConfiguration``
250+
- The variables values MUST be encoded as ``osi3::SensorViewConfiguration``
251251
(see the OSI specification documentation for more details).
252252

253253
- As long as no non-zero value has been assigned to the corresponding
@@ -287,9 +287,9 @@ Sensor View Outputs
287287

288288
- The MIME type of the variable MUST specify the ``type=SensorView``,
289289
e.g.
290-
``application/x-open-simulation-interface; type=SensorView; version=3.0.0``.
290+
``application/x-open-simulation-interface; type=SensorView; version=3.3.0``.
291291

292-
- The sensor view MUST be encoded as ``osi::SensorView`` (see the OSI
292+
- The sensor view MUST be encoded as ``osi3::SensorView`` (see the OSI
293293
specification documentation for more details).
294294

295295
- The guaranteed lifetime of the sensor view protocol buffer pointer
@@ -327,9 +327,9 @@ Sensor Data Outputs
327327

328328
- The MIME type of the variable MUST specify the ``type=SensorData``,
329329
e.g.
330-
``application/x-open-simulation-interface; type=SensorData; version=3.0.0``.
330+
``application/x-open-simulation-interface; type=SensorData; version=3.3.0``.
331331

332-
- The sensor data MUST be encoded as ``osi::SensorData`` (see the OSI
332+
- The sensor data MUST be encoded as ``osi3::SensorData`` (see the OSI
333333
specification documentation for more details).
334334

335335
- The guaranteed lifetime of the sensor data protocol buffer pointer
@@ -368,9 +368,9 @@ Sensor Data Inputs
368368

369369
- The MIME type of the variable MUST specify the ``type=SensorData``,
370370
e.g.
371-
``application/x-open-simulation-interface; type=SensorData; version=3.0.0``.
371+
``application/x-open-simulation-interface; type=SensorData; version=3.3.0``.
372372

373-
- The sensor data MUST be encoded as ``osi::SensorData`` (see the OSI
373+
- The sensor data MUST be encoded as ``osi3::SensorData`` (see the OSI
374374
specification documentation for more details).
375375

376376
- The guaranteed lifetime of the sensor data protocol buffer pointer
@@ -388,7 +388,7 @@ Sensor Data Inputs
388388
GroundTruth Initialization Parameters
389389
-------------------------------------
390390

391-
- All models CAN optionally consume an ``osi::GroundTruth`` as an
391+
- All models CAN optionally consume an ``osi3::GroundTruth`` as an
392392
initialization parameter.
393393

394394
- If a model needs a ground truth during initialization, it MUST have
@@ -403,7 +403,7 @@ GroundTruth Initialization Parameters
403403
- The MIME type of the variable MUST specify the ``type=GroundTruth``, e.g.
404404
``application/x-open-simulation-interface; type=GroundTruth; version=3.3.0``.
405405

406-
- ``OSMPGroundTruthInit`` MUST be encoded as ``osi::GroundTruth`` (see the OSI
406+
- ``OSMPGroundTruthInit`` MUST be encoded as ``osi3::GroundTruth`` (see the OSI
407407
specification documentation for more details).
408408

409409
- ``OSMPGroundTruthInit`` MUST contain all static data (e.g. roads) encountered
@@ -444,7 +444,7 @@ Traffic Update Outputs
444444
e.g.
445445
``application/x-open-simulation-interface; type=TrafficUpdate; version=3.3.0``.
446446

447-
- The traffic update MUST be encoded as ``osi::TrafficUpdate`` (see the
447+
- The traffic update MUST be encoded as ``osi3::TrafficUpdate`` (see the
448448
OSI specification documentation for more details).
449449

450450
- The guaranteed lifetime of the traffic update protocol buffer pointer
@@ -488,7 +488,7 @@ Traffic Command Inputs
488488
e.g.
489489
``application/x-open-simulation-interface; type=TrafficCommand; version=3.3.0``.
490490

491-
- The traffic command MUST be encoded as ``osi::TrafficCommand`` (see
491+
- The traffic command MUST be encoded as ``osi3::TrafficCommand`` (see
492492
the OSI specification documentation for more details).
493493

494494
- The guaranteed lifetime of the traffic command protocol buffer pointer
@@ -521,43 +521,43 @@ with one input and output and no additional features:
521521
canNotUseMemoryManagementFunctions="true"/>
522522
<DefaultExperiment startTime="0.0" stepSize="0.020"/>
523523
<VendorAnnotations>
524-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp version="1.0.0" osi-version="3.0.0"/></Tool>
524+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp version="1.1.0" osi-version="3.3.0"/></Tool>
525525
</VendorAnnotations>
526526
<ModelVariables>
527527
<ScalarVariable name="OSMPSensorViewIn.base.lo" valueReference="0" causality="input" variability="discrete">
528528
<Integer start="0"/>
529529
<Annotations>
530-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.0.0"/></Tool>
530+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.3.0"/></Tool>
531531
</Annotations>
532532
</ScalarVariable>
533533
<ScalarVariable name="OSMPSensorViewIn.base.hi" valueReference="1" causality="input" variability="discrete">
534534
<Integer start="0"/>
535535
<Annotations>
536-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.0.0"/></Tool>
536+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.3.0"/></Tool>
537537
</Annotations>
538538
</ScalarVariable>
539539
<ScalarVariable name="OSMPSensorViewIn.size" valueReference="2" causality="input" variability="discrete">
540540
<Integer start="0"/>
541541
<Annotations>
542-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="size" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.0.0"/></Tool>
542+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="size" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.3.0"/></Tool>
543543
</Annotations>
544544
</ScalarVariable>
545545
<ScalarVariable name="OSMPSensorDataOut.base.lo" valueReference="3" causality="output" variability="discrete" initial="exact">
546546
<Integer start="0"/>
547547
<Annotations>
548-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.0.0"/></Tool>
548+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.3.0"/></Tool>
549549
</Annotations>
550550
</ScalarVariable>
551551
<ScalarVariable name="OSMPSensorDataOut.base.hi" valueReference="4" causality="output" variability="discrete" initial="exact">
552552
<Integer start="0"/>
553553
<Annotations>
554-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.0.0"/></Tool>
554+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.3.0"/></Tool>
555555
</Annotations>
556556
</ScalarVariable>
557557
<ScalarVariable name="OSMPSensorDataOut.size" valueReference="5" causality="output" variability="discrete" initial="exact">
558558
<Integer start="0"/>
559559
<Annotations>
560-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="size" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.0.0"/></Tool>
560+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="size" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.3.0"/></Tool>
561561
</Annotations>
562562
</ScalarVariable>
563563
</ModelVariables>

‎examples/CMakeLists.txt

+8
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,15 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
1616
"Debug" "Release" "MinSizeRel" "RelWithDebInfo")
1717
endif()
1818

19+
set(OSMPVERSION "1.1.0" CACHE STRING "OSMP Version String")
20+
1921
add_subdirectory( open-simulation-interface )
22+
23+
get_directory_property(OSI_VERSION_MAJOR DIRECTORY open-simulation-interface DEFINITION VERSION_MAJOR)
24+
get_directory_property(OSI_VERSION_MINOR DIRECTORY open-simulation-interface DEFINITION VERSION_MINOR)
25+
get_directory_property(OSI_VERSION_PATCH DIRECTORY open-simulation-interface DEFINITION VERSION_PATCH)
26+
set(OSIVERSION "${OSI_VERSION_MAJOR}.${OSI_VERSION_MINOR}.${OSI_VERSION_PATCH}")
27+
2028
include_directories( includes )
2129
add_subdirectory( OSMPDummySensor )
2230
add_subdirectory( OSMPDummySource )

‎examples/OSMPCNetworkProxy/modelDescription.in.xml

+8-8
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
guid="@FMUGUID@"
66
description="OSMP Network Proxy FMU"
77
author="PMSF"
8-
version="1.3"
8+
version="@OSMPVERSION@"
99
generationTool="PMSF Manual FMU Framework"
1010
generationDateAndTime="@FMUTIMESTAMP@"
1111
variableNamingConvention="structured">
@@ -24,43 +24,43 @@
2424
</LogCategories>
2525
<DefaultExperiment startTime="0.0" stepSize="0.020"/>
2626
<VendorAnnotations>
27-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp version="1.0.0" osi-version="3.0.0"/></Tool>
27+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp version="@OSMPVERSION@" osi-version="@OSIVERSION@"/></Tool>
2828
</VendorAnnotations>
2929
<ModelVariables>
3030
<ScalarVariable name="OSMPSensorViewIn.base.lo" valueReference="0" causality="input" variability="discrete">
3131
<Integer start="0"/>
3232
<Annotations>
33-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.0.0"/></Tool>
33+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorView; version=@OSIVERSION@"/></Tool>
3434
</Annotations>
3535
</ScalarVariable>
3636
<ScalarVariable name="OSMPSensorViewIn.base.hi" valueReference="1" causality="input" variability="discrete">
3737
<Integer start="0"/>
3838
<Annotations>
39-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.0.0"/></Tool>
39+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorView; version=@OSIVERSION@"/></Tool>
4040
</Annotations>
4141
</ScalarVariable>
4242
<ScalarVariable name="OSMPSensorViewIn.size" valueReference="2" causality="input" variability="discrete">
4343
<Integer start="0"/>
4444
<Annotations>
45-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="size" mime-type="application/x-open-simulation-interface; type=SensorView; version=3.0.0"/></Tool>
45+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorViewIn" role="size" mime-type="application/x-open-simulation-interface; type=SensorView; version=@OSIVERSION@"/></Tool>
4646
</Annotations>
4747
</ScalarVariable>
4848
<ScalarVariable name="OSMPSensorDataOut.base.lo" valueReference="3" causality="output" variability="discrete" initial="exact">
4949
<Integer start="0"/>
5050
<Annotations>
51-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.0.0"/></Tool>
51+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.lo" mime-type="application/x-open-simulation-interface; type=SensorData; version=@OSIVERSION@"/></Tool>
5252
</Annotations>
5353
</ScalarVariable>
5454
<ScalarVariable name="OSMPSensorDataOut.base.hi" valueReference="4" causality="output" variability="discrete" initial="exact">
5555
<Integer start="0"/>
5656
<Annotations>
57-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.0.0"/></Tool>
57+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="base.hi" mime-type="application/x-open-simulation-interface; type=SensorData; version=@OSIVERSION@"/></Tool>
5858
</Annotations>
5959
</ScalarVariable>
6060
<ScalarVariable name="OSMPSensorDataOut.size" valueReference="5" causality="output" variability="discrete" initial="exact">
6161
<Integer start="0"/>
6262
<Annotations>
63-
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="size" mime-type="application/x-open-simulation-interface; type=SensorData; version=3.0.0"/></Tool>
63+
<Tool name="net.pmsf.osmp" xmlns:osmp="http://xsd.pmsf.net/OSISensorModelPackaging"><osmp:osmp-binary-variable name="OSMPSensorDataOut" role="size" mime-type="application/x-open-simulation-interface; type=SensorData; version=@OSIVERSION@"/></Tool>
6464
</Annotations>
6565
</ScalarVariable>
6666
<ScalarVariable name="dummy" valueReference="0" causality="parameter" variability="fixed">

0 commit comments

Comments
 (0)