Fixes accounting of destroy and updated documentation

Destroy events were not correctly accounted for in the new tasking
system. this is now fixed.
This commit is contained in:
FlightControl
2017-03-19 15:02:49 +01:00
parent bf489f6679
commit 4dde14eba6
54 changed files with 1149 additions and 1013 deletions

View File

@@ -78,7 +78,7 @@
<hr/>
<h1>1) <a href="DetectionManager.html##(DETECTION_MANAGER)">DetectionManager#DETECTION_MANAGER</a> class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
<h1>1) <a href="DetectionManager.html##(DETECTION_MANAGER)">DetectionManager#DETECTION_MANAGER</a> class, extends <a href="Fsm.html##(FSM)">Fsm#FSM</a></h1>
<p>The <a href="DetectionManager.html##(DETECTION_MANAGER)">DetectionManager#DETECTION_MANAGER</a> class defines the core functions to report detected objects to groups.
Reportings can be done in several manners, and it is up to the derived classes if DETECTION_MANAGER to model the reporting behaviour.</p>
@@ -139,12 +139,6 @@ If an ad-hoc report is requested, use the method <a href="DetectionManager.html#
<td class="name" nowrap="nowrap"><a href="##(DETECTION_MANAGER).Detection">DETECTION_MANAGER.Detection</a></td>
<td class="summary">
<p>The DETECTION_BASE object that is used to report the detected objects.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_MANAGER).FacScheduler">DETECTION_MANAGER.FacScheduler</a></td>
<td class="summary">
</td>
</tr>
<tr>
@@ -160,15 +154,9 @@ If an ad-hoc report is requested, use the method <a href="DetectionManager.html#
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_MANAGER).ReportDetected">DETECTION_MANAGER:ReportDetected(Detection)</a></td>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_MANAGER).ProcessDetected">DETECTION_MANAGER:ProcessDetected(Detection)</a></td>
<td class="summary">
<p>Reports the detected items to the <a href="Set.html##(SET_GROUP)">Set#SET_GROUP</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_MANAGER).Schedule">DETECTION_MANAGER:Schedule(DelayTime, ReportInterval)</a></td>
<td class="summary">
<p>Schedule the FAC reporting.</p>
</td>
</tr>
<tr>
@@ -187,12 +175,6 @@ If an ad-hoc report is requested, use the method <a href="DetectionManager.html#
<td class="name" nowrap="nowrap"><a href="##(DETECTION_MANAGER).SetReportInterval">DETECTION_MANAGER:SetReportInterval(ReportInterval)</a></td>
<td class="summary">
<p>Set the reporting time interval.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_MANAGER)._FacScheduler">DETECTION_MANAGER:_FacScheduler(SchedulerName)</a></td>
<td class="summary">
<p>Report the detected <a href="Unit.html##(UNIT)">Unit#UNIT</a>s detected within the <a href="Detection.html##(DETECTION_BASE)">Detection#DETECTION_BASE</a> object to the <a href="Set.html##(SET_GROUP)">Set#SET_GROUP</a>s.</p>
</td>
</tr>
<tr>
@@ -208,7 +190,13 @@ If an ad-hoc report is requested, use the method <a href="DetectionManager.html#
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_MANAGER)._ScheduleDelayTime">DETECTION_MANAGER._ScheduleDelayTime</a></td>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_MANAGER).onafterReport">DETECTION_MANAGER:onafterReport(From, Event, To)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_MANAGER).onafterStart">DETECTION_MANAGER:onafterStart(From, Event, To)</a></td>
<td class="summary">
</td>
@@ -317,20 +305,6 @@ If an ad-hoc report is requested, use the method <a href="DetectionManager.html#
<p>The DETECTION_BASE object that is used to report the detected objects.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(DETECTION_MANAGER).FacScheduler" >
<strong>DETECTION_MANAGER.FacScheduler</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
@@ -385,8 +359,8 @@ self</p>
<dl class="function">
<dt>
<a id="#(DETECTION_MANAGER).ReportDetected" >
<strong>DETECTION_MANAGER:ReportDetected(Detection)</strong>
<a id="#(DETECTION_MANAGER).ProcessDetected" >
<strong>DETECTION_MANAGER:ProcessDetected(Detection)</strong>
</a>
</dt>
<dd>
@@ -406,39 +380,6 @@ self</p>
<p><em><a href="##(DETECTION_MANAGER)">#DETECTION_MANAGER</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DETECTION_MANAGER).Schedule" >
<strong>DETECTION_MANAGER:Schedule(DelayTime, ReportInterval)</strong>
</a>
</dt>
<dd>
<p>Schedule the FAC reporting.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#number DelayTime </em></code>:
The delay in seconds to wait the reporting.</p>
</li>
<li>
<p><code><em>#number ReportInterval </em></code>:
The repeat interval in seconds for the reporting to happen repeatedly.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(DETECTION_MANAGER)">#DETECTION_MANAGER</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
@@ -507,27 +448,6 @@ The interval in seconds when a report needs to be done.</p>
<p><em><a href="##(DETECTION_MANAGER)">#DETECTION_MANAGER</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DETECTION_MANAGER)._FacScheduler" >
<strong>DETECTION_MANAGER:_FacScheduler(SchedulerName)</strong>
</a>
</dt>
<dd>
<p>Report the detected <a href="Unit.html##(UNIT)">Unit#UNIT</a>s detected within the <a href="Detection.html##(DETECTION_BASE)">Detection#DETECTION_BASE</a> object to the <a href="Set.html##(SET_GROUP)">Set#SET_GROUP</a>s.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> SchedulerName </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
@@ -561,15 +481,63 @@ self</p>
<dl class="function">
<dt>
<em></em>
<a id="#(DETECTION_MANAGER)._ScheduleDelayTime" >
<strong>DETECTION_MANAGER._ScheduleDelayTime</strong>
<a id="#(DETECTION_MANAGER).onafterReport" >
<strong>DETECTION_MANAGER:onafterReport(From, Event, To)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> From </em></code>: </p>
</li>
<li>
<p><code><em> Event </em></code>: </p>
</li>
<li>
<p><code><em> To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DETECTION_MANAGER).onafterStart" >
<strong>DETECTION_MANAGER:onafterStart(From, Event, To)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> From </em></code>: </p>
</li>
<li>
<p><code><em> Event </em></code>: </p>
</li>
<li>
<p><code><em> To </em></code>: </p>
</li>
</ul>
</dd>
</dl>