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:
@@ -1516,13 +1516,13 @@ The SCHEDULEDISPATCHER class ensures that:</p>
|
||||
<li>When a SCHEDULER object <em>is</em> attached to another object, then the SCHEDULER object is <em>not persistent</em> within memory after a garbage collection!</li>
|
||||
</ul>
|
||||
|
||||
<p>The none persistency of SCHEDULERS attached to objects is required to allow SCHEDULER objects to be garbage collectged, when the parent object is also desroyed or nillified and garbage collected.
|
||||
Even when there are pending timer scheduled functions to be executed for the SCHEDULER object, <br/>
|
||||
<p>The non-persistency of SCHEDULERS attached to objects is required to allow SCHEDULER objects to be garbage collected when the parent object is destroyed, or set to nil and garbage collected.
|
||||
Even when there are pending timer scheduled functions to be executed for the SCHEDULER object,
|
||||
these will not be executed anymore when the SCHEDULER object has been destroyed.</p>
|
||||
|
||||
<p>The SCHEDULEDISPATCHER allows multiple scheduled functions to be planned and executed for one SCHEDULER object.
|
||||
The SCHEDULER object therefore keeps a table of "CallID's", which are returned after each planning of a new scheduled function by the SCHEDULEDISPATCHER.
|
||||
The SCHEDULER object plans new scheduled functions through the <a href="Core.Scheduler.html##(SCHEDULER).Schedule">Core.Scheduler#SCHEDULER.Schedule</a>() method.
|
||||
The SCHEDULER object plans new scheduled functions through the <a href="Core.Scheduler.html##(SCHEDULER).Schedule">Core.Scheduler#SCHEDULER.Schedule</a>() method.
|
||||
The Schedule() method returns the CallID that is the reference ID for each planned schedule.</p>
|
||||
|
||||
<hr/>
|
||||
@@ -1611,7 +1611,7 @@ The Schedule() method returns the CallID that is the reference ID for each plann
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCHEDULEDISPATCHER).PersistentSchedulers">SCHEDULEDISPATCHER.PersistentSchedulers</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Persistant schedulers.</p>
|
||||
<p>Persistent schedulers.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1629,7 +1629,7 @@ The Schedule() method returns the CallID that is the reference ID for each plann
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SCHEDULEDISPATCHER).ShowTrace">SCHEDULEDISPATCHER:ShowTrace(Scheduler)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Shopw tracing info.</p>
|
||||
<p>Show tracing info.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2212,7 +2212,7 @@ 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="##(SCHEDULEDISPATCHER.ScheduleData).Repeat">SCHEDULEDISPATCHER.ScheduleData.Repeat</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Repeat time intervall in seconds.</p>
|
||||
<p>Repeat time interval in seconds.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2302,7 +2302,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
#table
|
||||
<a id="#(SCHEDULEDISPATCHER).PersistentSchedulers" ><strong>SCHEDULEDISPATCHER.PersistentSchedulers</strong></a>
|
||||
|
||||
<p>Persistant schedulers.</p>
|
||||
<p>Persistent schedulers.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -2331,7 +2331,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
|
||||
<p>The development of this method was really tidy.
|
||||
It is constructed as such that a garbage collection is executed on the weak tables, when the Scheduler is nillified.
|
||||
It is constructed as such that a garbage collection is executed on the weak tables, when the Scheduler is set to nil.
|
||||
Nothing of this code should be modified without testing it thoroughly.</p>
|
||||
|
||||
<div id= "#Functions##AddSchedule" class="w3-show w3-white">
|
||||
@@ -2415,7 +2415,7 @@ Nothing of this code should be modified without testing it thoroughly.</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Radomization factor [0,1].</p>
|
||||
<p>Randomization factor [0,1].</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -2622,7 +2622,7 @@ Nothing of this code should be modified without testing it thoroughly.</p>
|
||||
<h2><a id="#(SCHEDULEDISPATCHER).ShowTrace" ><strong>SCHEDULEDISPATCHER:ShowTrace(Scheduler)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Shopw tracing info.</p>
|
||||
<p>Show tracing info.</p>
|
||||
|
||||
<div id= "#Functions##ShowTrace" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -2796,7 +2796,7 @@ Nothing of this code should be modified without testing it thoroughly.</p>
|
||||
#table
|
||||
<a id="#(SCHEDULEDISPATCHER).PersistentSchedulers" ><strong>SCHEDULEDISPATCHER.PersistentSchedulers</strong></a>
|
||||
|
||||
<p>Persistant schedulers.</p>
|
||||
<p>Persistent schedulers.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -6108,7 +6108,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
|
||||
#number
|
||||
<a id="#(SCHEDULEDISPATCHER.ScheduleData).Repeat" ><strong>SCHEDULEDISPATCHER.ScheduleData.Repeat</strong></a>
|
||||
|
||||
<p>Repeat time intervall in seconds.</p>
|
||||
<p>Repeat time interval in seconds.</p>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user