.. _package-rst-statemachine:
==========================
Package rst.statemachine
==========================
This package contains data type definitions that describe static
and dynamic aspects of state machines.
Messages
========
.. container:: mess4ge-multi
.. container:: mess4ge-graph
.. digraph:: message_graph
fontname="Arial";
fontsize=11;
stylesheet="../_static/graphs.css";
node [fontsize=11,fontname="Arial"]
edge [fontsize=11,fontname="Arial"]
"1" [label=< | StateChangeCollection |
|
| StateChange | element |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | StateChange |
|
| ASCII-STRING | from_state |
| ASCII-STRING | to_state |
| ASCII-STRING | cause |
| ASCII-STRING | machine |
>,shape=box,style=filled,fillcolor="white"];
"1":element -> "2" [];
.. container:: mess4ge-list
.. container:: messages
* :ref:`StateChangeCollection `
* :ref:`StateChange `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-statemachine-statechangecollection:
Message StateChangeCollection
-----------------------------
.. container:: message-rst-statemachine-statechangecollection-multi
.. container:: message-rst-statemachine-statechangecollection-documentation
.. py:class:: rst.statemachine.StateChangeCollection
Collection of :py:class:`StateChange ` instances.
Auto-generated.
.. py:attribute:: element
:type: array of :py:class:`rst.statemachine.StateChange`
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated
entries etc. are use case specific.
.. container:: message-rst-statemachine-statechangecollection-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/statemachine/StateChangeCollection.proto
:lines: 12-22
:language: protobuf
:emphasize-lines: 9-9
.. _message-rst-statemachine-statechange:
Message StateChange
-------------------
.. container:: message-rst-statemachine-statechange-multi
.. container:: message-rst-statemachine-statechange-documentation
.. py:class:: rst.statemachine.StateChange
Indicates a state change in a state machine.
.. codeauthor:: Phillip Luecking
@create_collection
.. py:attribute:: from_state
:type: :py:class:`ASCII-STRING`
Indicates from which state the state machine switched into the
:py:attr:`to_state `.
.. py:attribute:: to_state
:type: :py:class:`ASCII-STRING`
Stores the new state of the state machine, coming from :py:attr:`from_state `.
.. py:attribute:: cause
:type: :py:class:`ASCII-STRING`
The cause of the state change, if present.
.. py:attribute:: machine
:type: :py:class:`ASCII-STRING`
A description of the state machine which changed its state.
.. container:: message-rst-statemachine-statechange-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.15-merge-simulator/upstream/RST-0.15.0-Linux/share/rst0.15/proto/stable/rst/statemachine/StateChange.proto
:lines: 13-37
:language: protobuf
:emphasize-lines: 7-7,13-13,18-18,23-23