.. _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=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-statemachine.html#rst.statemachine.StateChange" TITLE="Structure rst.statemachine.StateChange" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">StateChange</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-statemachine.html#rst.statemachine.StateChange.from_state" TITLE="Field rst.statemachine.StateChange.from_state" TARGET="_parent" PORT="from_state">from_state</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-statemachine.html#rst.statemachine.StateChange.to_state" TITLE="Field rst.statemachine.StateChange.to_state" TARGET="_parent" PORT="to_state">to_state</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-statemachine.html#rst.statemachine.StateChange.cause" TITLE="Field rst.statemachine.StateChange.cause" TARGET="_parent" PORT="cause">cause</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
         

   .. container:: mess4ge-list

      .. container:: messages

         * :ref:`StateChange <message-rst-statemachine-statechange>`

      .. container:: clearer

         clearer: should be made invisible via css

.. _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 <plueckin@techfak.uni-bielefeld.de>
         

         .. py:attribute:: from_state

            :type: :py:class:`ASCII-STRING`

            
            
            Indicates from which state the state machine switched into the
            :py:attr:`to_state <rst.statemachine.StateChange.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 <rst.statemachine.StateChange.from_state>`.

         .. py:attribute:: cause

            :type: :py:class:`ASCII-STRING`

            
            
            The cause of the state change, if present.

   .. container:: message-rst-statemachine-statechange-source

      :download:`Download this file <//home/jenkins/workspace/rst-manual-0.12/rst-manual/../rst-proto/proto/stable/rst/statemachine/StateChange.proto>`

      .. literalinclude:: //home/jenkins/workspace/rst-manual-0.12/rst-manual/../rst-proto/proto/stable/rst/statemachine/StateChange.proto
         :lines: 10-29
         :language: protobuf
         :emphasize-lines: 7-7,13-13,18-18