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
2021-12-20 12:06:00 +00:00
parent 1e732ea232
commit be8c95fcfd
69 changed files with 2023 additions and 1676 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
Documentation/Core.Scheduler.html
View File

@@ -1501,10 +1501,10 @@ Controls a network of short range air/missile defense groups.</p>
<ul>
<li>Schedule functions over time,</li>
<li>optionally in an optional specified time interval, </li>
<li>optionally <strong>repeating</strong> with a specified time repeat interval, </li>
<li>optionally <strong>randomizing</strong> with a specified time interval randomization factor, </li>
<li>optionally <strong>stop</strong> the repeating after a specified time interval. </li>
<li>optionally in an optional specified time interval,</li>
<li>optionally <strong>repeating</strong> with a specified time repeat interval,</li>
<li>optionally <strong>randomizing</strong> with a specified time interval randomization factor,</li>
<li>optionally <strong>stop</strong> the repeating after a specified time interval.</li>
</ul>
<hr/>
@@ -1595,7 +1595,7 @@ A separate schedule is created by using the MasterObject using the method :Sched
<h3>Construct a SCHEDULER object without a volatile schedule, but volatile to the Object existence...</h3>
<ul>
<li><p><a href="##(SCHEDULER).New">SCHEDULER.New</a>( Object ): Setup a new SCHEDULER object, which is linked to the Object. When the Object is nillified or destroyed, the SCHEDULER object will also be destroyed and stopped after garbage collection.</p>
<li><p><a href="##(SCHEDULER).New">SCHEDULER.New</a>( Object ): Setup a new SCHEDULER object, which is linked to the Object. When the Object is set to nil or destroyed, the SCHEDULER object will also be destroyed and stopped after garbage collection.</p>
<p>ZoneObject = ZONE:New( "ZoneName" )
MasterObject = SCHEDULER:New( ZoneObject )
@@ -1658,13 +1658,13 @@ As a result, the MasterObject will cancel the planned schedule.</p>
</ul>
<p>The above example creates a new MasterObject, and does schedule the first schedule as part of the call.
Note that 2 variables are returned here: MasterObject, ScheduleID... <br/>
Later in the logic, the repeating schedule with SchedulerID is stopped. <br/>
A bit later, the repeating schedule with SchedulerId is (re)-started. </p>
Note that 2 variables are returned here: MasterObject, ScheduleID...
Later in the logic, the repeating schedule with SchedulerID is stopped.
A bit later, the repeating schedule with SchedulerId is (re)-started.</p>
<h2>Create a new schedule</h2>
<p>With the method <a href="##(SCHEDULER).Schedule">SCHEDULER.Schedule</a>() a new time event can be scheduled.
<p>With the method <a href="##(SCHEDULER).Schedule">SCHEDULER.Schedule</a>() a new time event can be scheduled.
This method is used by the :New() constructor when a new schedule is planned.</p>
<p>Consider the following code fragment of the SCHEDULER object creation.</p>
@@ -1673,14 +1673,14 @@ This method is used by the :New() constructor when a new schedule is planned.</p
MasterObject = SCHEDULER:New( ZoneObject )
</code></pre>
<p>Several parameters can be specified that influence the behaviour of a Schedule.</p>
<p>Several parameters can be specified that influence the behavior of a Schedule.</p>
<h3>A single schedule, immediately executed</h3>
<pre><code>SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {} )
</code></pre>
<p>The above example schedules a new ScheduleFunction call to be executed asynchronously, within milleseconds ...</p>
<p>The above example schedules a new ScheduleFunction call to be executed asynchronously, within milliseconds ...</p>
<h3>A single schedule, planned over time</h3>
@@ -1694,7 +1694,7 @@ MasterObject = SCHEDULER:New( ZoneObject )
<pre><code>SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60 )
</code></pre>
<p>The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds,
<p>The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds,
and repeating 60 every seconds ...</p>
<h3>A schedule with a repeating time interval, planned over time, with time interval randomization</h3>
@@ -1702,10 +1702,10 @@ and repeating 60 every seconds ...</p>
<pre><code>SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60, 0.5 )
</code></pre>
<p>The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds,
<p>The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds,
and repeating 60 seconds, with a 50% time interval randomization ...
So the repeating time interval will be randomized using the <strong>0.5</strong>, <br/>
and will calculate between <strong>60 - ( 60 * 0.5 )</strong> and <strong>60 + ( 60 * 0.5 )</strong> for each repeat,
So the repeating time interval will be randomized using the <strong>0.5</strong>,
and will calculate between <strong>60 - ( 60 * 0.5 )</strong> and <strong>60 + ( 60 * 0.5 )</strong> for each repeat,
which is in this example between <strong>30</strong> and <strong>90</strong> seconds.</p>
<h3>A schedule with a repeating time interval, planned over time, with time interval randomization, and stop after a time interval</h3>
@@ -1713,10 +1713,10 @@ which is in this example between <strong>30</strong> and <strong>90</strong> sec
<pre><code>SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60, 0.5, 300 )
</code></pre>
<p>The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds,
<p>The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds,
The schedule will repeat every 60 seconds.
So the repeating time interval will be randomized using the <strong>0.5</strong>, <br/>
and will calculate between <strong>60 - ( 60 * 0.5 )</strong> and <strong>60 + ( 60 * 0.5 )</strong> for each repeat,
So the repeating time interval will be randomized using the <strong>0.5</strong>,
and will calculate between <strong>60 - ( 60 * 0.5 )</strong> and <strong>60 + ( 60 * 0.5 )</strong> for each repeat,
which is in this example between <strong>30</strong> and <strong>90</strong> seconds.
The schedule will stop after <strong>300</strong> seconds.</p>
@@ -2684,7 +2684,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-half">
<p>Time interval in seconds after which the scheduler will be stoppe.</p>
<p>Time interval in seconds after which the scheduler will be stopped.</p>
</div>
</div>