Statecharts definition¶
About statecharts¶
Statecharts are a well-known visual language for modeling the executable behavior of complex reactive event-based systems. They were invented in the 1980s by David Harel, and have gained a more widespread adoption since they became part of the UML modeling standard.
Statecharts offer more sophisticated modeling concepts than the more classical state diagrams of finite state machines. For example, they support hierarchical composition of states, orthogonal regions to express parallel execution, guarded transitions, and actions on transitions or states. Different flavours of executable semantics for statecharts have been proposed in the literature and in existing tools.
Defining statecharts in YAML¶
Because Sismic is supposed to be independent of a particular visual modeling tool, and easy to integrate in other programs without requiring the implementation of a visual notation, statecharts are expressed using YAML, a human-friendly textual notation (the alternative of using something like SCXML was discarded because its notation is too verbose and not really “human-readable”).
This section explains how the elements that compose a valid statechart in Sismic can be defined using YAML. If you are not familiar with YAML, have a look at YAML official documentation.
See also
While statecharts can be defined in YAML, they can be defined in pure
Python too. Moreover, Statechart
instances exhibit several methods to query and
manipulate statecharts (e.g.: rename_state()
,
rotate_transition()
, copy_from_statechart()
, etc.).
Consider looking at Statechart
API for more information.
See also
Experimental import/export support for AMOLA specifications of statecharts is available as an extension of Sismic. AMOLA is notably used in ASEME IDE, which can be used to graphically create, edit and visualize statecharts. More information on Extensions for Sismic.
Statechart¶
The root of the YAML file must declare a statechart:
statechart:
name: Name of the statechart
description: Description of the statechart
root state:
[...]
The name and the root state keys are mandatory, the description is optional. The root state key contains a state definition (see below). If specific code needs to be executed during initialization of the statechart, this can be specified using preamble. In this example, the code is written in Python.
statechart:
name: statechart containing initialization code
preamble: x = 1
Code can be written on multiple lines as follows:
preamble: |
x = 1
y = 2
States¶
A statechart must declare a root state. Each state consist of at least a mandatory name. Depending on the state type, other optional fields can be declared.
statechart:
name: with state
root state:
name: root
Entry and exit actions¶
For each declared state, the optional on entry and on exit fields can be used to specify the code that has to be executed when entering and leaving the state:
- name: s1
on entry: x += 1
on exit: |
x -= 1
y = 2
Shallow and deep history states¶
History states can be declared as follows:
- type: shallow history to declare a shallow history state;
- type: deep history to declare a deep history state.
- name: history state
type: shallow history
A history state can optionally declare a default initial memory using memory. Importantly, the memory value must refer to a parent’s substate.
- name: history state
type: deep history
memory: s1
See also
We refer to the semantics of UML for the difference between both types of histories.
Composite states¶
A state that is neither a final state nor a history state can contain nested states. Such a state is commonly called a composite state.
- name: composite state
states:
- name: nested state 1
- name: nested state 2
states:
- name: nested state 2a
A composite state can define its initial state using initial.
- name: composite state
initial: nested state 1
states:
- name: nested state 1
- name: nested state 2
initial: nested state a2
states:
- name: nested state 2a
Note
Unlike UML, but similarly to SCXML, Sismic does not explicitly represent the concept of region. A region is essentially a logical set of nested states, and thus can be viewed as a specialization of a composite state.
Orthogonal states¶
Orthogonal states (sometimes referred as parallel states) allow to specify multiple nested statecharts running in parallel. They must declare their nested states using parallel states instead of states.
statechart:
name: statechart containing multiple orthogonal states
initial state:
name: processes
parallel states:
- name: process 1
- name: process 2
Transitions¶
Transitions between states, compound states and parallel states can be declared with the transitions field. Transitions typically specify a target state using the target field:
- name: state with transitions
transitions:
- target: other state
Other optional fields can be specified for a transition: a guard (a Boolean expression that will be evaluated to determine if the transition can be followed), an event (name of the event that will trigger the transition), an action (code that will be executed if the transition is processed). Here is a full example of a transition specification:
- name: state with an outgoing transition
transitions:
- target: some other state
event: click
guard: x > 1
action: print('Hello World!')
One type of transition, called an internal transition, does not require to declare a target. Instead, it must either define an event or define a guard to determine when it should become active (otherwise, infinite loops would occur during simulation or execution).
Notice that such a transition does not trigger the on entry and on exit of its state, and can thus be used to model an internal action.
Statechart examples¶
Elevator¶
The Elevator statechart is one of the running examples in this documentation. Its visual description generated from Sismic using PlantUML looks as follows:
The corresponding YAML description is given below.
statechart:
name: Elevator
preamble: |
current = 0
destination = 0
doors_open = True
root state:
name: active
parallel states:
- name: movingElevator
initial: doorsOpen
states:
- name: doorsOpen
transitions:
- target: doorsClosed
guard: destination != current
action: doors_open = False
- target: doorsClosed
guard: after(10) and current > 0
action: |
destination = 0
doors_open = False
- name: doorsClosed
transitions:
- target: movingUp
guard: destination > current
- target: movingDown
guard: destination < current and destination >= 0
- name: moving
transitions:
- target: doorsOpen
guard: destination == current
action: doors_open = True
states:
- name: movingUp
on entry: current = current + 1
transitions:
- target: movingUp
guard: destination > current
- name: movingDown
on entry: current = current - 1
transitions:
- target: movingDown
guard: destination < current
- name: floorListener
initial: floorSelecting
states:
- name: floorSelecting
transitions:
- target: floorSelecting
event: floorSelected
action: destination = event.floor
Other examples¶
Some other examples can be found in the Git repository of the project, in docs/examples.
Importing and validating statecharts¶
The Statechart
class provides several methods to construct, to query and to manipulate a statechart.
A YAML definition of a statechart can be easily imported to a Statechart
instance.
The module sismic.io
provides a convenient loader import_from_yaml()
which takes a textual YAML definition of a statechart and returns a Statechart
instance.
-
sismic.io.
import_from_yaml
(text=None, filepath=None, *, ignore_schema=False, ignore_validation=False) Import a statechart from a YAML representation (first argument) or a YAML file (filepath argument).
Unless specified, the structure contained in the YAML is validated against a predefined schema (see sismic.io.SCHEMA), and the resulting statechart is validated using its validate() method.
Parameters: Return type: Statechart
Returns: a Statechart instance
For example:
from sismic.io import import_from_yaml
from sismic.model import Statechart
with open('examples/elevator/elevator.yaml') as f:
statechart = import_from_yaml(f)
assert isinstance(statechart, Statechart)
The function also supports importing from a given filepath:
statechart = import_from_yaml(filepath='examples/elevator/elevator.yaml')
assert isinstance(statechart, Statechart)
The parser performs several checks using statechart’s validate
method.
It also does an automatic validation against some kind of schema to prevent erroneous keys.
See schema library for more information about the semantics.
class SCHEMA:
contract = {schema.Or('before', 'after', 'always'): schema.Use(str)}
transition = {
schema.Optional('target'): schema.Use(str),
schema.Optional('event'): schema.Use(str),
schema.Optional('guard'): schema.Use(str),
schema.Optional('action'): schema.Use(str),
schema.Optional('contract'): [contract],
}
state = dict() # type: ignore
state.update({
'name': schema.Use(str),
schema.Optional('type'): schema.Or('final', 'shallow history', 'deep history'),
schema.Optional('on entry'): schema.Use(str),
schema.Optional('on exit'): schema.Use(str),
schema.Optional('transitions'): [transition],
schema.Optional('contract'): [contract],
schema.Optional('initial'): schema.Use(str),
schema.Optional('parallel states'): [state],
schema.Optional('states'): [state],
})
statechart = {
'statechart': {
'name': schema.Use(str),
schema.Optional('description'): schema.Use(str),
schema.Optional('preamble'): schema.Use(str),
'root state': state,
}
}
See also
Consider having a look at the feature branches of Sismic repository to get more information about the various statechart formats that are currently (experimentally) supported but not yet released in Sismic.
Visualising statecharts¶
Sismic is not bundle with any graphical tool that can be used to edit or even view a statechart.
Module sismic.io
contains routines that can be used to (import and) export statecharts to other format,
some of them being used by third-party tools that support visualising (or editing) statecharts.
Notably, module sismic.io
contains a function export_to_plantuml()
that export a given statechart to
PlantUML, a tool based on graphviz that can automatically render statecharts (to some extent).
An online version of PlantUML can be found here.
For example, the elevator statechart can be exported to the following PlantUML file, which in turns can be used to generate the previously given representation of the elevator.
@startuml
title Elevator
state "active" as active {
state "floorListener" as floorListener {
[*] -right-> floorSelecting
state "floorSelecting" as floorSelecting {
floorSelecting --> floorSelecting : floorSelected / destination = event.floor
}
}
--
state "movingElevator" as movingElevator {
[*] -right-> doorsOpen
state "moving" as moving {
moving --> doorsOpen : [destination == current] / doors_open = True
state "movingDown" as movingDown {
movingDown : **entry** / current = current - 1
movingDown --> movingDown : [destination < current]
}
state "movingUp" as movingUp {
movingUp : **entry** / current = current + 1
movingUp --> movingUp : [destination > current]
}
}
state "doorsClosed" as doorsClosed {
doorsClosed --> movingUp : [destination > current]
doorsClosed --> movingDown : [destination < current and destination >= 0]
}
state "doorsOpen" as doorsOpen {
doorsOpen -right-> doorsClosed : [destination != current] / doors_open = False
doorsOpen -right-> doorsClosed : [after(10) and current > 0] / destination = 0; doors_open = False
}
}
}
@enduml
See also
PlantUML’s rendering can be modified to some extent by adjusting the notation used for transitions.
By default, -->
transitions correspond to downward transitions of good length.
A transition can be shortened by using ->
instead of -->
, and the direction of a transition can be
changed by using -up->`, ``-right->`, ``-down->` or ``-left->
. Both changes can be applied at the same time
using -u->, -r->`, ``-d->
or -l->
.
See PlantUML documentation for more information.
If you have already exported a statechart to PlantUML and made some changes to the direction or length of the transitions, it is likely that you will want to retrieve these changes when you export the (possibly modified) statechart again to PlantUML.
The export_to_plantuml()
function accepts two optional (mutually exclusive) parameters based_on
and based_on_filepath
that can be used to provide an earlier version of a PlantUML text representation
(or a path to such a version if based_on_filepath
is used).
This will then be used to incorporate as much as possible the changes made on the transitions.
-
sismic.io.
export_to_plantuml
(statechart, filepath=None, *, based_on=None, based_on_filepath=None, statechart_name=True, statechart_description=False, statechart_preamble=False, state_contracts=False, state_action=True, transition_contracts=False, transition_action=True) Export given statechart to plantUML (see http://plantuml/plantuml). If a filepath is provided, also save the output to this file.
Due to the way statecharts are representing, and due to the presence of features that are specific to Sismic, the resulting statechart representation does not include all the informations. For example, final states and history states won’t have name, actions and contracts.
If a previously exported representation for the statechart is provided, either as text (based_on parameter) or as a filepath (based_on_filepath parameter), it will attempt to reuse the modifications made to the transitions (their direction and length).
Parameters: - statechart (
Statechart
) – statechart to export - filepath (
Optional
[str
]) – save output to given filepath, if provided - based_on (
Optional
[str
]) – existing representation of the statechart in PlantUML - based_on_filepath (
Optional
[str
]) – filepath to an existing representation of the statechart in PlantUML - statechart_name (
bool
) – include the name of the statechart - statechart_description (
bool
) – include the description of the statechart - statechart_preamble (
bool
) – include the preamble of the statechart - state_contracts (
bool
) – include state contracts - state_action (
bool
) – include state actions (on entry, on exit and internal transitions) - transition_contracts (
bool
) – include transition contracts - transition_action (
bool
) – include actions on transition
Return type: Returns: textual representation using plantuml
- statechart (