Package rst.statemachine

This package contains data type definitions that describe static and dynamic aspects of state machines.

Messages

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.StateChangeCollection" TITLE="Structure rst.statemachine.StateChangeCollection" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message.svg"></IMG></TD><TD ALIGN="left">StateChangeCollection</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-statemachine.html#rst.statemachine.StateChange" TITLE="Structure rst.statemachine.StateChange" TARGET="_parent">StateChange</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-statemachine.html#rst.statemachine.StateChangeCollection.element" TITLE="Field rst.statemachine.StateChangeCollection.element" TARGET="_parent" PORT="element">element</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "2" [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><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.machine" TITLE="Field rst.statemachine.StateChange.machine" TARGET="_parent" PORT="machine">machine</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "1":element -> "2" []; }

clearer: should be made invisible via css

Message StateChangeCollection

class rst.statemachine.StateChangeCollection

Collection of StateChange instances.

Auto-generated.

element
Type:array of rst.statemachine.StateChange

The individual elements of the collection.

Constraints regarding the empty collection, sorting, duplicated entries etc. are use case specific.

Download this file

message StateChangeCollection {

    /**
     * The individual elements of the collection.
     *
     * Constraints regarding the empty collection, sorting, duplicated
     * entries etc. are use case specific.
     */
    repeated StateChange element = 1;

}

Message StateChange

class rst.statemachine.StateChange

Indicates a state change in a state machine.

Code author: Phillip Luecking <plueckin@techfak.uni-bielefeld.de>

@create_collection

from_state
Type:ASCII-STRING

Indicates from which state the state machine switched into the to_state.

to_state
Type:ASCII-STRING

Stores the new state of the state machine, coming from from_state.

cause
Type:ASCII-STRING

The cause of the state change, if present.

machine
Type:ASCII-STRING

A description of the state machine which changed its state.

Download this file

message StateChange {

    /**
     * Indicates from which state the state machine switched into the
     * @ref .to_state.
     */
    required string from_state = 1;

    /**
     * Stores the new state of the state machine, coming from @ref
     * .from_state.
     */
    required string to_state = 2;

    /**
     * The cause of the state change, if present.
     */
    optional string cause = 3;

    /**
     * A description of the state machine which changed its state.
     */
    optional string machine = 4;

}