Skip to content

Commit d32297a

Browse files
authored
Update specification.rst
Add motion request as output as well
1 parent 9bb97df commit d32297a

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

doc/specification.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,39 @@ Motion Request Input
453453

454454
- *Is there a SHOULD condition in the motion request message?*
455455

456+
Motion Request Output
457+
--------------------
458+
459+
- A motion request output MUST be named with the prefix ``OSMPMotionRequestOut``.
460+
*only one motion request input shall be used?*
461+
462+
- Each motion request output MUST be defined as a notional discrete binary
463+
input variable, as specified above, with ``causality="output"`` and
464+
``variability="discrete"``.
465+
466+
- The MIME type of the variable MUST specify the ``type=MotionRequest``,
467+
e.g. ``application/x-open-simulation-interface; type=MotionRequest; version=3.3.0``.
468+
469+
- The motion request MUST be encoded as ``osi3::MotionRequest`` (see the
470+
OSI specification documentation for more details). (*maybe a link?*)
471+
472+
- The guaranteed lifetime of the motion request protocol buffer pointer
473+
provided as output by the FMU MUST be from the end of the call to
474+
``fmi2DoStep`` that calculated this buffer until the beginning of the
475+
**second** ``fmi2DoStep`` call after that, i.e. the simulation engine
476+
can rely on the provided buffer remaining valid from the moment it is
477+
passed out until the end of the next Co-Simulation calculation cycle,
478+
and thus does not need to copy the contents in that case (zero copy
479+
output for the simulation engine, at the cost of double buffering for
480+
the sensor model).
481+
482+
- The motion request passed to the FMU MUST contain one of the available ``OutputOptions``.
483+
In addition to the enumerator, the corresponding ``DesiredState`` or ``Trajectory`` has to
484+
be set, respectively.
485+
486+
- *Is there a SHOULD condition in the motion request message?*
487+
488+
456489
Traffic Update Outputs
457490
----------------------
458491

0 commit comments

Comments
 (0)