igc-xc-score
Version:
igc-xc-score is a paragliding and hang-gliding XC scoring program in vanilla JS
990 lines (267 loc) • 13.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"></span></h4>
<div class="description">
This is the FAI definition of Out-and-Return Distance
with a single TP
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="scoring-rules.config.js.html">scoring-rules.config.js</a>, <a href="scoring-rules.config.js.html#line228">line 228</a>
</li></ul></dd>
</dl>
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"></span></h4>
<div class="description">
This type of flight is very similar to XCLeague
Out-and-Return distance
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="scoring-rules.config.js.html">scoring-rules.config.js</a>, <a href="scoring-rules.config.js.html#line251">line 251</a>
</li></ul></dd>
</dl>
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"></span></h4>
<div class="description">
This is the XCLeague definition of Out-and-Return Distance
between 2 turnpoints
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="scoring-rules.config.js.html">scoring-rules.config.js</a>, <a href="scoring-rules.config.js.html#line274">line 274</a>
</li></ul></dd>
</dl>
<h4 class="name" id="scoringRules"><span class="type-signature">(constant) </span>scoringRules<span class="type-signature"> :Array.<Array.<object>></span></h4>
<div class="description">
These are the scoring types
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<Array.<object>></span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>FFVL</code></td>
<td class="type">
<span class="param-type">Array.<object></span>
</td>
<td class="description last">FFVL Rules</td>
</tr>
<tr>
<td class="name"><code>XContest</code></td>
<td class="type">
<span class="param-type">Array.<object></span>
</td>
<td class="description last">XContest Rules</td>
</tr>
<tr>
<td class="name"><code>FAI</code></td>
<td class="type">
<span class="param-type">Array.<object></span>
</td>
<td class="description last">FAI Scoring Rules w/o cylinders</td>
</tr>
<tr>
<td class="name"><code>"FAI-Cylinders"</code></td>
<td class="type">
<span class="param-type">Array.<object></span>
</td>
<td class="description last">FAI Scoring Rules w/ cylinders</td>
</tr>
<tr>
<td class="name"><code>"FAI-OAR"</code></td>
<td class="type">
<span class="param-type">Array.<object></span>
</td>
<td class="description last">FAI Out-and-Return Distance evaluation w/o scoring multiplier</td>
</tr>
<tr>
<td class="name"><code>"FAI-OAR2"</code></td>
<td class="type">
<span class="param-type">Array.<object></span>
</td>
<td class="description last">FAI Out-and-Return Distance around 2 TPs w/o scoring multiplier</td>
</tr>
<tr>
<td class="name"><code>XCLeague</code></td>
<td class="type">
<span class="param-type">Array.<object></span>
</td>
<td class="description last">XCLeague Rules</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="scoring-rules.config.js.html">scoring-rules.config.js</a>, <a href="scoring-rules.config.js.html#line18">line 18</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="module:igc-xc-score"><span class="type-signature"></span>module:igc-xc-score<span class="signature">(flight, scoringTypes<span class="signature-attributes">opt</span>, config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
This the solver
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>flight</code></td>
<td class="type">
<span class="param-type">IGCFile</span>
</td>
<td class="attributes">
</td>
<td class="description last">flight track data in the igc_parser format</td>
</tr>
<tr>
<td class="name"><code>scoringTypes</code></td>
<td class="type">
<span class="param-type">Array.<object></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">undefined for FFVL or one of the elements of scoringRules</td>
</tr>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">optional config parameters
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>maxcycle</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">maximum execution time of the solver in ms, each sucessive call will return a better solution, default undefined for unlimited</td>
</tr>
<tr>
<td class="name"><code>noflight</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">do not include the flight track data in the output GeoJSON, default false</td>
</tr>
<tr>
<td class="name"><code>invalid</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">include invalid GPS fixes when evaluating the flight, default false</td>
</tr>
<tr>
<td class="name"><code>hp</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">use high-precision distance calculation (Vincenty's), much slower for slightly higher precision, default false</td>
</tr>
<tr>
<td class="name"><code>trim</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">automatically detect launch and landing and trim the flight track, default false</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="src_solver.js.html">src/solver.js</a>, <a href="src_solver.js.html#line27">line 27</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-igc-xc-score.html">igc-xc-score</a></li></ul><h3>Global</h3><ul><li><a href="global.html#name">name</a></li><li><a href="global.html#scoringRules">scoringRules</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.3</a> on Wed Sep 25 2024 13:24:38 GMT+0200 (Central European Summer Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>