weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2026-08-14 03:40:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2022-10-29 08:17:27 +00:00
parent 0f55b75634
commit c2cbd9d497
77 changed files with 1913 additions and 1872 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Documentation/Core.Fsm.html
+21 -21
View File
@@ -1664,8 +1664,8 @@ Each of these FSM implementation classes start either with:</p>
<ul>
<li>an acronym <strong>AI_</strong>, which indicates a FSM implementation directing <strong>AI controlled</strong> <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> and/or <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>. These AI_ classes derive the <a href="##(FSM_CONTROLLABLE)">#FSM_CONTROLLABLE</a> class.</li>
<li>an acronym <strong>TASK_</strong>, which indicates a FSM implementation executing a <a href="TASK.html">TASK</a> executed by Groups of players. These TASK_ classes derive the <a href="##(FSM_TASK)">#FSM_TASK</a> class.</li>
<li>an acronym <strong>ACT_</strong>, which indicates an Sub-FSM implementation, directing <strong>Humans actions</strong> that need to be done in a <a href="TASK.html">TASK</a>, seated in a <a href="CLIENT.html">CLIENT</a> (slot) or a <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> (CA join). These ACT_ classes derive the <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> class.</li>
<li>an acronym <strong>TASK_</strong>, which indicates a FSM implementation executing a <a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a> executed by Groups of players. These TASK_ classes derive the <a href="##(FSM_TASK)">#FSM_TASK</a> class.</li>
<li>an acronym <strong>ACT_</strong>, which indicates an Sub-FSM implementation, directing <strong>Humans actions</strong> that need to be done in a <a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a>, seated in a <a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a> (slot) or a <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> (CA join). These ACT_ classes derive the <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> class.</li>
</ul>
<p>Detailed explanations and API specifics are further below clarified and FSM derived class specifics are described in those class documentation sections.</p>
@@ -1679,9 +1679,9 @@ Additionally, I've added extendability and created an API that allows seamless F
<p>The following derived classes are available in the MOOSE framework, that implement a specialized form of a FSM:</p>
<ul>
<li><a href="##(FSM_TASK)">#FSM_TASK</a>: Models Finite State Machines for <a href="Task.html">Task</a>s.</li>
<li><a href="##(FSM_PROCESS)">#FSM_PROCESS</a>: Models Finite State Machines for <a href="Task.html">Task</a> actions, which control <a href="Client.html">Client</a>s.</li>
<li><a href="##(FSM_CONTROLLABLE)">#FSM_CONTROLLABLE</a>: Models Finite State Machines for <a href="Wrapper.Controllable.html">Wrapper.Controllable</a>s, which are <a href="Wrapper.Group.html">Wrapper.Group</a>s, <a href="Wrapper.Unit.html">Wrapper.Unit</a>s, <a href="Client.html">Client</a>s.</li>
<li><a href="##(FSM_TASK)">#FSM_TASK</a>: Models Finite State Machines for <a href="Tasking.Task.html">Tasking.Task</a>s.</li>
<li><a href="##(FSM_PROCESS)">#FSM_PROCESS</a>: Models Finite State Machines for <a href="Tasking.Task.html">Tasking.Task</a> actions, which control <a href="Wrapper.Client.html">Wrapper.Client</a>s.</li>
<li><a href="##(FSM_CONTROLLABLE)">#FSM_CONTROLLABLE</a>: Models Finite State Machines for <a href="Wrapper.Controllable.html">Wrapper.Controllable</a>s, which are <a href="Wrapper.Group.html">Wrapper.Group</a>s, <a href="Wrapper.Unit.html">Wrapper.Unit</a>s, <a href="Wrapper.Client.html">Wrapper.Client</a>s.</li>
<li><a href="##(FSM_SET)">#FSM_SET</a>: Models Finite State Machines for <a href="Core.Set.html">Core.Set</a>s. Note that these FSMs control multiple objects!!! So State concerns here
for multiple objects or the position of the state machine in the process.</li>
</ul>
@@ -1749,8 +1749,8 @@ Each of these FSM implementation classes start either with:</p>
<ul>
<li>an acronym <strong>AI_</strong>, which indicates an FSM implementation directing <strong>AI controlled</strong> <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> and/or <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>. These AI_ classes derive the <a href="##(FSM_CONTROLLABLE)">#FSM_CONTROLLABLE</a> class.</li>
<li>an acronym <strong>TASK_</strong>, which indicates an FSM implementation executing a <a href="TASK.html">TASK</a> executed by Groups of players. These TASK_ classes derive the <a href="##(FSM_TASK)">#FSM_TASK</a> class.</li>
<li>an acronym <strong>ACT_</strong>, which indicates an Sub-FSM implementation, directing <strong>Humans actions</strong> that need to be done in a <a href="TASK.html">TASK</a>, seated in a <a href="CLIENT.html">CLIENT</a> (slot) or a <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> (CA join). These ACT_ classes derive the <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> class.</li>
<li>an acronym <strong>TASK_</strong>, which indicates an FSM implementation executing a <a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a> executed by Groups of players. These TASK_ classes derive the <a href="##(FSM_TASK)">#FSM_TASK</a> class.</li>
<li>an acronym <strong>ACT_</strong>, which indicates an Sub-FSM implementation, directing <strong>Humans actions</strong> that need to be done in a <a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a>, seated in a <a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a> (slot) or a <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> (CA join). These ACT_ classes derive the <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> class.</li>
</ul>
<p><img src="..\Presentations\FSM\Dia3.JPG" alt="Transition Rules and Transition Handlers and Event Triggers"/></p>
@@ -2004,7 +2004,7 @@ Depending upon <strong>which state is returned</strong>, the main FSM can contin
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>FSM_CONTROLLABLE</strong></h2></p></td>
<td class="style="width:60%;">
<p>Models Finite State Machines for <a href="Wrapper.Controllable.html">Wrapper.Controllable</a>s, which are <a href="Wrapper.Group.html">Wrapper.Group</a>s, <a href="Wrapper.Unit.html">Wrapper.Unit</a>s, <a href="Client.html">Client</a>s.</p>
<p>Models Finite State Machines for <a href="Wrapper.Controllable.html">Wrapper.Controllable</a>s, which are <a href="Wrapper.Group.html">Wrapper.Group</a>s, <a href="Wrapper.Unit.html">Wrapper.Unit</a>s, <a href="Wrapper.Client.html">Wrapper.Client</a>s.</p>
</td>
</tr>
</table>
@@ -2015,7 +2015,7 @@ Depending upon <strong>which state is returned</strong>, the main FSM can contin
<a href="##(FSM_CONTROLLABLE)">#FSM_CONTROLLABLE</a>
<a id="FSM_CONTROLLABLE" ><strong>FSM_CONTROLLABLE</strong></a>
<p>Models Finite State Machines for <a href="Wrapper.Controllable.html">Wrapper.Controllable</a>s, which are <a href="Wrapper.Group.html">Wrapper.Group</a>s, <a href="Wrapper.Unit.html">Wrapper.Unit</a>s, <a href="Client.html">Client</a>s.</p>
<p>Models Finite State Machines for <a href="Wrapper.Controllable.html">Wrapper.Controllable</a>s, which are <a href="Wrapper.Group.html">Wrapper.Group</a>s, <a href="Wrapper.Unit.html">Wrapper.Unit</a>s, <a href="Wrapper.Client.html">Wrapper.Client</a>s.</p>
@@ -2030,7 +2030,7 @@ Depending upon <strong>which state is returned</strong>, the main FSM can contin
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>FSM_PROCESS</strong></h2></p></td>
<td class="style="width:60%;">
<p>FSM_PROCESS class models Finite State Machines for <a href="Task.html">Task</a> actions, which control <a href="Client.html">Client</a>s.</p>
<p>FSM_PROCESS class models Finite State Machines for <a href="Tasking.Task.html">Tasking.Task</a> actions, which control <a href="Wrapper.Client.html">Wrapper.Client</a>s.</p>
</td>
</tr>
</table>
@@ -2041,7 +2041,7 @@ Depending upon <strong>which state is returned</strong>, the main FSM can contin
<a href="##(FSM_PROCESS)">#FSM_PROCESS</a>
<a id="FSM_PROCESS" ><strong>FSM_PROCESS</strong></a>
<p>FSM_PROCESS class models Finite State Machines for <a href="Task.html">Task</a> actions, which control <a href="Client.html">Client</a>s.</p>
<p>FSM_PROCESS class models Finite State Machines for <a href="Tasking.Task.html">Tasking.Task</a> actions, which control <a href="Wrapper.Client.html">Wrapper.Client</a>s.</p>
@@ -2126,7 +2126,7 @@ for multiple objects or the position of the state machine in the process.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(FSM).AddProcess">FSM:AddProcess(From, Event, Process, ReturnEvents)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set the default <a href="Process.html">Process</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
<p>Set the default <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3021,7 +3021,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(FSM_CONTROLLABLE).AddProcess">FSM_CONTROLLABLE:AddProcess(From, Event, Process, ReturnEvents)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set the default <a href="Process.html">Process</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
<p>Set the default <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3873,7 +3873,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(FSM_PROCESS).Message">FSM_PROCESS:Message(Message)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Send a message of the <a href="Task.html">Task</a> to the Group of the Unit.</p>
<p>Send a message of the <a href="Tasking.Task.html">Tasking.Task</a> to the Group of the Unit.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4009,7 +4009,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(FSM_PROCESS).AddProcess">FSM_PROCESS:AddProcess(From, Event, Process, ReturnEvents)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set the default <a href="Process.html">Process</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
<p>Set the default <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4862,7 +4862,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(FSM_SET).AddProcess">FSM_SET:AddProcess(From, Event, Process, ReturnEvents)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set the default <a href="Process.html">Process</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
<p>Set the default <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
</td>
</tr>
<tr class="w3-border">
@@ -5902,7 +5902,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(FSM).AddProcess" ><strong>FSM:AddProcess(From, Event, Process, ReturnEvents)</strong></a></h2>
</div>
<p>Set the default <a href="Process.html">Process</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
<p>Set the default <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
<div id= "#Functions##AddProcess" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -11439,7 +11439,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
<h2><a id="#(FSM_CONTROLLABLE).AddProcess" ><strong>FSM_CONTROLLABLE:AddProcess(From, Event, Process, ReturnEvents)</strong></a></h2>
</div>
<p>Set the default <a href="Process.html">Process</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
<p>Set the default <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
<div id= "#Functions##AddProcess" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -16456,7 +16456,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
<h2><a id="#(FSM_PROCESS).Message" ><strong>FSM_PROCESS:Message(Message)</strong></a></h2>
</div>
<p>Send a message of the <a href="Task.html">Task</a> to the Group of the Unit.</p>
<p>Send a message of the <a href="Tasking.Task.html">Tasking.Task</a> to the Group of the Unit.</p>
<div id= "#Functions##Message" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -17431,7 +17431,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
<h2><a id="#(FSM_PROCESS).AddProcess" ><strong>FSM_PROCESS:AddProcess(From, Event, Process, ReturnEvents)</strong></a></h2>
</div>
<p>Set the default <a href="Process.html">Process</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
<p>Set the default <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
<div id= "#Functions##AddProcess" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -22433,7 +22433,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
<h2><a id="#(FSM_SET).AddProcess" ><strong>FSM_SET:AddProcess(From, Event, Process, ReturnEvents)</strong></a></h2>
</div>
<p>Set the default <a href="Process.html">Process</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
<p>Set the default <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
<div id= "#Functions##AddProcess" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">