FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity
MOOSE/Moose Training/Documentation/Fac.html
FlightControl c581fe1551 Implemented DETECTION and FAC first classes
2016-06-25 08:53:19 +02:00

692 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<link rel="stylesheet" href="stylesheet.css" type="text/css"/>
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div>
<div id="main">
<div id="navigation">
<h2>Modules</h2>
<ul><li>
<a href="index.html">index</a>
</li></ul>
<ul>
<li><a href="AIBalancer.html">AIBalancer</a></li>
<li><a href="Airbase.html">Airbase</a></li>
<li><a href="AirbasePolice.html">AirbasePolice</a></li>
<li><a href="Base.html">Base</a></li>
<li><a href="CARGO.html">CARGO</a></li>
<li><a href="CleanUp.html">CleanUp</a></li>
<li><a href="Client.html">Client</a></li>
<li><a href="Controllable.html">Controllable</a></li>
<li><a href="DCSAirbase.html">DCSAirbase</a></li>
<li><a href="DCSCoalitionObject.html">DCSCoalitionObject</a></li>
<li><a href="DCSCommand.html">DCSCommand</a></li>
<li><a href="DCSController.html">DCSController</a></li>
<li><a href="DCSGroup.html">DCSGroup</a></li>
<li><a href="DCSObject.html">DCSObject</a></li>
<li><a href="DCSTask.html">DCSTask</a></li>
<li><a href="DCSTypes.html">DCSTypes</a></li>
<li><a href="DCSUnit.html">DCSUnit</a></li>
<li><a href="DCSWorld.html">DCSWorld</a></li>
<li><a href="DCStimer.html">DCStimer</a></li>
<li><a href="DEPLOYTASK.html">DEPLOYTASK</a></li>
<li><a href="DESTROYBASETASK.html">DESTROYBASETASK</a></li>
<li><a href="DESTROYGROUPSTASK.html">DESTROYGROUPSTASK</a></li>
<li><a href="DESTROYRADARSTASK.html">DESTROYRADARSTASK</a></li>
<li><a href="DESTROYUNITTYPESTASK.html">DESTROYUNITTYPESTASK</a></li>
<li><a href="Database.html">Database</a></li>
<li><a href="Detection.html">Detection</a></li>
<li><a href="Escort.html">Escort</a></li>
<li><a href="Event.html">Event</a></li>
<li>Fac</li>
<li><a href="GOHOMETASK.html">GOHOMETASK</a></li>
<li><a href="Group.html">Group</a></li>
<li><a href="Identifiable.html">Identifiable</a></li>
<li><a href="MOVEMENT.html">MOVEMENT</a></li>
<li><a href="Menu.html">Menu</a></li>
<li><a href="Message.html">Message</a></li>
<li><a href="MissileTrainer.html">MissileTrainer</a></li>
<li><a href="Mission.html">Mission</a></li>
<li><a href="NOTASK.html">NOTASK</a></li>
<li><a href="Object.html">Object</a></li>
<li><a href="PICKUPTASK.html">PICKUPTASK</a></li>
<li><a href="PatrolZone.html">PatrolZone</a></li>
<li><a href="Point.html">Point</a></li>
<li><a href="Positionable.html">Positionable</a></li>
<li><a href="ROUTETASK.html">ROUTETASK</a></li>
<li><a href="STAGE.html">STAGE</a></li>
<li><a href="Scheduler.html">Scheduler</a></li>
<li><a href="Scoring.html">Scoring</a></li>
<li><a href="Sead.html">Sead</a></li>
<li><a href="Set.html">Set</a></li>
<li><a href="Spawn.html">Spawn</a></li>
<li><a href="Static.html">Static</a></li>
<li><a href="StaticObject.html">StaticObject</a></li>
<li><a href="TASK.html">TASK</a></li>
<li><a href="Unit.html">Unit</a></li>
<li><a href="Zone.html">Zone</a></li>
<li><a href="env.html">env</a></li>
<li><a href="land.html">land</a></li>
<li><a href="routines.html">routines</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>Fac</code></h1>
<p>This module contains the FAC classes.</p>
<hr/>
<h1>1) <a href="Fac.html##(FAC_BASE)">Fac#FAC_BASE</a> class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
<p>The <a href="Fac.html##(FAC_BASE)">Fac#FAC_BASE</a> class defines the core functions to report detected objects to clients.
Reportings can be done in several manners, and it is up to the derived classes if FAC_BASE to model the reporting behaviour.</p>
<h2>1.1) FAC_BASE constructor:</h2>
<p> * <a href="Fac.html##(FAC_BASE).New">Fac#FAC_BASE.New</a>(): Create a new FAC_BASE instance.</p>
<h2>1.2) FAC_BASE reporting:</h2>
<p>Derived FAC_BASE classes will reports detected units using the method <a href="Fac.html##(FAC_BASE).ReportDetected">Fac#FAC_BASE.ReportDetected</a>(). This method implements polymorphic behaviour.</p>
<p>The time interval in seconds of the reporting can be changed using the methods <a href="Fac.html##(FAC_BASE).SetReportInterval">Fac#FAC_BASE.SetReportInterval</a>().
To control how long a reporting message is displayed, use <a href="Fac.html##(FAC_BASE).SetReportDisplayTime">Fac#FAC_BASE.SetReportDisplayTime</a>().
Derived classes need to implement the method <a href="Fac.html##(FAC_BASE).GetReportDisplayTime">Fac#FAC_BASE.GetReportDisplayTime</a>() to use the correct display time for displayed messages during a report.</p>
<p>Reporting can be started and stopped using the methods <a href="Fac.html##(FAC_BASE).StartReporting">Fac#FAC_BASE.StartReporting</a>() and <a href="Fac.html##(FAC_BASE).StopReporting">Fac#FAC_BASE.StopReporting</a>() respectively.
If an ad-hoc report is requested, use the method <a href="Fac.html##(FAC_BASE)">Fac#FAC_BASE</a>().</p>
<p>The default reporting interval is every 60 seconds. The reporting messages are displayed 15 seconds.</p>
<hr/>
<h1>2) <a href="Fac.html##(FAC_REPORTING)">Fac#FAC_REPORTING</a> class, extends <a href="Fac.html##(FAC_BASE)">Fac#FAC_BASE</a></h1>
<p>The <a href="Fac.html##(FAC_REPORTING)">Fac#FAC_REPORTING</a> class implements detected units reporting. Reporting can be controlled using the reporting methods available in the <a href="Fac.html##(FAC_BASE)">Fac#FAC_BASE</a> class.</p>
<h2>2.1) FAC_REPORTING constructor:</h2>
<p>The <a href="Fac.html##(FAC_REPORTING).New">Fac#FAC_REPORTING.New</a>() method creates a new FAC_REPORTING instance.</p>
<hr/>
<h2>Global(s)</h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="#FAC_BASE">FAC_BASE</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="#FAC_REPORTING">FAC_REPORTING</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(FAC_BASE)">Type <code>FAC_BASE</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_BASE).ClassName">FAC_BASE.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_BASE).ClientSet">FAC_BASE.ClientSet</a></td>
<td class="summary">
<p>The clients to which the FAC will report to.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_BASE).Detection">FAC_BASE.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="##(FAC_BASE).FacScheduler">FAC_BASE.FacScheduler</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_BASE).GetReportDisplayTime">FAC_BASE:GetReportDisplayTime()</a></td>
<td class="summary">
<p>Get the reporting message display time.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_BASE).New">FAC_BASE:New(ClientSet, Detection)</a></td>
<td class="summary">
<p>FAC constructor.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_BASE).ReportDetected">FAC_BASE:ReportDetected(DetectedSets)</a></td>
<td class="summary">
<p>Reports the detected items to the <a href="Set.html##(SET_CLIENT)">Set#SET_CLIENT</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_BASE).Schedule">FAC_BASE:Schedule(DelayTime, ReportInterval)</a></td>
<td class="summary">
<p>Schedule the FAC reporting.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_BASE).SetReportDisplayTime">FAC_BASE:SetReportDisplayTime(ReportDisplayTime)</a></td>
<td class="summary">
<p>Set the reporting message display time.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_BASE).SetReportInterval">FAC_BASE:SetReportInterval(ReportInterval)</a></td>
<td class="summary">
<p>Set the reporting time interval.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_BASE)._FacScheduler">FAC_BASE:_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_CLIENT)">Set#SET_CLIENT</a>s.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_BASE)._ReportDisplayTime">FAC_BASE._ReportDisplayTime</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_BASE)._ReportInterval">FAC_BASE._ReportInterval</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_BASE)._ScheduleDelayTime">FAC_BASE._ScheduleDelayTime</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(FAC_REPORTING)">Type <code>FAC_REPORTING</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_REPORTING).ClassName">FAC_REPORTING.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_REPORTING).ClientSet">FAC_REPORTING.ClientSet</a></td>
<td class="summary">
<p>The clients to which the FAC will report to.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_REPORTING).Detection">FAC_REPORTING.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="##(FAC_REPORTING).New">FAC_REPORTING:New(ClientSet, Detection)</a></td>
<td class="summary">
<p>FAC_REPORTING constructor.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(FAC_REPORTING).ReportDetected">FAC_REPORTING:ReportDetected(Client, DetectedSets)</a></td>
<td class="summary">
<p>Reports the detected items to the <a href="Set.html##(SET_CLIENT)">Set#SET_CLIENT</a>.</p>
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(FAC_BASE)">#FAC_BASE</a></em>
<a id="FAC_BASE" >
<strong>FAC_BASE</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="##(FAC_REPORTING)">#FAC_REPORTING</a></em>
<a id="FAC_REPORTING" >
<strong>FAC_REPORTING</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(Fac)" >Type <code>Fac</code></a></h2>
<h2><a id="#(FAC_BASE)" >Type <code>FAC_BASE</code></a></h2>
<p>FAC_BASE class.</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(FAC_BASE).ClassName" >
<strong>FAC_BASE.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Set.html##(SET_CLIENT)">Set#SET_CLIENT</a></em>
<a id="#(FAC_BASE).ClientSet" >
<strong>FAC_BASE.ClientSet</strong>
</a>
</dt>
<dd>
<p>The clients to which the FAC will report to.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Detection.html##(DETECTION_BASE)">Detection#DETECTION_BASE</a></em>
<a id="#(FAC_BASE).Detection" >
<strong>FAC_BASE.Detection</strong>
</a>
</dt>
<dd>
<p>The DETECTION_BASE object that is used to report the detected objects.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(FAC_BASE).FacScheduler" >
<strong>FAC_BASE.FacScheduler</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(FAC_BASE).GetReportDisplayTime" >
<strong>FAC_BASE:GetReportDisplayTime()</strong>
</a>
</dt>
<dd>
<p>Get the reporting message display time.</p>
<h3>Return value</h3>
<p><em>#number:</em>
ReportDisplayTime The display time in seconds when a report needs to be done.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(FAC_BASE).New" >
<strong>FAC_BASE:New(ClientSet, Detection)</strong>
</a>
</dt>
<dd>
<p>FAC constructor.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Set.html##(SET_CLIENT)">Set#SET_CLIENT</a> ClientSet </em></code>: </p>
</li>
<li>
<p><code><em><a href="Detection.html##(DETECTION_BASE)">Detection#DETECTION_BASE</a> Detection </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(FAC_BASE)">#FAC_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(FAC_BASE).ReportDetected" >
<strong>FAC_BASE:ReportDetected(DetectedSets)</strong>
</a>
</dt>
<dd>
<p>Reports the detected items to the <a href="Set.html##(SET_CLIENT)">Set#SET_CLIENT</a>.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Set.html##(SET_BASE)">Set#SET_BASE</a> DetectedSets </em></code>:
The detected Sets created by the <a href="Detection.html##(DETECTION_BASE)">Detection#DETECTION_BASE</a> object.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(FAC_BASE)">#FAC_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(FAC_BASE).Schedule" >
<strong>FAC_BASE: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="##(FAC_BASE)">#FAC_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(FAC_BASE).SetReportDisplayTime" >
<strong>FAC_BASE:SetReportDisplayTime(ReportDisplayTime)</strong>
</a>
</dt>
<dd>
<p>Set the reporting message display time.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number ReportDisplayTime </em></code>:
The display time in seconds when a report needs to be done.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(FAC_BASE)">#FAC_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(FAC_BASE).SetReportInterval" >
<strong>FAC_BASE:SetReportInterval(ReportInterval)</strong>
</a>
</dt>
<dd>
<p>Set the reporting time interval.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number ReportInterval </em></code>:
The interval in seconds when a report needs to be done.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(FAC_BASE)">#FAC_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(FAC_BASE)._FacScheduler" >
<strong>FAC_BASE:_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_CLIENT)">Set#SET_CLIENT</a>s.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> SchedulerName </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(FAC_BASE)._ReportDisplayTime" >
<strong>FAC_BASE._ReportDisplayTime</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(FAC_BASE)._ReportInterval" >
<strong>FAC_BASE._ReportInterval</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(FAC_BASE)._ScheduleDelayTime" >
<strong>FAC_BASE._ScheduleDelayTime</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(FAC_REPORTING)" >Type <code>FAC_REPORTING</code></a></h2>
<p>FAC_REPORTING class.</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(FAC_REPORTING).ClassName" >
<strong>FAC_REPORTING.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Set.html##(SET_CLIENT)">Set#SET_CLIENT</a></em>
<a id="#(FAC_REPORTING).ClientSet" >
<strong>FAC_REPORTING.ClientSet</strong>
</a>
</dt>
<dd>
<p>The clients to which the FAC will report to.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Detection.html##(DETECTION_BASE)">Detection#DETECTION_BASE</a></em>
<a id="#(FAC_REPORTING).Detection" >
<strong>FAC_REPORTING.Detection</strong>
</a>
</dt>
<dd>
<p>The DETECTION_BASE object that is used to report the detected objects.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(FAC_REPORTING).New" >
<strong>FAC_REPORTING:New(ClientSet, Detection)</strong>
</a>
</dt>
<dd>
<p>FAC_REPORTING constructor.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Set.html##(SET_CLIENT)">Set#SET_CLIENT</a> ClientSet </em></code>: </p>
</li>
<li>
<p><code><em><a href="Detection.html##(DETECTION_BASE)">Detection#DETECTION_BASE</a> Detection </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(FAC_REPORTING)">#FAC_REPORTING</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(FAC_REPORTING).ReportDetected" >
<strong>FAC_REPORTING:ReportDetected(Client, DetectedSets)</strong>
</a>
</dt>
<dd>
<p>Reports the detected items to the <a href="Set.html##(SET_CLIENT)">Set#SET_CLIENT</a>.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Client.html##(CLIENT)">Client#CLIENT</a> Client </em></code>:
The <a href="Client.html">Client</a> object to where the report needs to go.</p>
</li>
<li>
<p><code><em><a href="Set.html##(SET_BASE)">Set#SET_BASE</a> DetectedSets </em></code>:
The detected Sets created by the <a href="Detection.html##(DETECTION_BASE)">Detection#DETECTION_BASE</a> object.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em>
Return true if you want the reporting to continue... false will cancel the reporting loop.</p>
</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink