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
@@ -1668,12 +1668,36 @@
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).Evaluate">CONDITION:Evaluate(AnyTrue)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Evaluate conditon functions.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).IsRandomSuccess">CONDITION.IsRandomSuccess(Probability)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Function that returns <code>true</code> (success) with a certain probability.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).IsTimeGreater">CONDITION.IsTimeGreater(Time, Absolute)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Condition to check if time is greater than a given threshold time.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<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).ReturnFalse">CONDITION.ReturnFalse()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Function that returns always <code>false</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).ReturnTrue">CONDITION.ReturnTrue()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Function that returns always <code>true</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1740,7 +1764,7 @@
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONDITION).name">CONDITION.name</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Name of the condition.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2400,6 +2424,17 @@ 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">
|
||||
|
||||
#string
|
||||
<a id="#(CONDITION).name" ><strong>CONDITION.name</strong></a>
|
||||
|
||||
<p>Name of the condition.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
@@ -2653,6 +2688,111 @@ myCondition:AddFunction(isAequalB, a, b)
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(CONDITION).IsRandomSuccess" ><strong>CONDITION.IsRandomSuccess(Probability)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Function that returns <code>true</code> (success) with a certain probability.</p>
|
||||
|
||||
|
||||
<p>For example, if you specify <code>Probability=80</code> there is an 80% chance that <code>true</code> is returned.
|
||||
Technically, a random number between 0 and 100 is created. If the given success probability is less then this number, <code>true</code> is returned.</p>
|
||||
|
||||
<div id= "#Functions##IsRandomSuccess" 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>
|
||||
#number
|
||||
<strong><strong>Probability</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Success probability in percent. Default 50 %.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p>#boolean:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Returns <code>true</code> for success and <code>false</code> otherwise.</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).IsTimeGreater" ><strong>CONDITION.IsTimeGreater(Time, Absolute)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Condition to check if time is greater than a given threshold time.</p>
|
||||
|
||||
<div id= "#Functions##IsTimeGreater" 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>Parameters:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Time</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Time in seconds.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#boolean
|
||||
<strong><strong>Absolute</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>If <code>true</code>, abs. mission time from <code>timer.getAbsTime()</code> is checked. Default is relative mission time from <code>timer.getTime()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p>#boolean:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Returns <code>true</code> if time is greater than give the time.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -2697,6 +2837,66 @@ myCondition:AddFunction(isAequalB, a, b)
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(CONDITION).ReturnFalse" ><strong>CONDITION.ReturnFalse()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Function that returns always <code>false</code></p>
|
||||
|
||||
<div id= "#Functions##ReturnFalse" 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>#boolean:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Returns <code>false</code> unconditionally.</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).ReturnTrue" ><strong>CONDITION.ReturnTrue()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Function that returns always <code>true</code></p>
|
||||
|
||||
<div id= "#Functions##ReturnTrue" 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>#boolean:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Returns <code>true</code> unconditionally.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -3004,6 +3204,17 @@ myCondition:AddFunction(isAequalB, a, b)
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(CONDITION).name" ><strong>CONDITION.name</strong></a>
|
||||
|
||||
<p>Name of the condition.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
Reference in New Issue
Block a user