pylib
/
state_machine
Прати 1
Волим 0
Креирај огранак 0
Код Дискусије 0 Захтеви за спајање 0 Издања 0 Вики Activity
Python Library State Machine
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2 Комити
1 Грана
Дрво: ddf94e9881
Гране Ознаке
${ item.name }
Create branch ${ searchTerm }
from 'ddf94e9881'
${ noResults }
state_machine/_docs_/index.html

index.html 25KB
Историја Датотека

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366 
  1. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

  3.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">

  6.   <head>

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  8.     <title>Welcome to state_machine’s documentation! &#8212; state_machine  documentation</title>

  9.     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />

  10.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

  11.     <script type="text/javascript">

  12.       var DOCUMENTATION_OPTIONS = {

  13.         URL_ROOT:    './',

  14.         VERSION:     '',

  15.         COLLAPSE_INDEX: false,

  16.         FILE_SUFFIX: '.html',

  17.         HAS_SOURCE:  true,

  18.         SOURCELINK_SUFFIX: '.txt'

  19.       };

  20.     </script>

  21.     <script type="text/javascript" src="_static/jquery.js"></script>

  22.     <script type="text/javascript" src="_static/underscore.js"></script>

  23.     <script type="text/javascript" src="_static/doctools.js"></script>

  24.     <link rel="index" title="Index" href="genindex.html" />

  25.     <link rel="search" title="Search" href="search.html" />

  26.    

  27.   <link rel="stylesheet" href="_static/custom.css" type="text/css" />

  28.   

  29.   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  30. 

  31.   </head>

  32.   <body>

  33.   

  34. 

  35.     <div class="document">

  36.       <div class="documentwrapper">

  37.         <div class="bodywrapper">

  38.           <div class="body" role="main">

  39.             

  40.   <div class="section" id="module-state_machine">

  41. <span id="welcome-to-state-machine-s-documentation"></span><h1>Welcome to state_machine’s documentation!<a class="headerlink" href="#module-state_machine" title="Permalink to this headline">¶</a></h1>

  42. <div class="section" id="state-machine-state-machine">

  43. <h2>state_machine (State Machine)<a class="headerlink" href="#state-machine-state-machine" title="Permalink to this headline">¶</a></h2>

  44. <p><strong>Author:</strong></p>

  45. <ul class="simple">

  46. <li>Dirk Alders &lt;<a class="reference external" href="mailto:sudo-dirk&#37;&#52;&#48;mount-mockery&#46;de">sudo-dirk<span>&#64;</span>mount-mockery<span>&#46;</span>de</a>&gt;</li>

  47. </ul>

  48. <p><strong>Description:</strong></p>

  49. <blockquote>

  50. <div>This Module helps implementing state machines.</div></blockquote>

  51. <p><strong>Submodules:</strong></p>

  52. <ul class="simple">

  53. <li><a class="reference internal" href="#state_machine.state_machine" title="state_machine.state_machine"><code class="xref py py-class docutils literal"><span class="pre">state_machine.state_machine</span></code></a></li>

  54. </ul>

  55. <p><strong>Unittest:</strong></p>

  56. <blockquote>

  57. <div>See also the <a class="reference download internal" href="_downloads/unittest.pdf" download=""><code class="xref download docutils literal"><span class="pre">unittest</span></code></a> documentation.</div></blockquote>

  58. <p><strong>Module Documentation:</strong></p>

  59. <dl class="class">

  60. <dt id="state_machine.state_machine">

  61. <em class="property">class </em><code class="descclassname">state_machine.</code><code class="descname">state_machine</code><span class="sig-paren">(</span><em>default_state</em>, <em>log_lvl</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#state_machine.state_machine" title="Permalink to this definition">¶</a></dt>

  62. <dd><table class="docutils field-list" frame="void" rules="none">

  63. <col class="field-name" />

  64. <col class="field-body" />

  65. <tbody valign="top">

  66. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

  67. <li><strong>default_state</strong> – The default state which is set on initialisation.</li>

  68. <li><strong>log_lvl</strong> – The log level, this Module logs to (see Loging-Levels of Module <code class="xref py py-mod docutils literal"><span class="pre">logging</span></code>)</li>

  69. </ul>

  70. </td>

  71. </tr>

  72. </tbody>

  73. </table>

  74. <div class="admonition note">

  75. <p class="first admonition-title">Note</p>

  76. <p class="last">Additional keyword parameters well be stored as varibles of the instance (e.g. to give variables or methods for transition condition calculation).</p>

  77. </div>

  78. <p>A state machine class can be created by deriving it from this class. The transitions are defined by overriding the variable <cite>TRANSITIONS</cite>.

  79. This Variable is a dictionary, where the key is the start-state and the content is a tuple or list of transitions. Each transition is a tuple or list

  80. including the following information: (condition-method (str), transition-time (number), target_state (str)).</p>

  81. <div class="admonition note">

  82. <p class="first admonition-title">Note</p>

  83. <p class="last">The condition-method needs to be implemented as part of the new class.</p>

  84. </div>

  85. <div class="admonition note">

  86. <p class="first admonition-title">Note</p>

  87. <p class="last">It is usefull to define the states as variables of this class.</p>

  88. </div>

  89. <p><strong>Example:</strong></p>

  90. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python</span>

  91. <span class="c1"># -*- coding: UTF-8 -*-</span>

  92. 

  93. <span class="kn">import</span> <span class="nn">logging</span>

  94. <span class="kn">import</span> <span class="nn">os</span>

  95. <span class="kn">import</span> <span class="nn">sys</span>

  96. 

  97. <span class="kn">import</span> <span class="nn">report</span>

  98. <span class="kn">import</span> <span class="nn">state_machine</span>

  99. 

  100. <span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s1">&#39;__example__&#39;</span><span class="p">)</span>

  101. <span class="n">report</span><span class="o">.</span><span class="n">consoleLoggingConfigure</span><span class="p">(</span><span class="n">loggers</span><span class="o">=</span><span class="p">[</span><span class="n">state_machine</span><span class="o">.</span><span class="n">logger_name</span><span class="p">,</span> <span class="s1">&#39;__example__&#39;</span><span class="p">,</span> <span class="p">],</span> <span class="n">level</span><span class="o">=</span><span class="s1">&#39;DEBUG&#39;</span><span class="p">)</span>

  102. 

  103. 

  104. <span class="k">class</span> <span class="nc">trafic_lights</span><span class="p">(</span><span class="n">state_machine</span><span class="o">.</span><span class="n">state_machine</span><span class="p">):</span>

  105.     <span class="n">LOG_PREFIX</span> <span class="o">=</span> <span class="s1">&#39;TraficLights:&#39;</span>

  106. 

  107.     <span class="n">STATE_RED</span> <span class="o">=</span> <span class="s1">&#39;state_red&#39;</span>

  108.     <span class="n">STATE_GREEN</span> <span class="o">=</span> <span class="s1">&#39;state_green&#39;</span>

  109. 

  110.     <span class="n">CONDITION_TRUE</span> <span class="o">=</span> <span class="s1">&#39;condition_true&#39;</span>

  111.     <span class="n">CONDITION_PEDASTRIAN_REQUEST</span> <span class="o">=</span> <span class="s1">&#39;condition_pedastrian_request&#39;</span>

  112. 

  113.     <span class="n">TRANSITIONS</span> <span class="o">=</span> <span class="p">{</span>

  114.         <span class="n">STATE_RED</span><span class="p">:</span> <span class="p">(</span>

  115.             <span class="p">(</span><span class="n">CONDITION_PEDASTRIAN_REQUEST</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">STATE_GREEN</span><span class="p">),</span>

  116.         <span class="p">),</span>

  117.         <span class="n">STATE_GREEN</span><span class="p">:</span> <span class="p">(</span>

  118.             <span class="p">(</span><span class="n">CONDITION_TRUE</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="n">STATE_RED</span><span class="p">),</span>

  119.         <span class="p">)</span>

  120.     <span class="p">}</span>

  121. 

  122.     <span class="k">def</span> <span class="nf">condition_true</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

  123.         <span class="k">return</span> <span class="kc">True</span>

  124. 

  125.     <span class="k">def</span> <span class="nf">set_padestrian_request</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

  126.         <span class="n">logger</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__log_lvl__</span><span class="p">,</span> <span class="s1">&#39;</span><span class="si">%s</span><span class="s1"> Pedestrian gave state change request.&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">LOG_PREFIX</span><span class="p">)</span>

  127.         <span class="bp">self</span><span class="o">.</span><span class="n">pedastrian_request</span> <span class="o">=</span> <span class="kc">True</span>

  128. 

  129.     <span class="k">def</span> <span class="nf">condition_pedastrian_request</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

  130.         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">pedastrian_request</span>

  131. 

  132. 

  133. <span class="n">sm</span> <span class="o">=</span> <span class="n">trafic_lights</span><span class="p">(</span><span class="n">trafic_lights</span><span class="o">.</span><span class="n">STATE_RED</span><span class="p">,</span> <span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">,</span> <span class="n">pedastrian_request</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>

  134. <span class="n">sm</span><span class="o">.</span><span class="n">register_state_change_callback</span><span class="p">(</span><span class="n">sm</span><span class="o">.</span><span class="n">STATE_GREEN</span><span class="p">,</span> <span class="n">sm</span><span class="o">.</span><span class="n">CONDITION_PEDASTRIAN_REQUEST</span><span class="p">,</span> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">,</span> <span class="s1">&#39;Callback information: Traffic light had been changed to green caused by pedastrian request&#39;</span><span class="p">)</span>

  135. <span class="k">while</span> <span class="ow">not</span> <span class="n">sm</span><span class="o">.</span><span class="n">previous_state_was</span><span class="p">(</span><span class="n">sm</span><span class="o">.</span><span class="n">STATE_GREEN</span><span class="p">):</span>

  136.     <span class="k">if</span> <span class="n">sm</span><span class="o">.</span><span class="n">this_state_is</span><span class="p">(</span><span class="n">sm</span><span class="o">.</span><span class="n">STATE_RED</span><span class="p">)</span> <span class="ow">and</span> <span class="n">sm</span><span class="o">.</span><span class="n">this_state_duration</span><span class="p">()</span> <span class="o">&gt;</span> <span class="mf">0.2</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">sm</span><span class="o">.</span><span class="n">condition_pedastrian_request</span><span class="p">():</span>

  137.         <span class="n">sm</span><span class="o">.</span><span class="n">set_padestrian_request</span><span class="p">()</span>

  138.     <span class="n">sm</span><span class="o">.</span><span class="n">work</span><span class="p">()</span>

  139. </pre></div>

  140. </div>

  141. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="mi">2019</span><span class="o">-</span><span class="mi">12</span><span class="o">-</span><span class="mi">26</span> <span class="mi">13</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">44</span><span class="p">,</span><span class="mi">154</span><span class="p">:</span> <span class="n">INFO</span>    <span class="o">-</span> <span class="n">TraficLights</span><span class="p">:</span> <span class="n">State</span> <span class="n">change</span> <span class="p">(</span><span class="s1">&#39;__init__&#39;</span><span class="p">):</span> <span class="kc">None</span> <span class="o">-&gt;</span> <span class="s1">&#39;state_red&#39;</span>

  142. <span class="mi">2019</span><span class="o">-</span><span class="mi">12</span><span class="o">-</span><span class="mi">26</span> <span class="mi">13</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">44</span><span class="p">,</span><span class="mi">354</span><span class="p">:</span> <span class="n">INFO</span>    <span class="o">-</span> <span class="n">TraficLights</span><span class="p">:</span> <span class="n">Pedestrian</span> <span class="n">gave</span> <span class="n">state</span> <span class="n">change</span> <span class="n">request</span><span class="o">.</span>

  143. <span class="mi">2019</span><span class="o">-</span><span class="mi">12</span><span class="o">-</span><span class="mi">26</span> <span class="mi">13</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">45</span><span class="p">,</span><span class="mi">354</span><span class="p">:</span> <span class="n">INFO</span>    <span class="o">-</span> <span class="n">TraficLights</span><span class="p">:</span> <span class="n">State</span> <span class="n">change</span> <span class="p">(</span><span class="s1">&#39;condition_pedastrian_request&#39;</span><span class="p">):</span> <span class="s1">&#39;state_red&#39;</span> <span class="o">-&gt;</span> <span class="s1">&#39;state_green&#39;</span>

  144. <span class="mi">2019</span><span class="o">-</span><span class="mi">12</span><span class="o">-</span><span class="mi">26</span> <span class="mi">13</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">45</span><span class="p">,</span><span class="mi">354</span><span class="p">:</span> <span class="n">INFO</span>    <span class="o">-</span> <span class="n">Callback</span> <span class="n">information</span><span class="p">:</span> <span class="n">Traffic</span> <span class="n">light</span> <span class="n">had</span> <span class="n">been</span> <span class="n">changed</span> <span class="n">to</span> <span class="n">green</span> <span class="n">caused</span> <span class="n">by</span> <span class="n">pedastrian</span> <span class="n">request</span>

  145. <span class="mi">2019</span><span class="o">-</span><span class="mi">12</span><span class="o">-</span><span class="mi">26</span> <span class="mi">13</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">48</span><span class="p">,</span><span class="mi">355</span><span class="p">:</span> <span class="n">INFO</span>    <span class="o">-</span> <span class="n">TraficLights</span><span class="p">:</span> <span class="n">State</span> <span class="n">change</span> <span class="p">(</span><span class="s1">&#39;condition_true&#39;</span><span class="p">):</span> <span class="s1">&#39;state_green&#39;</span> <span class="o">-&gt;</span> <span class="s1">&#39;state_red&#39;</span>

  146. </pre></div>

  147. </div>

  148. <dl class="method">

  149. <dt id="state_machine.state_machine.last_transition_condition">

  150. <code class="descname">last_transition_condition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#state_machine.state_machine.last_transition_condition" title="Permalink to this definition">¶</a></dt>

  151. <dd><table class="docutils field-list" frame="void" rules="none">

  152. <col class="field-name" />

  153. <col class="field-body" />

  154. <tbody valign="top">

  155. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The last transition condition.</td>

  156. </tr>

  157. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>

  158. </tr>

  159. </tbody>

  160. </table>

  161. <p>This method returns the last transition condition.</p>

  162. </dd></dl>

  163. 

  164. <dl class="method">

  165. <dt id="state_machine.state_machine.last_transition_condition_was">

  166. <code class="descname">last_transition_condition_was</code><span class="sig-paren">(</span><em>condition</em><span class="sig-paren">)</span><a class="headerlink" href="#state_machine.state_machine.last_transition_condition_was" title="Permalink to this definition">¶</a></dt>

  167. <dd><table class="docutils field-list" frame="void" rules="none">

  168. <col class="field-name" />

  169. <col class="field-body" />

  170. <tbody valign="top">

  171. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>condition</strong> (<em>str</em>) – The condition to be checked</td>

  172. </tr>

  173. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the given condition was the last transition condition, else False.</td>

  174. </tr>

  175. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

  176. </tr>

  177. </tbody>

  178. </table>

  179. <p>This methods returns the boolean information if the last transition condition is equivalent to the given condition.</p>

  180. </dd></dl>

  181. 

  182. <dl class="method">

  183. <dt id="state_machine.state_machine.previous_state">

  184. <code class="descname">previous_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#state_machine.state_machine.previous_state" title="Permalink to this definition">¶</a></dt>

  185. <dd><table class="docutils field-list" frame="void" rules="none">

  186. <col class="field-name" />

  187. <col class="field-body" />

  188. <tbody valign="top">

  189. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The previous state.</td>

  190. </tr>

  191. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>

  192. </tr>

  193. </tbody>

  194. </table>

  195. <p>This method returns the previous state of the state machine.</p>

  196. </dd></dl>

  197. 

  198. <dl class="method">

  199. <dt id="state_machine.state_machine.previous_state_duration">

  200. <code class="descname">previous_state_duration</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#state_machine.state_machine.previous_state_duration" title="Permalink to this definition">¶</a></dt>

  201. <dd><table class="docutils field-list" frame="void" rules="none">

  202. <col class="field-name" />

  203. <col class="field-body" />

  204. <tbody valign="top">

  205. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The time how long the previous state was active.</td>

  206. </tr>

  207. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">float</td>

  208. </tr>

  209. </tbody>

  210. </table>

  211. <p>This method returns the time how long the previous state was active.</p>

  212. </dd></dl>

  213. 

  214. <dl class="method">

  215. <dt id="state_machine.state_machine.previous_state_was">

  216. <code class="descname">previous_state_was</code><span class="sig-paren">(</span><em>state</em><span class="sig-paren">)</span><a class="headerlink" href="#state_machine.state_machine.previous_state_was" title="Permalink to this definition">¶</a></dt>

  217. <dd><table class="docutils field-list" frame="void" rules="none">

  218. <col class="field-name" />

  219. <col class="field-body" />

  220. <tbody valign="top">

  221. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>state</strong> (<em>str</em>) – The state to be checked</td>

  222. </tr>

  223. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the given state was previously active, else False.</td>

  224. </tr>

  225. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

  226. </tr>

  227. </tbody>

  228. </table>

  229. <p>This methods returns the boolean information if the state machine was previously in the given state.</p>

  230. </dd></dl>

  231. 

  232. <dl class="method">

  233. <dt id="state_machine.state_machine.register_state_change_callback">

  234. <code class="descname">register_state_change_callback</code><span class="sig-paren">(</span><em>state</em>, <em>condition</em>, <em>callback</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#state_machine.state_machine.register_state_change_callback" title="Permalink to this definition">¶</a></dt>

  235. <dd><table class="docutils field-list" frame="void" rules="none">

  236. <col class="field-name" />

  237. <col class="field-body" />

  238. <tbody valign="top">

  239. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

  240. <li><strong>state</strong> (<em>str</em>) – The target state. The callback will be executed, if the state machine changes to this state. None means all states.</li>

  241. <li><strong>condition</strong> (<em>str</em>) – The transition condition. The callback will be executed, if this condition is responsible for the state change. None means all conditions.</li>

  242. <li><strong>callback</strong> – The callback to be executed.</li>

  243. </ul>

  244. </td>

  245. </tr>

  246. </tbody>

  247. </table>

  248. <div class="admonition note">

  249. <p class="first admonition-title">Note</p>

  250. <p class="last">Additional arguments and keyword parameters are supported. These arguments and parameters will be used as arguments and parameters for the callback execution.</p>

  251. </div>

  252. <p>This methods allows to register callbacks which will be executed on state changes.</p>

  253. </dd></dl>

  254. 

  255. <dl class="method">

  256. <dt id="state_machine.state_machine.this_state">

  257. <code class="descname">this_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#state_machine.state_machine.this_state" title="Permalink to this definition">¶</a></dt>

  258. <dd><table class="docutils field-list" frame="void" rules="none">

  259. <col class="field-name" />

  260. <col class="field-body" />

  261. <tbody valign="top">

  262. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The current state.</td>

  263. </tr>

  264. </tbody>

  265. </table>

  266. <p>This method returns the current state of the state machine.</p>

  267. </dd></dl>

  268. 

  269. <dl class="method">

  270. <dt id="state_machine.state_machine.this_state_duration">

  271. <code class="descname">this_state_duration</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#state_machine.state_machine.this_state_duration" title="Permalink to this definition">¶</a></dt>

  272. <dd><table class="docutils field-list" frame="void" rules="none">

  273. <col class="field-name" />

  274. <col class="field-body" />

  275. <tbody valign="top">

  276. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The time how long the current state is active.</td>

  277. </tr>

  278. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">float</td>

  279. </tr>

  280. </tbody>

  281. </table>

  282. <p>This method returns the time how long the current state is active.</p>

  283. </dd></dl>

  284. 

  285. <dl class="method">

  286. <dt id="state_machine.state_machine.this_state_is">

  287. <code class="descname">this_state_is</code><span class="sig-paren">(</span><em>state</em><span class="sig-paren">)</span><a class="headerlink" href="#state_machine.state_machine.this_state_is" title="Permalink to this definition">¶</a></dt>

  288. <dd><table class="docutils field-list" frame="void" rules="none">

  289. <col class="field-name" />

  290. <col class="field-body" />

  291. <tbody valign="top">

  292. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>state</strong> (<em>str</em>) – The state to be checked</td>

  293. </tr>

  294. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the given state is currently active, else False.</td>

  295. </tr>

  296. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

  297. </tr>

  298. </tbody>

  299. </table>

  300. <p>This methods returns the boolean information if the state machine is currently in the given state.</p>

  301. </dd></dl>

  302. 

  303. <dl class="method">

  304. <dt id="state_machine.state_machine.work">

  305. <code class="descname">work</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#state_machine.state_machine.work" title="Permalink to this definition">¶</a></dt>

  306. <dd><p>This Method needs to be executed cyclicly to enable the state machine.</p>

  307. </dd></dl>

  308. 

  309. </dd></dl>

  310. 

  311. </div>

  312. <div class="toctree-wrapper compound">

  313. </div>

  314. </div>

  315. <div class="section" id="indices-and-tables">

  316. <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>

  317. <ul class="simple">

  318. <li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>

  319. <li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>

  320. <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>

  321. </ul>

  322. </div>

  323. 

  324. 

  325.           </div>

  326.         </div>

  327.       </div>

  328.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  329.         <div class="sphinxsidebarwrapper"><div class="relations">

  330. <h3>Related Topics</h3>

  331. <ul>

  332.   <li><a href="#">Documentation overview</a><ul>

  333.   </ul></li>

  334. </ul>

  335. </div>

  336. <div id="searchbox" style="display: none" role="search">

  337.   <h3>Quick search</h3>

  338.     <form class="search" action="search.html" method="get">

  339.       <div><input type="text" name="q" /></div>

  340.       <div><input type="submit" value="Go" /></div>

  341.       <input type="hidden" name="check_keywords" value="yes" />

  342.       <input type="hidden" name="area" value="default" />

  343.     </form>

  344. </div>

  345. <script type="text/javascript">$('#searchbox').show(0);</script>

  346.         </div>

  347.       </div>

  348.       <div class="clearer"></div>

  349.     </div>

  350.     <div class="footer">

  351.       &copy;2019, Dirk Alders.

  352.       

  353.       |

  354.       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.7</a>

  355.       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>

  356.       

  357.       |

  358.       <a href="_sources/index.rst.txt"

  359.           rel="nofollow">Page source</a>

  360.     </div>

  361. 

  362.     

  363. 

  364.     

  365.   </body>

  366. </html>