1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
|
.. _STRUCT/StateMachine:
StateMachine
############
The :mod:`pyTooling.StateMachine` package
.. #contents:: Table of Contents
:local:
:depth: 2
.. rubric:: Example Statemachine:
.. mermaid::
:caption: A statemachine graph.
%%{init: { "flowchart": { "nodeSpacing": 15, "rankSpacing": 30, "curve": "linear", "useMaxWidth": false } } }%%
graph TD
A(Idle); B(Check); C(Prepare); D(Read); E(Finished); F(Write) ; G(Retry); H(WriteWait); I(ReadWait)
A:::mark1 --> B --> C --> F
F --> H --> E:::cur
B --> G --> B
G -.-> A --> C
D -.-> A
C ---> D --> I --> E -.-> A
classDef node fill:#eee,stroke:#777,font-size:smaller;
classDef cur fill:#9e9,stroke:#6e6;
classDef mark1 fill:#69f,stroke:#37f,color:#eee;
.. rubric:: Statemachine Properties:
.. _STRUCT/StateMachine/Features:
Features
********
* TBD
.. _STRUCT/StateMachine/MissingFeatures:
Missing Features
================
* TBD
.. _STRUCT/StateMachine/PlannedFeatures:
Planned Features
================
* TBD
.. _STRUCT/StateMachine/RejectedFeatures:
Out of Scope
============
* TBD
.. _STRUCT/StateMachine/ByFeature:
By Feature
**********
.. danger::
Accessing internal fields of a statemachine, state or transition is strongly not recommended for users, as it might
lead to a corrupted data structure. If a power-user wants to access these fields, feel free to use them for achieving
a higher performance, but you got warned 😉.
.. _STRUCT/StateMachine/ID:
Unique ID
=========
|