weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2025-08-15 10:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2023-01-01 11:47:11 +00:00
parent 7736ad152f
commit 9c9d9595c0
28 changed files with 1043 additions and 734 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
Documentation/Core.Timer.html
View File

@@ -1758,7 +1758,13 @@ mytimer:Start(1.0, nil, 10) -- Does not make sense as the function is only calle
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TIMER).Start">TIMER:Start(Tstart, dT, Duration)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Create a new TIMER object.</p>
<p>Start TIMER object.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TIMER).StartIf">TIMER:StartIf(Condition, Tstart, dT, Duration)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Start TIMER object if a condition is met.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2731,7 +2737,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(TIMER).Start" ><strong>TIMER:Start(Tstart, dT, Duration)</strong></a></h2>
</div>
<p>Create a new TIMER object.</p>
<p>Start TIMER object.</p>
<div id= "#Functions##Start" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -2792,6 +2798,92 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(TIMER).StartIf" ><strong>TIMER:StartIf(Condition, Tstart, dT, Duration)</strong></a></h2>
</div>
<p>Start TIMER object if a condition is met.</p>
<p>Useful for e.g. debugging.</p>
<div id= "#Functions##StartIf" 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>TIMER</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>
#boolean
<strong><strong>Condition</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Must be true for the TIMER to start</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Tstart</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Relative start time in seconds.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>dT</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Interval between function calls in seconds. If not specified <code>nil</code>, the function is called only once.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Time in seconds for how long the timer is running. If not specified <code>nil</code>, the timer runs forever or until stopped manually by the <code>TIMER:Stop()</code> function.</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="##(TIMER)">#TIMER</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>