MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User
2020-12-15 12:07:04 +00:00
parent c9b37e1222
commit 875805e695
121 changed files with 1098 additions and 697 deletions

View File

@@ -827,7 +827,7 @@
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/" alt="Image">
<img src= "../Images/Functional.Mantis.jpg" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Mantis.html">Functional.Mantis</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
@@ -1363,7 +1363,9 @@ Controls a network of SAM sites.</p>
</div>
</div>
</nav>
<div id="content">
<img src="..\Images\Functional.Mantis.jpg" alt="Banner Image"/>
<div id="content">
<div class="w3-container w3-theme-d5" id="module_title">
<h1>Module <strong>Functional.Mantis</strong></h1>
</div>
@@ -1387,6 +1389,12 @@ Leverage attack range setup added by DCS in 11/20</p>
<hr/>
<h2>Missions:</h2>
<h3><a href="https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/MTS%20-%20Mantis/MTS-010%20-%20Basic%20Mantis%20Demo">MANTIS - Modular, Automatic and Network capable Targeting and Interception System</a></h3>
<hr/>
<h3>Authors : <em>*applevangelist *</em></h3>
@@ -1425,18 +1433,23 @@ Leverage attack range setup added by DCS in 11/20</p>
Leverage evasiveness from <a href="Functional.Sead.html##(SEAD)">Functional.Sead#SEAD</a>.
Leverage attack range setup added by DCS in 11/20.</p>
<h3><strong>Usage:</strong></h3>
<pre class="example"><code>Set up your SAM sites in the mission editor. Name the groups with common prefix like "Red SAM".
<p>Set up your SAM sites in the mission editor. Name the groups with common prefix like "Red SAM".
Set up your EWR system in the mission editor. Name the groups with common prefix like "Red EWR". Can be e.g. AWACS or a combination of AWACS and Search Radars like e.g. EWR 1L13 etc.
[optional] Set up your HQ. Can be any group, e.g. a command vehicle.
[optional] Set up your HQ. Can be any group, e.g. a command vehicle.</p>
Start up your MANTIS
<p>Start up your MANTIS</p>
`myredmantis = MANTIS:New("myredmantis","Red SAM","Red EWR",nil,"red",false)`
[optional] Use `MANTIS:SetEWRGrouping(radius)`, `MANTIS:SetEWRRange(radius)`, `MANTIS:SetSAMRadius(radius)`, `MANTIS:SetDetectInterval(interval)` to fine-tune your setup.
<p> <code>myredmantis = MANTIS:New("myredmantis","Red SAM","Red EWR",nil,"red",false)</code></p>
<p>[optional] Use <br/>
+ <code>MANTIS:SetEWRGrouping(radius)</code> <br/>
+ <code>MANTIS:SetEWRRange(radius)</code> <br/>
+ <code>MANTIS:SetSAMRadius(radius)</code> <br/>
+ <code>MANTIS:SetDetectInterval(interval)</code> <br/>
to fine-tune your setup.</p>
<p> <code>myredmantis:Start()</code></p>
`myredmantis:Start()`
</code></pre>
</div>
@@ -1460,77 +1473,7 @@ Start up your MANTIS
<p>group detected objects to 5000m zones</p>
</div>
</div>
<div class="w3-theme-d2 w3-margin-top ">
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##groupset')">
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>groupset</strong></h2></p></td>
<td class="style="width:60%;">
</td>
</tr>
</table>
</div>
<div id= "#Globals##groupset" class="w3-container w3-white w3-padding-small">
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="groupset" ><strong>groupset</strong></a>
<p> start detection</p>
</div>
</div>
<div class="w3-theme-d2 w3-margin-top ">
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##m')">
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>m</strong></h2></p></td>
<td class="style="width:60%;">
</td>
</tr>
</table>
</div>
<div id= "#Globals##m" class="w3-container w3-white w3-padding-small">
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="m" ><strong>m</strong></a>
</div>
</div>
<div class="w3-theme-d2 w3-margin-top ">
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##text')">
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>text</strong></h2></p></td>
<td class="style="width:60%;">
</td>
</tr>
</table>
</div>
<div id= "#Globals##text" class="w3-container w3-white w3-padding-small">
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="text" ><strong>text</strong></a>
<p>samgroup:OptionROEWeaponFree()
samgroup:SetAIOn()</p>
<p>[internal] Groups detected objects to 5000m zones</p>
</div>
@@ -1546,10 +1489,22 @@ samgroup:SetAIOn()</p>
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from MANTIS</th>
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
</tr>
<tr class="w3-border">
<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).CheckObjectInZone">MANTIS:CheckObjectInZone(dectset, samcoordinate)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to check if no object is in the given SAM zone</p>
<p>Function to check if any object is in the given SAM zone</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).Classname">MANTIS.Classname</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -1579,7 +1534,7 @@ samgroup:SetAIOn()</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).EWR_Templates_Prefix">MANTIS.EWR_Templates_Prefix</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Prefix to build the #GROUP_SET for EWR group</p>
</td>
</tr>
<tr class="w3-border">
@@ -1603,13 +1558,13 @@ samgroup:SetAIOn()</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).SAM_Table">MANTIS.SAM_Table</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Table of SAM sites</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).SAM_Templates_Prefix">MANTIS.SAM_Templates_Prefix</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Prefix to build the #GROUP_SET for SAM sites</p>
</td>
</tr>
<tr class="w3-border">
@@ -1621,7 +1576,7 @@ samgroup:SetAIOn()</p>
<tr class="w3-border">
<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">
@@ -1687,25 +1642,25 @@ samgroup:SetAIOn()</p>
<tr class="w3-border">
<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).checkradius">MANTIS.checkradius</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Radius of the SAM sites</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).debug">MANTIS.debug</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Switch on extra messages</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).detectinterval">MANTIS.detectinterval</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Interval in seconds for the target detection</p>
</td>
</tr>
<tr class="w3-border">
@@ -1717,19 +1672,19 @@ samgroup:SetAIOn()</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).grouping">MANTIS.grouping</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Radius to group detected objects</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).lid">MANTIS.lid</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Prefix for logging</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).name">MANTIS.name</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Name of this Mantis</p>
</td>
</tr>
<tr class="w3-border">
@@ -1750,9 +1705,25 @@ samgroup:SetAIOn()</p>
<div onclick="myFunction('#Types##MANTIS')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(MANTIS)">Type <strong>MANTIS</strong></a></h2></div>
<div id= "#Types##MANTIS" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<ul>
<li><strong>MANTIS</strong> class, extends <a href="Core.Base.html##(BASE)">Core.Base#BASE</a></li>
</ul>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MANTIS).Classname" ><strong>MANTIS.Classname</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -1773,7 +1744,18 @@ samgroup:SetAIOn()</p>
<p> get EWR SET_GROUP</p>
<p> Set EWR SET_GROUP</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MANTIS).EWR_Templates_Prefix" ><strong>MANTIS.EWR_Templates_Prefix</strong></a>
<p>Prefix to build the #GROUP_SET for EWR group</p>
</div>
@@ -1798,7 +1780,7 @@ samgroup:SetAIOn()</p>
<p> get SAM SET_GROUP</p>
<p> Set SAM SET_GROUP</p>
</div>
@@ -1806,10 +1788,21 @@ samgroup:SetAIOn()</p>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS).SAM_Table" ><strong>MANTIS.SAM_Table</strong></a>
<p>Table of SAM sites</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MANTIS).SAM_Templates_Prefix" ><strong>MANTIS.SAM_Templates_Prefix</strong></a>
<p>Prefix to build the #GROUP_SET for SAM sites</p>
</div>
@@ -1822,6 +1815,17 @@ samgroup:SetAIOn()</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MANTIS).SEAD_Template_CC" ><strong>MANTIS.SEAD_Template_CC</strong></a>
<p>The ME name of the HQ object</p>
</div>
</div>
@@ -1831,7 +1835,7 @@ samgroup:SetAIOn()</p>
#number
<a id="#(MANTIS).acceptrange" ><strong>MANTIS.acceptrange</strong></a>
<p>Radius of the EWR detection</p>
</div>
@@ -1842,7 +1846,7 @@ samgroup:SetAIOn()</p>
#number
<a id="#(MANTIS).checkradius" ><strong>MANTIS.checkradius</strong></a>
<p>Radius of the SAM sites</p>
</div>
@@ -1850,10 +1854,10 @@ samgroup:SetAIOn()</p>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(MANTIS).debug" ><strong>MANTIS.debug</strong></a>
<p>Switch on extra messages</p>
</div>
@@ -1864,7 +1868,7 @@ samgroup:SetAIOn()</p>
#number
<a id="#(MANTIS).detectinterval" ><strong>MANTIS.detectinterval</strong></a>
<p>Interval in seconds for the target detection</p>
</div>
@@ -1875,7 +1879,7 @@ samgroup:SetAIOn()</p>
#number
<a id="#(MANTIS).grouping" ><strong>MANTIS.grouping</strong></a>
<p>Radius to group detected objects</p>
</div>
@@ -1883,13 +1887,21 @@ samgroup:SetAIOn()</p>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MANTIS).lid" ><strong>MANTIS.lid</strong></a>
<p>Prefix for logging</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MANTIS).name" ><strong>MANTIS.name</strong></a>
<p> Set some string id for output to DCS.log file.</p>
<p>Name of this Mantis</p>
</div>
@@ -1917,7 +1929,7 @@ samgroup:SetAIOn()</p>
<h2><a id="#(MANTIS).CheckObjectInZone" ><strong>MANTIS:CheckObjectInZone(dectset, samcoordinate)</strong></a></h2>
</div>
<p>Function to check if no object is in the given SAM zone</p>
<p>Function to check if any object is in the given SAM zone</p>
<div id= "#Functions##CheckObjectInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -2438,7 +2450,7 @@ samgroup:SetAIOn()</p>
</div>
<script>
function myLoadFunction() {
document.getElementById("myHeader").style.backgroundImage = "url('../Images/')";
document.getElementById("myHeader").style.backgroundImage = "url('../Images/Functional.Mantis.jpg')";
}
</script>