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:
FlightControl-User
@@ -1452,6 +1452,8 @@ Set up your EWR system in the mission editor. Name the groups with common prefix
|
||||
<p>By default, the following settings are active:</p>
|
||||
|
||||
<ul>
|
||||
<li>SAM_Templates_Prefix = "Red SAM" - SAM site group names in the mission editor begin with "Red SAM"</li>
|
||||
<li>EWR_Templates_Prefix = "Red EWR" - EWR group names in the mission editor begin with "Red EWR" - can also be AWACS</li>
|
||||
<li>checkradius = 25000 (meters) - SAMs will engage enemy flights, if they are within a 25km around each SAM site - <code>MANTIS:SetSAMRadius(radius)</code></li>
|
||||
<li>grouping = 5000 (meters) - Detection (EWR) will group enemy flights to areas of 5km for tracking - <code>MANTIS:SetEWRGrouping(radius)</code></li>
|
||||
<li>acceptrange = 80000 (meters) - Detection (EWR) will on consider flights inside a 80km radius - <code>MANTIS:SetEWRRange(radius)</code> </li>
|
||||
@@ -1506,6 +1508,12 @@ Set up your EWR system in the mission editor. Name the groups with common prefix
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).@">MANTIS.@</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Functional.Detection#DETECTION_AREAS} Detection The #DETECTION_AREAS object</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).Adv_EWR_Group">MANTIS.Adv_EWR_Group</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1554,6 +1562,12 @@ Set up your EWR system in the mission editor. Name the groups with common prefix
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).GetCommandCenter">MANTIS:GetCommandCenter()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Function to get the HQ object for further use</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).MantisAdvTimer">MANTIS.MantisAdvTimer</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1602,12 +1616,24 @@ Set up your EWR system in the mission editor. Name the groups with common prefix
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).SEAD_Template_CC">MANTIS.SEAD_Template_CC</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>The ME name of the HQ object</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).SetAdvancedMode">MANTIS:SetAdvancedMode(onoff, ratio)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Function to set Advanded Mode</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).SetAutoRelocate">MANTIS:SetAutoRelocate(hq, ewr)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Function to set autorelocation for HQ and EWR objects.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).SetCommandCenter">MANTIS:SetCommandCenter(The, group)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Function to set the HQ object for further use</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1662,6 +1688,24 @@ Set up your EWR system in the mission editor. Name the groups with common prefix
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).Stop">MANTIS:Stop()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Function to stop MANTIS</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS)._CheckAdvState">MANTIS:_CheckAdvState()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>[Internal] Function to determine state of the advanced mode</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS)._CheckEWRState">MANTIS:_CheckEWRState()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>[Internal] Function to check if EWR is (at least partially) alive</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS)._CheckHQState">MANTIS:_CheckHQState()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>[Internal] Function to check if HQ is alive</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1686,6 +1730,24 @@ Set up your EWR system in the mission editor. Name the groups with common prefix
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).acceptrange">MANTIS.acceptrange</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Radius of the EWR detection</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).adv_ratio">MANTIS.adv_ratio</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Percentage to use for advanced mode, defaults to 100%</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).adv_state">MANTIS.adv_state</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Advanced mode state tracker</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).advanced">MANTIS.advanced</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Use advanced mode, will decrease reactivity of MANTIS, if HQ and/or EWR network dies. Set SAMs to RED state if both are dead. Requires usage of an HQ object</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1831,6 +1893,20 @@ Set up your EWR system in the mission editor. Name the groups with common prefix
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(MANTIS).MantisAdvTimer" ><strong>MANTIS.MantisAdvTimer</strong></a>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> timer for advanced state check</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(MANTIS).MantisReloTimer" ><strong>MANTIS.MantisReloTimer</strong></a>
|
||||
|
||||
|
||||
@@ -1917,6 +1993,39 @@ Set up your EWR system in the mission editor. Name the groups with common prefix
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(MANTIS).adv_ratio" ><strong>MANTIS.adv_ratio</strong></a>
|
||||
|
||||
<p>Percentage to use for advanced mode, defaults to 100%</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(MANTIS).adv_state" ><strong>MANTIS.adv_state</strong></a>
|
||||
|
||||
<p>Advanced mode state tracker</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(MANTIS).advanced" ><strong>MANTIS.advanced</strong></a>
|
||||
|
||||
<p>Use advanced mode, will decrease reactivity of MANTIS, if HQ and/or EWR network dies. Set SAMs to RED state if both are dead. Requires usage of an HQ object</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
@@ -2270,6 +2379,56 @@ Set up your EWR system in the mission editor. Name the groups with common prefix
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(MANTIS).SetAdvancedMode" ><strong>MANTIS:SetAdvancedMode(onoff, ratio)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Function to set Advanded Mode</p>
|
||||
|
||||
<div id= "#Functions##SetAdvancedMode" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>MANTIS</p>
|
||||
</div>
|
||||
<h2><strong>Parameters:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#boolean
|
||||
<strong><strong>onoff</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>If true, will activate Advanced Mode</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>ratio</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>[optional] Percentage to use for advanced mode, defaults to 100%</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code>Advanced mode will *decrease* reactivity of MANTIS, if HQ and/or EWR network dies. Set SAMs to RED state if both are dead. Requires usage of an **HQ** object
|
||||
E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -2319,6 +2478,49 @@ Set up your EWR system in the mission editor. Name the groups with common prefix
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(MANTIS).SetCommandCenter" ><strong>MANTIS:SetCommandCenter(The, group)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Function to set the HQ object for further use</p>
|
||||
|
||||
<div id= "#Functions##SetCommandCenter" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>MANTIS</p>
|
||||
</div>
|
||||
<h2><strong>Parameters:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="Wrapper.GROUP.html##(GROUP)">Wrapper.GROUP#GROUP</a>
|
||||
<strong><strong>The</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>HQ #GROUP object to be set as HQ</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<strong><strong>group</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -2607,6 +2809,104 @@ Set up your EWR system in the mission editor. Name the groups with common prefix
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(MANTIS)._CheckAdvState" ><strong>MANTIS:_CheckAdvState()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>[Internal] Function to determine state of the advanced mode</p>
|
||||
|
||||
<div id= "#Functions##_CheckAdvState" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>MANTIS</p>
|
||||
</div>
|
||||
<h2><strong>Return values:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p>#number:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Newly calculated interval</p>
|
||||
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p>#number:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Previous state for tracking 0, 1, or 2</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(MANTIS)._CheckEWRState" ><strong>MANTIS:_CheckEWRState()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>[Internal] Function to check if EWR is (at least partially) alive</p>
|
||||
|
||||
<div id= "#Functions##_CheckEWRState" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>MANTIS</p>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p>#boolean:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>True if EWR is alive, else false</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(MANTIS)._CheckHQState" ><strong>MANTIS:_CheckHQState()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>[Internal] Function to check if HQ is alive</p>
|
||||
|
||||
<div id= "#Functions##_CheckHQState" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>MANTIS</p>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p>#boolean:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>True if HQ is alive, else false</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user