91 lines
2.4 KiB
HTML
91 lines
2.4 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: gpxRoute.js</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">Source: gpxRoute.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source"><code>
|
|
/**
|
|
* Constructs a gpx route.
|
|
* @class
|
|
* @classdesc represents a route, an ordered list of waypoints representing a series of turn points leading to a destination.
|
|
* @param {string} name The name of the route.
|
|
* @param {string} cmt A comment regarding the route.
|
|
* @param {string} desc A description of the route.
|
|
* @param {object[]} points An array of waypoints representing the route.
|
|
**/
|
|
function GpxRoute(name, cmt, desc, points) {
|
|
|
|
name = name || "";
|
|
desc = desc || "";
|
|
cmt = cmt || "";
|
|
points = points || [];
|
|
|
|
this.__defineGetter__("name", function() {
|
|
return name;
|
|
});
|
|
|
|
this.__defineGetter__("cmt", function() {
|
|
return cmt;
|
|
});
|
|
|
|
this.__defineGetter__("description", function() {
|
|
return desc;
|
|
});
|
|
|
|
this.__defineGetter__("points", function() {
|
|
return points;
|
|
});
|
|
|
|
this.point = function(index) {
|
|
return points[index];
|
|
};
|
|
|
|
}
|
|
|
|
module.exports = GpxRoute;
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-geomutils.html">geomutils</a></li><li><a href="module-gpx-parse.html">gpx-parse</a></li></ul><h3>Classes</h3><ul><li><a href="GpxExtent.html">GpxExtent</a></li><li><a href="GpxMetaData.html">GpxMetaData</a></li><li><a href="GpxResult.html">GpxResult</a></li><li><a href="GpxRoute.html">GpxRoute</a></li><li><a href="GpxTrack.html">GpxTrack</a></li><li><a href="GpxWaypoint.html">GpxWaypoint</a></li></ul><h3><a href="global.html">Global</a></h3>
|
|
</nav>
|
|
|
|
<br clear="both">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Wed Aug 13 2014 09:19:33 GMT+0100 (BST)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|