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:
FlightControl-User
@@ -670,7 +670,7 @@
|
||||
<div class="w3-col s12 m6 l4">
|
||||
<div class="w3-card-4 w3-white w3-margin-16">
|
||||
<div class="w3-display-container w3-text-white w3-text-shadow">
|
||||
<img src= "../Images/CORE_Timer.png" alt="Image">
|
||||
<img src= "../Images/Core_Scheduler.JPG" alt="Image">
|
||||
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Timer.html">Core.Timer</a></strong></h2></div>
|
||||
</div>
|
||||
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
||||
@@ -1360,7 +1360,7 @@ Controls a network of SAM sites.</p>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<img src="..\Images\CORE_Timer.png" alt="Banner Image"/>
|
||||
<img src="..\Images\Core_Scheduler.JPG" alt="Banner Image"/>
|
||||
<div id="content">
|
||||
<div class="w3-container w3-theme-d5" id="module_title">
|
||||
<h1>Module <strong>Core.Timer</strong></h1>
|
||||
@@ -1391,7 +1391,7 @@ Controls a network of SAM sites.</p>
|
||||
<tr>
|
||||
<td class="style="width:40%;"><p><h2>Global <strong>TIMER</strong></h2></p></td>
|
||||
<td class="style="width:60%;">
|
||||
<p><em>Better three hours too soon than a minute too late.</em> – William Shakespeare</p>
|
||||
<p><em>Better three hours too soon than a minute too late.</em> - William Shakespeare</p>
|
||||
|
||||
<hr/>
|
||||
|
||||
@@ -1399,7 +1399,7 @@ Controls a network of SAM sites.</p>
|
||||
|
||||
<h1>The TIMER Concept</h1>
|
||||
|
||||
<p>The TIMER class is the little sister of the SCHEDULER class.</p>
|
||||
<p>The TIMER class is the little sister of the <a href="Core.Scheduler.html##(SCHEDULER)">Core.Scheduler#SCHEDULER</a> class.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -1410,7 +1410,7 @@ Controls a network of SAM sites.</p>
|
||||
<a href="##(TIMER)">#TIMER</a>
|
||||
<a id="TIMER" ><strong>TIMER</strong></a>
|
||||
|
||||
<p><em>Better three hours too soon than a minute too late.</em> – William Shakespeare</p>
|
||||
<p><em>Better three hours too soon than a minute too late.</em> - William Shakespeare</p>
|
||||
|
||||
<hr/>
|
||||
|
||||
@@ -1418,7 +1418,7 @@ Controls a network of SAM sites.</p>
|
||||
|
||||
<h1>The TIMER Concept</h1>
|
||||
|
||||
<p>The TIMER class is the little sister of the SCHEDULER class.</p>
|
||||
<p>The TIMER class is the little sister of the <a href="Core.Scheduler.html##(SCHEDULER)">Core.Scheduler#SCHEDULER</a> class.</p>
|
||||
|
||||
|
||||
<p>It does the same thing but is a bit easier to use and has less overhead. It should be sufficient in many cases.</p>
|
||||
@@ -1452,7 +1452,7 @@ Controls a network of SAM sites.</p>
|
||||
<p>Note that</p>
|
||||
|
||||
<ul>
|
||||
<li>if <em>Tstart</em> is not specified (<em>nil</em>), the first function call happens immediately.</li>
|
||||
<li>if <em>Tstart</em> is not specified (<em>nil</em>), the first function call happens immediately, i.e. after one millisecond.</li>
|
||||
<li>if <em>dT</em> is not specified (<em>nil</em>), the function is called only once.</li>
|
||||
<li>if <em>Duration</em> is not specified (<em>nil</em>), the timer runs forever or until stopped manually or until the max function calls are reached (see below).</li>
|
||||
</ul>
|
||||
@@ -1460,14 +1460,14 @@ Controls a network of SAM sites.</p>
|
||||
<p>For example,</p>
|
||||
|
||||
<pre><code>mytimer:Start(3) -- Will call the function once after 3 seconds.
|
||||
mytimer:Start(nil, 0.5) -- Will call right now and then every 0.5 sec until all eternaty.
|
||||
mytimer:Start(nil, 0.5) -- Will call right now and then every 0.5 sec until all eternity.
|
||||
mytimer:Start(nil, 2.0, 20) -- Will call right now and then every 2.0 sec for 20 sec.
|
||||
mytimer:Start(1.0, nil, 10) -- Does not make sense as the function is only called once anyway.
|
||||
</code></pre>
|
||||
|
||||
<h2>Stopping the Timer</h2>
|
||||
|
||||
<p>The timer can be stopped manually by the <a href="##(TIMER).Start">TIMER.Start</a>(<em>Delay</em>) function</p>
|
||||
<p>The timer can be stopped manually by the <a href="##(TIMER).Stop">TIMER.Stop</a>(<em>Delay</em>) function</p>
|
||||
|
||||
<pre><code>mytimer:Stop()
|
||||
</code></pre>
|
||||
@@ -1532,6 +1532,12 @@ mytimer:Start(1.0, nil, 10) -- Does not make sense as the function is only calle
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TIMER).ClassName">TIMER.ClassName</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Name of the class.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TIMER).IsRunning">TIMER:IsRunning()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Check if the timer has been started and was not stopped.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1586,6 +1592,12 @@ mytimer:Start(1.0, nil, 10) -- Does not make sense as the function is only calle
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TIMER).func">TIMER.func</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Timer function.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(TIMER).isrunning">TIMER.isrunning</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>If <code>true</code>, timer is running. Else it was not started yet or was stopped.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1621,7 +1633,7 @@ 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).uid">TIMER.uid</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Unique ID of the timer.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2189,6 +2201,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">
|
||||
|
||||
#boolean
|
||||
<a id="#(TIMER).isrunning" ><strong>TIMER.isrunning</strong></a>
|
||||
|
||||
<p>If <code>true</code>, timer is running. Else it was not started yet or was stopped.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
@@ -2248,13 +2271,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
#number
|
||||
<a id="#(TIMER).uid" ><strong>TIMER.uid</strong></a>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Set UID.</p>
|
||||
<p>Unique ID of the timer.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -2275,6 +2295,36 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(TIMER).IsRunning" ><strong>TIMER:IsRunning()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Check if the timer has been started and was not stopped.</p>
|
||||
|
||||
<div id= "#Functions##IsRunning" 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>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>If <code>true</code>, the timer is running.</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="#(TIMER).New" ><strong>TIMER:New(Function, ...)</strong></a></h2>
|
||||
</div>
|
||||
@@ -2591,6 +2641,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">
|
||||
|
||||
#boolean
|
||||
<a id="#(TIMER).isrunning" ><strong>TIMER.isrunning</strong></a>
|
||||
|
||||
<p>If <code>true</code>, timer is running. Else it was not started yet or was stopped.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
@@ -2650,13 +2711,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
#number
|
||||
<a id="#(TIMER).uid" ><strong>TIMER.uid</strong></a>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Set UID.</p>
|
||||
<p>Unique ID of the timer.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -5673,7 +5731,7 @@ BASE:TraceOnOff( false )</code></pre>
|
||||
</div>
|
||||
<script>
|
||||
function myLoadFunction() {
|
||||
document.getElementById("myHeader").style.backgroundImage = "url('../Images/CORE_Timer.png')";
|
||||
document.getElementById("myHeader").style.backgroundImage = "url('../Images/Core_Scheduler.JPG')";
|
||||
}
|
||||
</script>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user