mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
1646 lines
42 KiB
HTML
1646 lines
42 KiB
HTML
<!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="DCScountry.html">DCScountry</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>Detection</li>
|
|
<li><a href="DetectionManager.html">DetectionManager</a></li>
|
|
<li><a href="Escort.html">Escort</a></li>
|
|
<li><a href="Event.html">Event</a></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="Process.html">Process</a></li>
|
|
<li><a href="Process_CAS.html">Process_CAS</a></li>
|
|
<li><a href="Process_SEAD.html">Process_SEAD</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="StateMachine.html">StateMachine</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="Task.html">Task</a></li>
|
|
<li><a href="Task_Assign.html">Task_Assign</a></li>
|
|
<li><a href="Task_CAS.html">Task_CAS</a></li>
|
|
<li><a href="Task_Client_Menu.html">Task_Client_Menu</a></li>
|
|
<li><a href="Task_Route.html">Task_Route</a></li>
|
|
<li><a href="Task_SEAD.html">Task_SEAD</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>Detection</code></h1>
|
|
|
|
<p> This module contains the DETECTION classes.</p>
|
|
|
|
|
|
<h1> </h1>
|
|
|
|
<h1> 1) <a href="Detection.html##(DETECTION_BASE)">Detection#DETECTION_BASE</a> class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
|
|
<p> The <a href="Detection.html##(DETECTION_BASE)">Detection#DETECTION_BASE</a> class defines the core functions to administer detected objects.
|
|
The <a href="Detection.html##(DETECTION_BASE)">Detection#DETECTION_BASE</a> class will detect objects within the battle zone for a list of <a href="Group.html">Group</a>s detecting targets following (a) detection method(s).</p>
|
|
|
|
<h2> 1.1) DETECTION_BASE constructor</h2>
|
|
<p> Construct a new DETECTION_BASE instance using the <a href="Detection.html##(DETECTION_BASE).New">Detection#DETECTION_BASE.New</a>() method.</p>
|
|
|
|
<h2> 1.2) DETECTION_BASE initialization</h2>
|
|
<p> By default, detection will return detected objects with all the detection sensors available.
|
|
However, you can ask how the objects were found with specific detection methods.
|
|
If you use one of the below methods, the detection will work with the detection method specified.
|
|
You can specify to apply multiple detection methods.</p>
|
|
|
|
<p> Use the following functions to report the objects it detected using the methods Visual, Optical, Radar, IRST, RWR, DLINK:</p>
|
|
|
|
<ul>
|
|
<li><a href="Detection.html##(DETECTION_BASE).InitDetectVisual">Detection#DETECTION_BASE.InitDetectVisual</a>(): Detected using Visual.</li>
|
|
<li><a href="Detection.html##(DETECTION_BASE).InitDetectOptical">Detection#DETECTION_BASE.InitDetectOptical</a>(): Detected using Optical.</li>
|
|
<li><a href="Detection.html##(DETECTION_BASE).InitDetectRadar">Detection#DETECTION_BASE.InitDetectRadar</a>(): Detected using Radar.</li>
|
|
<li><a href="Detection.html##(DETECTION_BASE).InitDetectIRST">Detection#DETECTION_BASE.InitDetectIRST</a>(): Detected using IRST.</li>
|
|
<li><a href="Detection.html##(DETECTION_BASE).InitDetectRWR">Detection#DETECTION_BASE.InitDetectRWR</a>(): Detected using RWR.</li>
|
|
<li><a href="Detection.html##(DETECTION_BASE).InitDetectDLINK">Detection#DETECTION_BASE.InitDetectDLINK</a>(): Detected using DLINK.</li>
|
|
</ul>
|
|
|
|
<h2> 1.3) Obtain objects detected by DETECTION_BASE</h2>
|
|
<p> DETECTION_BASE builds <a href="Set.html">Set</a>s of objects detected. These <a href="Set.html##(SET_BASE)">Set#SET_BASE</a>s can be retrieved using the method <a href="Detection.html##(DETECTION_BASE).GetDetectedSets">Detection#DETECTION_BASE.GetDetectedSets</a>().
|
|
The method will return a list (table) of <a href="Set.html##(SET_BASE)">Set#SET_BASE</a> objects.</p>
|
|
|
|
<hr/>
|
|
|
|
<h1> 2) <a href="Detection.html##(DETECTION_UNITGROUPS)">Detection#DETECTION_UNITGROUPS</a> class, extends <a href="Detection.html##(DETECTION_BASE)">Detection#DETECTION_BASE</a></h1>
|
|
<p> The <a href="Detection.html##(DETECTION_UNITGROUPS)">Detection#DETECTION_UNITGROUPS</a> class will detect units within the battle zone for a list of <a href="Group.html">Group</a>s detecting targets following (a) detection method(s),
|
|
and will build a list (table) of <a href="Set.html##(SET_UNIT)">Set#SET_UNIT</a>s containing the <a href="Unit.html##(UNIT)">Unit#UNIT</a>s detected.
|
|
The class is group the detected units within zones given a DetectedZoneRange parameter.
|
|
A set with multiple detected zones will be created as there are groups of units detected.</p>
|
|
|
|
<h2> 2.1) Retrieve the Detected Unit sets and Detected Zones</h2>
|
|
<p> The DetectedUnitSets methods are implemented in <a href="Detection.html##(DECTECTION_BASE)">Detection#DECTECTION_BASE</a> and the DetectedZones methods is implemented in <a href="Detection.html##(DETECTION_UNITGROUPS)">Detection#DETECTION_UNITGROUPS</a>.</p>
|
|
|
|
<p> Retrieve the DetectedUnitSets with the method <a href="Detection.html##(DETECTION_BASE).GetDetectedSets">Detection#DETECTION_BASE.GetDetectedSets</a>(). A table will be return of <a href="Set.html##(SET_UNIT)">Set#SET_UNIT</a>s.
|
|
To understand the amount of sets created, use the method <a href="Detection.html##(DETECTION_BASE).GetDetectedSetCount">Detection#DETECTION_BASE.GetDetectedSetCount</a>().
|
|
If you want to obtain a specific set from the DetectedSets, use the method <a href="Detection.html##(DETECTION_BASE).GetDetectedSet">Detection#DETECTION_BASE.GetDetectedSet</a>() with a given index.</p>
|
|
|
|
<p> Retrieve the formed <a href="Zone.html">Zone</a>s as a result of the grouping the detected units within the DetectionZoneRange, use the method <a href="Detection.html##(DETECTION_BASE).GetDetectionZones">Detection#DETECTION_BASE.GetDetectionZones</a>().
|
|
To understand the amount of zones created, use the method <a href="Detection.html##(DETECTION_BASE).GetDetectionZoneCount">Detection#DETECTION_BASE.GetDetectionZoneCount</a>().
|
|
If you want to obtain a specific zone from the DetectedZones, use the method <a href="Detection.html##(DETECTION_BASE).GetDetectionZone">Detection#DETECTION_BASE.GetDetectionZone</a>() with a given index.</p>
|
|
|
|
<h2> 1.4) Flare or Smoke detected units</h2>
|
|
<p> Use the methods <a href="Detection.html##(DETECTION_UNITGROUPS).FlareDetectedUnits">Detection#DETECTION_UNITGROUPS.FlareDetectedUnits</a>() or <a href="Detection.html##(DETECTION_UNITGROUPS).SmokeDetectedUnits">Detection#DETECTION_UNITGROUPS.SmokeDetectedUnits</a>() to flare or smoke the detected units when a new detection has taken place.</p>
|
|
|
|
<h2> 1.5) Flare or Smoke detected zones</h2>
|
|
<p> Use the methods <a href="Detection.html##(DETECTION_UNITGROUPS).FlareDetectedZones">Detection#DETECTION_UNITGROUPS.FlareDetectedZones</a>() or <a href="Detection.html##(DETECTION_UNITGROUPS).SmokeDetectedZones">Detection#DETECTION_UNITGROUPS.SmokeDetectedZones</a>() to flare or smoke the detected zones when a new detection has taken place.</p>
|
|
|
|
<hr/>
|
|
|
|
<p> ### Contributions: Mechanic - Concept & Testing
|
|
### Authors: FlightControl : Design & Programming
|
|
</p>
|
|
|
|
<h2>Global(s)</h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#DETECTION_BASE">DETECTION_BASE</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#DETECTION_UNITGROUPS">DETECTION_UNITGROUPS</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a id="#(DETECTION_BASE)">Type <code>DETECTION_BASE</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).ClassName">DETECTION_BASE.ClassName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).CreateDetectionSets">DETECTION_BASE:CreateDetectionSets()</a></td>
|
|
<td class="summary">
|
|
<p>Make a DetectionSet table.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).DetectDLINK">DETECTION_BASE.DetectDLINK</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).DetectIRST">DETECTION_BASE.DetectIRST</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).DetectOptical">DETECTION_BASE.DetectOptical</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).DetectRWR">DETECTION_BASE.DetectRWR</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).DetectRadar">DETECTION_BASE.DetectRadar</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).DetectVisual">DETECTION_BASE.DetectVisual</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).DetectedObjects">DETECTION_BASE.DetectedObjects</a></td>
|
|
<td class="summary">
|
|
<p>The list of detected objects.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).DetectionGroups">DETECTION_BASE.DetectionGroups</a></td>
|
|
<td class="summary">
|
|
<p>The GROUP in the Forward Air Controller role.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).DetectionRange">DETECTION_BASE.DetectionRange</a></td>
|
|
<td class="summary">
|
|
<p>The range till which targets are accepted to be detected.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).DetectionRun">DETECTION_BASE.DetectionRun</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).DetectionScheduler">DETECTION_BASE.DetectionScheduler</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).GetDetectedObject">DETECTION_BASE:GetDetectedObject(ObjectName)</a></td>
|
|
<td class="summary">
|
|
<p>Gets a detected object with a given name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).GetDetectedSet">DETECTION_BASE:GetDetectedSet(Index)</a></td>
|
|
<td class="summary">
|
|
<p>Get a SET of detected objects using a given numeric index.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).GetDetectedSetCount">DETECTION_BASE:GetDetectedSetCount()</a></td>
|
|
<td class="summary">
|
|
<p>Get the amount of SETs with detected objects.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).GetDetectedSets">DETECTION_BASE:GetDetectedSets()</a></td>
|
|
<td class="summary">
|
|
<p>Get the detected <a href="Set.html##(SET_BASE)">Set#SET_BASE</a>s.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).GetDetectionGroups">DETECTION_BASE:GetDetectionGroups()</a></td>
|
|
<td class="summary">
|
|
<p>Get the detection Groups.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).InitDetectDLINK">DETECTION_BASE:InitDetectDLINK(DetectDLINK)</a></td>
|
|
<td class="summary">
|
|
<p>Detect DLINK.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).InitDetectIRST">DETECTION_BASE:InitDetectIRST(DetectIRST)</a></td>
|
|
<td class="summary">
|
|
<p>Detect IRST.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).InitDetectOptical">DETECTION_BASE:InitDetectOptical(DetectOptical)</a></td>
|
|
<td class="summary">
|
|
<p>Detect Optical.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).InitDetectRWR">DETECTION_BASE:InitDetectRWR(DetectRWR)</a></td>
|
|
<td class="summary">
|
|
<p>Detect RWR.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).InitDetectRadar">DETECTION_BASE:InitDetectRadar(DetectRadar)</a></td>
|
|
<td class="summary">
|
|
<p>Detect Radar.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).InitDetectVisual">DETECTION_BASE:InitDetectVisual(DetectVisual)</a></td>
|
|
<td class="summary">
|
|
<p>Detect Visual.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).New">DETECTION_BASE:New(DetectionGroups, DetectionRange)</a></td>
|
|
<td class="summary">
|
|
<p>DETECTION constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).Schedule">DETECTION_BASE:Schedule(DelayTime, RepeatInterval)</a></td>
|
|
<td class="summary">
|
|
<p>Schedule the DETECTION construction.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).ScheduleDelayTime">DETECTION_BASE.ScheduleDelayTime</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).ScheduleRepeatInterval">DETECTION_BASE.ScheduleRepeatInterval</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE)._DetectionScheduler">DETECTION_BASE:_DetectionScheduler(SchedulerName)</a></td>
|
|
<td class="summary">
|
|
<p>Form <a href="Set.html">Set</a>s of detected <a href="Unit.html##(UNIT)">Unit#UNIT</a>s in an array of <a href="Set.html##(SET_BASE)">Set#SET_BASE</a>s.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(DETECTION_BASE.DetectedObject)">Type <code>DETECTION_BASE.DetectedObject</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedObject).Distance">DETECTION_BASE.DetectedObject.Distance</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedObject).Identified">DETECTION_BASE.DetectedObject.Identified</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedObject).Name">DETECTION_BASE.DetectedObject.Name</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedObject).Type">DETECTION_BASE.DetectedObject.Type</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedObject).Visible">DETECTION_BASE.DetectedObject.Visible</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(DETECTION_UNITGROUPS)">Type <code>DETECTION_UNITGROUPS</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).AddDetectedArea">DETECTION_UNITGROUPS.AddDetectedArea(Set, Zone, self)</a></td>
|
|
<td class="summary">
|
|
<p>Add a detected <a href="##(DETECTION_UNITGROUPS).DetectedArea">DETECTION_UNITGROUPS.DetectedArea</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).ClassName">DETECTION_UNITGROUPS.ClassName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).CreateDetectionSets">DETECTION_UNITGROUPS:CreateDetectionSets()</a></td>
|
|
<td class="summary">
|
|
<p>Make a DetectionSet table.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).DetectedAreas">DETECTION_UNITGROUPS.DetectedAreas</a></td>
|
|
<td class="summary">
|
|
<p>A list of areas containing the set of <a href="Unit.html">Unit</a>s, <a href="Zone.html">Zone</a>s, the center <a href="Unit.html">Unit</a> within the zone, and ID of each area that was detected within a DetectionZoneRange.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).DetectionZoneRange">DETECTION_UNITGROUPS.DetectionZoneRange</a></td>
|
|
<td class="summary">
|
|
<p>The range till which targets are grouped upon the first detected target.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).FlareDetectedUnits">DETECTION_UNITGROUPS:FlareDetectedUnits()</a></td>
|
|
<td class="summary">
|
|
<p>Flare the detected units</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).FlareDetectedZones">DETECTION_UNITGROUPS:FlareDetectedZones()</a></td>
|
|
<td class="summary">
|
|
<p>Flare the detected zones</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).GetDetectedAreaCount">DETECTION_UNITGROUPS:GetDetectedAreaCount()</a></td>
|
|
<td class="summary">
|
|
<p>Get the amount of <a href="##(DETECTION_UNITGROUPS).DetectedAreas">DETECTION_UNITGROUPS.DetectedAreas</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).GetDetectedAreas">DETECTION_UNITGROUPS:GetDetectedAreas()</a></td>
|
|
<td class="summary">
|
|
<p>Get the detected <a href="##(DETECTION_UNITGROUPS).DetectedAreas">DETECTION_UNITGROUPS.DetectedAreas</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).GetDetectedSet">DETECTION_UNITGROUPS:GetDetectedSet(Index)</a></td>
|
|
<td class="summary">
|
|
<p>Get the <a href="Set.html##(SET_UNIT)">Set#SET_UNIT</a> of a detecttion area using a given numeric index.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).GetDetectedZone">DETECTION_UNITGROUPS:GetDetectedZone(Index)</a></td>
|
|
<td class="summary">
|
|
<p>Get the <a href="Zone.html##(ZONE_UNIT)">Zone#ZONE_UNIT</a> of a detection area using a given numeric index.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).New">DETECTION_UNITGROUPS:New(DetectionGroups, DetectionRange, DetectionZoneRange)</a></td>
|
|
<td class="summary">
|
|
<p>DETECTION_UNITGROUPS constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).RemoveDetectedArea">DETECTION_UNITGROUPS:RemoveDetectedArea(Index)</a></td>
|
|
<td class="summary">
|
|
<p>Remove a detected <a href="##(DETECTION_UNITGROUPS).DetectedArea">DETECTION_UNITGROUPS.DetectedArea</a> with a given Index.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).SmokeDetectedUnits">DETECTION_UNITGROUPS:SmokeDetectedUnits()</a></td>
|
|
<td class="summary">
|
|
<p>Smoke the detected units</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS).SmokeDetectedZones">DETECTION_UNITGROUPS:SmokeDetectedZones()</a></td>
|
|
<td class="summary">
|
|
<p>Smoke the detected zones</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS)._FlareDetectedUnits">DETECTION_UNITGROUPS._FlareDetectedUnits</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS)._FlareDetectedZones">DETECTION_UNITGROUPS._FlareDetectedZones</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS)._SmokeDetectedUnits">DETECTION_UNITGROUPS._SmokeDetectedUnits</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS)._SmokeDetectedZones">DETECTION_UNITGROUPS._SmokeDetectedZones</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(DETECTION_UNITGROUPS.DetectedArea)">Type <code>DETECTION_UNITGROUPS.DetectedArea</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS.DetectedArea).AreaID">DETECTION_UNITGROUPS.DetectedArea.AreaID</a></td>
|
|
<td class="summary">
|
|
<p>-- The identifier of the detected area.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS.DetectedArea).Set">DETECTION_UNITGROUPS.DetectedArea.Set</a></td>
|
|
<td class="summary">
|
|
<p>-- The Set of Units in the detected area.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITGROUPS.DetectedArea).Zone">DETECTION_UNITGROUPS.DetectedArea.Zone</a></td>
|
|
<td class="summary">
|
|
<p>-- The Zone of the detected area.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2>Global(s)</h2>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(DETECTION_BASE)">#DETECTION_BASE</a></em>
|
|
<a id="DETECTION_BASE" >
|
|
<strong>DETECTION_BASE</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(DETECTION_UNITGROUPS)">#DETECTION_UNITGROUPS</a></em>
|
|
<a id="DETECTION_UNITGROUPS" >
|
|
<strong>DETECTION_UNITGROUPS</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2><a id="#(Detection)" >Type <code>Detection</code></a></h2>
|
|
|
|
<h2><a id="#(DETECTION_BASE)" >Type <code>DETECTION_BASE</code></a></h2>
|
|
|
|
<p>DETECTION_BASE class</p>
|
|
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(DETECTION_BASE).ClassName" >
|
|
<strong>DETECTION_BASE.ClassName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE).CreateDetectionSets" >
|
|
<strong>DETECTION_BASE:CreateDetectionSets()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Make a DetectionSet table.</p>
|
|
|
|
|
|
<p>This function will be overridden in the derived clsses.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_BASE)">#DETECTION_BASE</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(DETECTION_BASE).DetectDLINK" >
|
|
<strong>DETECTION_BASE.DetectDLINK</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(DETECTION_BASE).DetectIRST" >
|
|
<strong>DETECTION_BASE.DetectIRST</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(DETECTION_BASE).DetectOptical" >
|
|
<strong>DETECTION_BASE.DetectOptical</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(DETECTION_BASE).DetectRWR" >
|
|
<strong>DETECTION_BASE.DetectRWR</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(DETECTION_BASE).DetectRadar" >
|
|
<strong>DETECTION_BASE.DetectRadar</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(DETECTION_BASE).DetectVisual" >
|
|
<strong>DETECTION_BASE.DetectVisual</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(DETECTION_BASE.DetectedObjects)">#DETECTION_BASE.DetectedObjects</a></em>
|
|
<a id="#(DETECTION_BASE).DetectedObjects" >
|
|
<strong>DETECTION_BASE.DetectedObjects</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>The list of detected objects.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="Group.html##(GROUP)">Group#GROUP</a></em>
|
|
<a id="#(DETECTION_BASE).DetectionGroups" >
|
|
<strong>DETECTION_BASE.DetectionGroups</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>The GROUP in the Forward Air Controller role.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="DCSTypes.html##(Distance)">DCSTypes#Distance</a></em>
|
|
<a id="#(DETECTION_BASE).DetectionRange" >
|
|
<strong>DETECTION_BASE.DetectionRange</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>The range till which targets are accepted to be detected.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(DETECTION_BASE).DetectionRun" >
|
|
<strong>DETECTION_BASE.DetectionRun</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(DETECTION_BASE).DetectionScheduler" >
|
|
<strong>DETECTION_BASE.DetectionScheduler</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE).GetDetectedObject" >
|
|
<strong>DETECTION_BASE:GetDetectedObject(ObjectName)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Gets a detected object with a given name.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#string ObjectName </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_BASE.DetectedObject)">#DETECTION_BASE.DetectedObject</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE).GetDetectedSet" >
|
|
<strong>DETECTION_BASE:GetDetectedSet(Index)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get a SET of detected objects using a given numeric index.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number Index </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="Set.html##(SET_BASE)">Set#SET_BASE</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE).GetDetectedSetCount" >
|
|
<strong>DETECTION_BASE:GetDetectedSetCount()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the amount of SETs with detected objects.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#number:</em>
|
|
Count</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE).GetDetectedSets" >
|
|
<strong>DETECTION_BASE:GetDetectedSets()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the detected <a href="Set.html##(SET_BASE)">Set#SET_BASE</a>s.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_BASE.DetectedSets)">#DETECTION_BASE.DetectedSets</a>:</em>
|
|
DetectedSets</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE).GetDetectionGroups" >
|
|
<strong>DETECTION_BASE:GetDetectionGroups()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the detection Groups.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="Group.html##(GROUP)">Group#GROUP</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE).InitDetectDLINK" >
|
|
<strong>DETECTION_BASE:InitDetectDLINK(DetectDLINK)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Detect DLINK.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#boolean DetectDLINK </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_BASE)">#DETECTION_BASE</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE).InitDetectIRST" >
|
|
<strong>DETECTION_BASE:InitDetectIRST(DetectIRST)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Detect IRST.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#boolean DetectIRST </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_BASE)">#DETECTION_BASE</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE).InitDetectOptical" >
|
|
<strong>DETECTION_BASE:InitDetectOptical(DetectOptical)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Detect Optical.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#boolean DetectOptical </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_BASE)">#DETECTION_BASE</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE).InitDetectRWR" >
|
|
<strong>DETECTION_BASE:InitDetectRWR(DetectRWR)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Detect RWR.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#boolean DetectRWR </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_BASE)">#DETECTION_BASE</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE).InitDetectRadar" >
|
|
<strong>DETECTION_BASE:InitDetectRadar(DetectRadar)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Detect Radar.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#boolean DetectRadar </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_BASE)">#DETECTION_BASE</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE).InitDetectVisual" >
|
|
<strong>DETECTION_BASE:InitDetectVisual(DetectVisual)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Detect Visual.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#boolean DetectVisual </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_BASE)">#DETECTION_BASE</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE).New" >
|
|
<strong>DETECTION_BASE:New(DetectionGroups, DetectionRange)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>DETECTION constructor.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Group.html##(GROUP)">Group#GROUP</a> DetectionGroups </em></code>:
|
|
The GROUP in the Forward Air Controller role.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="DCSTypes.html##(Distance)">DCSTypes#Distance</a> DetectionRange </em></code>:
|
|
The range till which targets are accepted to be detected.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_BASE)">#DETECTION_BASE</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE).Schedule" >
|
|
<strong>DETECTION_BASE:Schedule(DelayTime, RepeatInterval)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Schedule the DETECTION construction.</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 RepeatInterval </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_BASE)">#DETECTION_BASE</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(DETECTION_BASE).ScheduleDelayTime" >
|
|
<strong>DETECTION_BASE.ScheduleDelayTime</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(DETECTION_BASE).ScheduleRepeatInterval" >
|
|
<strong>DETECTION_BASE.ScheduleRepeatInterval</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_BASE)._DetectionScheduler" >
|
|
<strong>DETECTION_BASE:_DetectionScheduler(SchedulerName)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Form <a href="Set.html">Set</a>s of detected <a href="Unit.html##(UNIT)">Unit#UNIT</a>s in an array of <a href="Set.html##(SET_BASE)">Set#SET_BASE</a>s.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> SchedulerName </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(DETECTION_BASE.DetectedObject)" >Type <code>DETECTION_BASE.DetectedObject</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(DETECTION_BASE.DetectedObject).Distance" >
|
|
<strong>DETECTION_BASE.DetectedObject.Distance</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(DETECTION_BASE.DetectedObject).Identified" >
|
|
<strong>DETECTION_BASE.DetectedObject.Identified</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(DETECTION_BASE.DetectedObject).Name" >
|
|
<strong>DETECTION_BASE.DetectedObject.Name</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(DETECTION_BASE.DetectedObject).Type" >
|
|
<strong>DETECTION_BASE.DetectedObject.Type</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(DETECTION_BASE.DetectedObject).Visible" >
|
|
<strong>DETECTION_BASE.DetectedObject.Visible</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(DETECTION_BASE.DetectedObjects)" >Type <code>DETECTION_BASE.DetectedObjects</code></a></h2>
|
|
|
|
<h2><a id="#(DETECTION_BASE.DetectedSets)" >Type <code>DETECTION_BASE.DetectedSets</code></a></h2>
|
|
|
|
<h2><a id="#(DETECTION_UNITGROUPS)" >Type <code>DETECTION_UNITGROUPS</code></a></h2>
|
|
|
|
<p>DETECTION_UNITGROUPS class</p>
|
|
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_UNITGROUPS).AddDetectedArea" >
|
|
<strong>DETECTION_UNITGROUPS.AddDetectedArea(Set, Zone, self)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Add a detected <a href="##(DETECTION_UNITGROUPS).DetectedArea">DETECTION_UNITGROUPS.DetectedArea</a>.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Set.html##(SET_UNIT)">Set#SET_UNIT</a> Set </em></code>:
|
|
-- The Set of Units in the detected area.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Zone.html##(ZONE_UNIT)">Zone#ZONE_UNIT</a> Zone </em></code>:
|
|
-- The Zone of the detected area.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> self </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_UNITGROUPS.DetectedArea)">#DETECTION_UNITGROUPS.DetectedArea</a>:</em>
|
|
DetectedArea</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(DETECTION_UNITGROUPS).ClassName" >
|
|
<strong>DETECTION_UNITGROUPS.ClassName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_UNITGROUPS).CreateDetectionSets" >
|
|
<strong>DETECTION_UNITGROUPS:CreateDetectionSets()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Make a DetectionSet table.</p>
|
|
|
|
|
|
<p>This function will be overridden in the derived clsses.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_UNITGROUPS)">#DETECTION_UNITGROUPS</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(DETECTION_UNITGROUPS.DetectedAreas)">#DETECTION_UNITGROUPS.DetectedAreas</a></em>
|
|
<a id="#(DETECTION_UNITGROUPS).DetectedAreas" >
|
|
<strong>DETECTION_UNITGROUPS.DetectedAreas</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>A list of areas containing the set of <a href="Unit.html">Unit</a>s, <a href="Zone.html">Zone</a>s, the center <a href="Unit.html">Unit</a> within the zone, and ID of each area that was detected within a DetectionZoneRange.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="DCSTypes.html##(Distance)">DCSTypes#Distance</a></em>
|
|
<a id="#(DETECTION_UNITGROUPS).DetectionZoneRange" >
|
|
<strong>DETECTION_UNITGROUPS.DetectionZoneRange</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>The range till which targets are grouped upon the first detected target.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_UNITGROUPS).FlareDetectedUnits" >
|
|
<strong>DETECTION_UNITGROUPS:FlareDetectedUnits()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Flare the detected units</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_UNITGROUPS)">#DETECTION_UNITGROUPS</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_UNITGROUPS).FlareDetectedZones" >
|
|
<strong>DETECTION_UNITGROUPS:FlareDetectedZones()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Flare the detected zones</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_UNITGROUPS)">#DETECTION_UNITGROUPS</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_UNITGROUPS).GetDetectedAreaCount" >
|
|
<strong>DETECTION_UNITGROUPS:GetDetectedAreaCount()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the amount of <a href="##(DETECTION_UNITGROUPS).DetectedAreas">DETECTION_UNITGROUPS.DetectedAreas</a>.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#number:</em>
|
|
DetectedAreaCount</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_UNITGROUPS).GetDetectedAreas" >
|
|
<strong>DETECTION_UNITGROUPS:GetDetectedAreas()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the detected <a href="##(DETECTION_UNITGROUPS).DetectedAreas">DETECTION_UNITGROUPS.DetectedAreas</a>.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_UNITGROUPS.DetectedAreas)">#DETECTION_UNITGROUPS.DetectedAreas</a>:</em>
|
|
DetectedAreas</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_UNITGROUPS).GetDetectedSet" >
|
|
<strong>DETECTION_UNITGROUPS:GetDetectedSet(Index)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the <a href="Set.html##(SET_UNIT)">Set#SET_UNIT</a> of a detecttion area using a given numeric index.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number Index </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="Set.html##(SET_UNIT)">Set#SET_UNIT</a>:</em>
|
|
DetectedSet</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_UNITGROUPS).GetDetectedZone" >
|
|
<strong>DETECTION_UNITGROUPS:GetDetectedZone(Index)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the <a href="Zone.html##(ZONE_UNIT)">Zone#ZONE_UNIT</a> of a detection area using a given numeric index.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number Index </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="Zone.html##(ZONE_UNIT)">Zone#ZONE_UNIT</a>:</em>
|
|
DetectedZone</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_UNITGROUPS).New" >
|
|
<strong>DETECTION_UNITGROUPS:New(DetectionGroups, DetectionRange, DetectionZoneRange)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>DETECTION_UNITGROUPS constructor.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Group.html##(GROUP)">Group#GROUP</a> DetectionGroups </em></code>:
|
|
The GROUP in the Forward Air Controller role.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="DCSTypes.html##(Distance)">DCSTypes#Distance</a> DetectionRange </em></code>:
|
|
The range till which targets are accepted to be detected.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="DCSTypes.html##(Distance)">DCSTypes#Distance</a> DetectionZoneRange </em></code>:
|
|
The range till which targets are grouped upon the first detected target.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="Detection.html##(DETECTION_UNITGROUPS)">Detection#DETECTION_UNITGROUPS</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_UNITGROUPS).RemoveDetectedArea" >
|
|
<strong>DETECTION_UNITGROUPS:RemoveDetectedArea(Index)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Remove a detected <a href="##(DETECTION_UNITGROUPS).DetectedArea">DETECTION_UNITGROUPS.DetectedArea</a> with a given Index.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number Index </em></code>:
|
|
The Index of the detection are to be removed.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#nil:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_UNITGROUPS).SmokeDetectedUnits" >
|
|
<strong>DETECTION_UNITGROUPS:SmokeDetectedUnits()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Smoke the detected units</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_UNITGROUPS)">#DETECTION_UNITGROUPS</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(DETECTION_UNITGROUPS).SmokeDetectedZones" >
|
|
<strong>DETECTION_UNITGROUPS:SmokeDetectedZones()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Smoke the detected zones</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(DETECTION_UNITGROUPS)">#DETECTION_UNITGROUPS</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(DETECTION_UNITGROUPS)._FlareDetectedUnits" >
|
|
<strong>DETECTION_UNITGROUPS._FlareDetectedUnits</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(DETECTION_UNITGROUPS)._FlareDetectedZones" >
|
|
<strong>DETECTION_UNITGROUPS._FlareDetectedZones</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(DETECTION_UNITGROUPS)._SmokeDetectedUnits" >
|
|
<strong>DETECTION_UNITGROUPS._SmokeDetectedUnits</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(DETECTION_UNITGROUPS)._SmokeDetectedZones" >
|
|
<strong>DETECTION_UNITGROUPS._SmokeDetectedZones</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(DETECTION_UNITGROUPS.DetectedArea)" >Type <code>DETECTION_UNITGROUPS.DetectedArea</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(DETECTION_UNITGROUPS.DetectedArea).AreaID" >
|
|
<strong>DETECTION_UNITGROUPS.DetectedArea.AreaID</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>-- The identifier of the detected area.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="Set.html##(SET_UNIT)">Set#SET_UNIT</a></em>
|
|
<a id="#(DETECTION_UNITGROUPS.DetectedArea).Set" >
|
|
<strong>DETECTION_UNITGROUPS.DetectedArea.Set</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>-- The Set of Units in the detected area.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="Zone.html##(ZONE_UNIT)">Zone#ZONE_UNIT</a></em>
|
|
<a id="#(DETECTION_UNITGROUPS.DetectedArea).Zone" >
|
|
<strong>DETECTION_UNITGROUPS.DetectedArea.Zone</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>-- The Zone of the detected area.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(DETECTION_UNITGROUPS.DetectedAreas)" >Type <code>DETECTION_UNITGROUPS.DetectedAreas</code></a></h2>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|