task_system_state.html

<!DOCTYPE html>

<html lang="en" data-content_root="../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

    <title>Task System State &#8212; MWorks 0.14.dev documentation</title>
    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
    <link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../_static/custom.css?v=6573aa41" />
    
    <script src="../_static/documentation_options.js?v=e978e1ea"></script>
    <script src="../_static/doctools.js?v=fd6eb6e6"></script>
    <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
    <script src="../_static/bizstyle.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Trial" href="trial.html" />
    <link rel="prev" title="Task System" href="task_system.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="trial.html" title="Trial"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="task_system.html" title="Task System"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">MWorks 0.14.dev documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../reference/index.html" >Reference Manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="index.html" >Components</a> &#187;</li>
          <li class="nav-item nav-item-3"><a href="paradigm_components.html" accesskey="U">Paradigm Components</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Task System State</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <section id="task-system-state">
<span id="index-0"></span><span id="id1"></span><h1>Task System State<a class="headerlink" href="#task-system-state" title="Link to this heading">¶</a></h1>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Link to this heading">¶</a></h2>
<p>A paradigm component defining a state within a <a class="reference external" href="https://en.wikipedia.org/wiki/Finite-state_machine">finite state machine</a>. It is contained within a <a class="reference internal" href="task_system.html#task-system"><span class="std std-ref">Task System</span></a> and specifies a list of <a class="reference internal" href="actions.html#actions"><span class="std std-ref">Actions</span></a>, which are executed when the state first gains control, and a list of <a class="reference internal" href="transitions.html#transitions"><span class="std std-ref">Transitions</span></a>, which are evaluated repeatedly until one of them succeeds and selects the next state.</p>
</section>
<section id="signature">
<h2>Signature<a class="headerlink" href="#signature" title="Link to this heading">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">task_system_state</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Alias<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">state</span></code> <em>(MWEL only)</em></p>
</dd>
</dl>
</section>
<section id="optional-parameters">
<h2>Optional Parameters<a class="headerlink" href="#optional-parameters" title="Link to this heading">¶</a></h2>
<section id="interruptible">
<h3>interruptible<a class="headerlink" href="#interruptible" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">YES</span></code></p>
</dd>
</dl>
<p>If <code class="docutils literal notranslate"><span class="pre">NO</span></code>, then any request to pause or stop the experiment while this component is executing will be deferred until said execution completes. This behavior is inherited by the component’s children, making them non-interruptible as well.</p>
</section>
</section>
<section id="placement">
<h2>Placement<a class="headerlink" href="#placement" title="Link to this heading">¶</a></h2>
<table class="docutils align-default">
<tbody>
<tr class="row-odd"><th class="stub"><p>Allowed at top level:</p></th>
<td><p>No</p></td>
</tr>
<tr class="row-even"><th class="stub"><p>Allowed parent:</p></th>
<td><p><a class="reference internal" href="task_system.html#task-system"><span class="std std-ref">Task System</span></a></p></td>
</tr>
<tr class="row-odd"><th class="stub"><p>Allowed children:</p></th>
<td><p><a class="reference internal" href="actions.html#actions"><span class="std std-ref">Action</span></a>, <a class="reference internal" href="transitions.html#transitions"><span class="std std-ref">Transition</span></a></p></td>
</tr>
</tbody>
</table>
</section>
</section>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
  <div>
    <h3><a href="../index.html">Table of Contents</a></h3>
    <ul>
<li><a class="reference internal" href="#">Task System State</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#signature">Signature</a></li>
<li><a class="reference internal" href="#optional-parameters">Optional Parameters</a><ul>
<li><a class="reference internal" href="#interruptible">interruptible</a></li>
</ul>
</li>
<li><a class="reference internal" href="#placement">Placement</a></li>
</ul>
</li>
</ul>

  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="task_system.html"
                          title="previous chapter">Task System</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="trial.html"
                          title="next chapter">Trial</a></p>
  </div>
<search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="trial.html" title="Trial"
             >next</a> |</li>
        <li class="right" >
          <a href="task_system.html" title="Task System"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">MWorks 0.14.dev documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../reference/index.html" >Reference Manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="index.html" >Components</a> &#187;</li>
          <li class="nav-item nav-item-3"><a href="paradigm_components.html" >Paradigm Components</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Task System State</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2016-2026, The MWorks Project.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
    </div>
  </body>
</html>