mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2025-08-15 10:37:49 +00:00
MOOSE generated documentation [skip ci]
This commit is contained in:
Applevangelist
@@ -1686,6 +1686,18 @@
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).New">CONDITION:New(Name)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Create a new CONDITION object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).RemoveFunction">CONDITION:RemoveFunction(ConditionFunction)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Remove a condition function.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).RemoveNonPersistant">CONDITION:RemoveNonPersistant()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Remove all non-persistant condition functions.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1704,6 +1716,12 @@
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).SetAny">CONDITION:SetAny(Any)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Set that general condition functions return <code>true</code> if <code>any</code> function returns <code>true</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).SetDefaultPersistence">CONDITION:SetDefaultPersistence(IsPersistent)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Set whether condition functions are persistent, <em>i.e.</em> are removed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1713,7 +1731,13 @@
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION)._CreateCondition">CONDITION:_CreateCondition(Function, ...)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).SetNoneResult">CONDITION:SetNoneResult(ReturnValue)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Set whether <code>true</code> or <code>false</code> is returned, if no conditions at all were specified.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION)._CreateCondition">CONDITION:_CreateCondition(Ftype, Function, ...)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Create conditon function object.</p>
|
||||
</td>
|
||||
@@ -1728,13 +1752,25 @@
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION)._EvalConditionsAny">CONDITION:_EvalConditionsAny(functions)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Check if any of the given conditions is true.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).defaultPersist">CONDITION.defaultPersist</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Default persistence of condition functions.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).functionCounter">CONDITION.functionCounter</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Running number to determine the unique ID of condition functions.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).functionsAll">CONDITION.functionsAll</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>All condition functions.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1770,7 +1806,13 @@
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).negateResult">CONDITION.negateResult</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Negeate result of evaluation.</p>
|
||||
<p>Negate result of evaluation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).noneResult">CONDITION.noneResult</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Boolean that is returned if no condition functions at all were specified.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2337,7 +2379,25 @@ 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="##(CONDITION.Function).func">CONDITION.Function.func</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Callback function to check for a condition. Should return a <code>#boolean</code>.</p>
|
||||
<p>Callback function to check for a condition. Must return a <code>#boolean</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION.Function).persistence">CONDITION.Function.persistence</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>If <code>true</code>, this is persistent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION.Function).type">CONDITION.Function.type</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Type of the condition function: "gen", "any", "all".</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION.Function).uid">CONDITION.Function.uid</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Unique ID of the condition function.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -2368,6 +2428,29 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(CONDITION).defaultPersist" ><strong>CONDITION.defaultPersist</strong></a>
|
||||
|
||||
<p>Default persistence of condition functions.</p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(CONDITION).functionCounter" ><strong>CONDITION.functionCounter</strong></a>
|
||||
|
||||
<p>Running number to determine the unique ID of condition functions.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
@@ -2377,7 +2460,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
<p>All condition functions.</p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -2442,7 +2524,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
#boolean
|
||||
<a id="#(CONDITION).negateResult" ><strong>CONDITION.negateResult</strong></a>
|
||||
|
||||
<p>Negeate result of evaluation.</p>
|
||||
<p>Negate result of evaluation.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(CONDITION).noneResult" ><strong>CONDITION.noneResult</strong></a>
|
||||
|
||||
<p>Boolean that is returned if no condition functions at all were specified.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -2508,11 +2601,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(CONDITION)">#CONDITION</a>:</p>
|
||||
<p><a href="##(CONDITION.Function)">#CONDITION.Function</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self</p>
|
||||
<p>Condition function table.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -2575,11 +2668,11 @@ myCondition:AddFunction(isAequalB, a, b)
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(CONDITION)">#CONDITION</a>:</p>
|
||||
<p><a href="##(CONDITION.Function)">#CONDITION.Function</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self</p>
|
||||
<p>Condition function table.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -2634,11 +2727,11 @@ myCondition:AddFunction(isAequalB, a, b)
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(CONDITION)">#CONDITION</a>:</p>
|
||||
<p><a href="##(CONDITION.Function)">#CONDITION.Function</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self</p>
|
||||
<p>Condition function table.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -2837,6 +2930,80 @@ Technically, a random number between 0 and 100 is created. If the given success
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(CONDITION).RemoveFunction" ><strong>CONDITION:RemoveFunction(ConditionFunction)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Remove a condition function.</p>
|
||||
|
||||
<div id= "#Functions##RemoveFunction" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>CONDITION</p>
|
||||
</div>
|
||||
<h2><strong>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="##(CONDITION.Function)">#CONDITION.Function</a>
|
||||
<strong><strong>ConditionFunction</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The condition function to be removed.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(CONDITION)">#CONDITION</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(CONDITION).RemoveNonPersistant" ><strong>CONDITION:RemoveNonPersistant()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Remove all non-persistant condition functions.</p>
|
||||
|
||||
<div id= "#Functions##RemoveNonPersistant" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>CONDITION</p>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(CONDITION)">#CONDITION</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -2944,6 +3111,50 @@ Technically, a random number between 0 and 100 is created. If the given success
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(CONDITION).SetDefaultPersistence" ><strong>CONDITION:SetDefaultPersistence(IsPersistent)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Set whether condition functions are persistent, <em>i.e.</em> are removed.</p>
|
||||
|
||||
<div id= "#Functions##SetDefaultPersistence" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>CONDITION</p>
|
||||
</div>
|
||||
<h2><strong>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#boolean
|
||||
<strong><strong>IsPersistent</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>If <code>true</code>, condition functions are persistent.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(CONDITION)">#CONDITION</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -2994,7 +3205,54 @@ Technically, a random number between 0 and 100 is created. If the given success
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(CONDITION)._CreateCondition" ><strong>CONDITION:_CreateCondition(Function, ...)</strong></a></h2>
|
||||
<h2><a id="#(CONDITION).SetNoneResult" ><strong>CONDITION:SetNoneResult(ReturnValue)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Set whether <code>true</code> or <code>false</code> is returned, if no conditions at all were specified.</p>
|
||||
|
||||
|
||||
<p>By default <code>false</code> is returned.</p>
|
||||
|
||||
<div id= "#Functions##SetNoneResult" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>CONDITION</p>
|
||||
</div>
|
||||
<h2><strong>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#boolean
|
||||
<strong><strong>ReturnValue</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Returns this boolean.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(CONDITION)">#CONDITION</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(CONDITION)._CreateCondition" ><strong>CONDITION:_CreateCondition(Ftype, Function, ...)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Create conditon function object.</p>
|
||||
@@ -3006,6 +3264,19 @@ Technically, a random number between 0 and 100 is created. If the given success
|
||||
<p>CONDITION</p>
|
||||
</div>
|
||||
<h2><strong>Parameters:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Ftype</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Function type: 0=Gen, 1=All, 2=Any.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
@@ -3148,6 +3419,29 @@ Technically, a random number between 0 and 100 is created. If the given success
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(CONDITION).defaultPersist" ><strong>CONDITION.defaultPersist</strong></a>
|
||||
|
||||
<p>Default persistence of condition functions.</p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(CONDITION).functionCounter" ><strong>CONDITION.functionCounter</strong></a>
|
||||
|
||||
<p>Running number to determine the unique ID of condition functions.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
@@ -3157,7 +3451,6 @@ Technically, a random number between 0 and 100 is created. If the given success
|
||||
|
||||
<p>All condition functions.</p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -3222,7 +3515,18 @@ Technically, a random number between 0 and 100 is created. If the given success
|
||||
#boolean
|
||||
<a id="#(CONDITION).negateResult" ><strong>CONDITION.negateResult</strong></a>
|
||||
|
||||
<p>Negeate result of evaluation.</p>
|
||||
<p>Negate result of evaluation.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(CONDITION).noneResult" ><strong>CONDITION.noneResult</strong></a>
|
||||
|
||||
<p>Boolean that is returned if no condition functions at all were specified.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -6617,7 +6921,40 @@ When moose is loading dynamically (for moose class development), tracing is swit
|
||||
#function
|
||||
<a id="#(CONDITION.Function).func" ><strong>CONDITION.Function.func</strong></a>
|
||||
|
||||
<p>Callback function to check for a condition. Should return a <code>#boolean</code>.</p>
|
||||
<p>Callback function to check for a condition. Must return a <code>#boolean</code>.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(CONDITION.Function).persistence" ><strong>CONDITION.Function.persistence</strong></a>
|
||||
|
||||
<p>If <code>true</code>, this is persistent.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(CONDITION.Function).type" ><strong>CONDITION.Function.type</strong></a>
|
||||
|
||||
<p>Type of the condition function: "gen", "any", "all".</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(CONDITION.Function).uid" ><strong>CONDITION.Function.uid</strong></a>
|
||||
|
||||
<p>Unique ID of the condition function.</p>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user