diff options
Diffstat (limited to 'html/structroute.html')
| -rw-r--r-- | html/structroute.html | 337 |
1 files changed, 337 insertions, 0 deletions
diff --git a/html/structroute.html b/html/structroute.html new file mode 100644 index 000000000..722611fb7 --- /dev/null +++ b/html/structroute.html @@ -0,0 +1,337 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.6"/> +<title>navit: route Struct Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">navit +  <span id="projectnumber">0.5.1-trunk</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('structroute.html','');}); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-attribs">Data Fields</a> </div> + <div class="headertitle"> +<div class="title">route Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>A complete route. + <a href="structroute.html#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Data Fields</h2></td></tr> +<tr class="memitem:abb33b9282cba092fcc246c2401511f3d"><td class="memItemLeft" align="right" valign="top">NAVIT_OBJECT struct <a class="el" href="structmapset.html">mapset</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structroute.html#abb33b9282cba092fcc246c2401511f3d">ms</a></td></tr> +<tr class="separator:abb33b9282cba092fcc246c2401511f3d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abd7858fe912fc766ceaf38b5763c738a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd7858fe912fc766ceaf38b5763c738a"></a> +enum route_path_flags </td><td class="memItemRight" valign="bottom"><b>flags</b></td></tr> +<tr class="separator:abd7858fe912fc766ceaf38b5763c738a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a052d5b83336fae1672ce9514d386fb9e"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structroute__info.html">route_info</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structroute.html#a052d5b83336fae1672ce9514d386fb9e">pos</a></td></tr> +<tr class="separator:a052d5b83336fae1672ce9514d386fb9e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a19d1594ee18b1887a8904915d319f089"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__GList.html">GList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structroute.html#a19d1594ee18b1887a8904915d319f089">destinations</a></td></tr> +<tr class="separator:a19d1594ee18b1887a8904915d319f089"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1dd2a537f8d4d4cc3931212a80f22494"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structroute.html#a1dd2a537f8d4d4cc3931212a80f22494">reached_destinations_count</a></td></tr> +<tr class="separator:a1dd2a537f8d4d4cc3931212a80f22494"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abfd6a4d81afe836eb189123b7914c68c"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structroute__info.html">route_info</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structroute.html#abfd6a4d81afe836eb189123b7914c68c">current_dst</a></td></tr> +<tr class="separator:abfd6a4d81afe836eb189123b7914c68c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a87641aa05073f2c20434369aa6c42e4c"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structroute__graph.html">route_graph</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structroute.html#a87641aa05073f2c20434369aa6c42e4c">graph</a></td></tr> +<tr class="separator:a87641aa05073f2c20434369aa6c42e4c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac33676f3d043413871e30bdbbcaeb029"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structroute__path.html">route_path</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structroute.html#ac33676f3d043413871e30bdbbcaeb029">path2</a></td></tr> +<tr class="separator:ac33676f3d043413871e30bdbbcaeb029"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a686aed81edfa79c27f3fc3de933a71d6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a686aed81edfa79c27f3fc3de933a71d6"></a> +struct <a class="el" href="structmap.html">map</a> * </td><td class="memItemRight" valign="bottom"><b>map</b></td></tr> +<tr class="separator:a686aed81edfa79c27f3fc3de933a71d6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8227252962feb3782d426da1d36b9573"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8227252962feb3782d426da1d36b9573"></a> +struct <a class="el" href="structmap.html">map</a> * </td><td class="memItemRight" valign="bottom"><b>graph_map</b></td></tr> +<tr class="separator:a8227252962feb3782d426da1d36b9573"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a51ed64bd569e95af31122e8ba0f7d9b1"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcallback.html">callback</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structroute.html#a51ed64bd569e95af31122e8ba0f7d9b1">route_graph_done_cb</a></td></tr> +<tr class="separator:a51ed64bd569e95af31122e8ba0f7d9b1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a356b5263ab44b195e2210a8b9bc65215"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcallback.html">callback</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structroute.html#a356b5263ab44b195e2210a8b9bc65215">route_graph_flood_done_cb</a></td></tr> +<tr class="separator:a356b5263ab44b195e2210a8b9bc65215"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5f456183d2312e96607cfab6239e7818"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcallback__list.html">callback_list</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structroute.html#a5f456183d2312e96607cfab6239e7818">cbl2</a></td></tr> +<tr class="separator:a5f456183d2312e96607cfab6239e7818"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa1edf18cdace11ebf4cc1605181d0eac"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structroute.html#aa1edf18cdace11ebf4cc1605181d0eac">destination_distance</a></td></tr> +<tr class="separator:aa1edf18cdace11ebf4cc1605181d0eac"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0bdbb423178c93cc7d2930ae04804983"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structvehicleprofile.html">vehicleprofile</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structroute.html#a0bdbb423178c93cc7d2930ae04804983">vehicleprofile</a></td></tr> +<tr class="separator:a0bdbb423178c93cc7d2930ae04804983"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af1a6e165ddec06052971e17c4bff0f68"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structroute.html#af1a6e165ddec06052971e17c4bff0f68">route_status</a></td></tr> +<tr class="separator:af1a6e165ddec06052971e17c4bff0f68"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adeaa626b19e8e36e268e596d0622d271"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structroute.html#adeaa626b19e8e36e268e596d0622d271">link_path</a></td></tr> +<tr class="separator:adeaa626b19e8e36e268e596d0622d271"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac208fc292ca963c4755179702c36e0c5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac208fc292ca963c4755179702c36e0c5"></a> +struct <a class="el" href="structpcoord.html">pcoord</a> </td><td class="memItemRight" valign="bottom"><b>pc</b></td></tr> +<tr class="separator:ac208fc292ca963c4755179702c36e0c5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9f4f8a0d9a56d4f73ef201cc4d68d55a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f4f8a0d9a56d4f73ef201cc4d68d55a"></a> +struct <a class="el" href="structvehicle.html">vehicle</a> * </td><td class="memItemRight" valign="bottom"><b>v</b></td></tr> +<tr class="separator:a9f4f8a0d9a56d4f73ef201cc4d68d55a"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>A complete route. </p> +<p>This struct holds all information about a route. </p> +</div><h2 class="groupheader">Field Documentation</h2> +<a class="anchor" id="a5f456183d2312e96607cfab6239e7818"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structcallback__list.html">callback_list</a>* route::cbl2</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Callback list to call when route changes </p> + +<p>Referenced by <a class="el" href="route_8h.html#acd539fe25796de904f57342b14dde071">route_dup()</a>.</p> + +</div> +</div> +<a class="anchor" id="abfd6a4d81afe836eb189123b7914c68c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structroute__info.html">route_info</a>* route::current_dst</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Current destination </p> + +</div> +</div> +<a class="anchor" id="aa1edf18cdace11ebf4cc1605181d0eac"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int route::destination_distance</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Distance to the destination at which the destination is considered "reached" </p> + +<p>Referenced by <a class="el" href="route_8h.html#acd539fe25796de904f57342b14dde071">route_dup()</a>.</p> + +</div> +</div> +<a class="anchor" id="a19d1594ee18b1887a8904915d319f089"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="struct__GList.html">GList</a>* route::destinations</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Destinations of the route </p> + +</div> +</div> +<a class="anchor" id="a87641aa05073f2c20434369aa6c42e4c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structroute__graph.html">route_graph</a>* route::graph</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Pointer to the route graph </p> + +<p>Referenced by <a class="el" href="route_8h.html#a1e07a0865bb864ab1ad0f505810e47e0">route_has_graph()</a>.</p> + +</div> +</div> +<a class="anchor" id="adeaa626b19e8e36e268e596d0622d271"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int route::link_path</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Link paths over multiple waypoints together </p> + +</div> +</div> +<a class="anchor" id="abb33b9282cba092fcc246c2401511f3d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NAVIT_OBJECT struct <a class="el" href="structmapset.html">mapset</a>* route::ms</td> + </tr> + </table> +</div><div class="memdoc"> +<p>The mapset this route is built upon </p> + +<p>Referenced by <a class="el" href="route_8h.html#acd539fe25796de904f57342b14dde071">route_dup()</a>.</p> + +</div> +</div> +<a class="anchor" id="ac33676f3d043413871e30bdbbcaeb029"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structroute__path.html">route_path</a>* route::path2</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Pointer to the route path </p> + +</div> +</div> +<a class="anchor" id="a052d5b83336fae1672ce9514d386fb9e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structroute__info.html">route_info</a>* route::pos</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Current position within this route </p> + +</div> +</div> +<a class="anchor" id="a1dd2a537f8d4d4cc3931212a80f22494"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int route::reached_destinations_count</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Used as base to calculate waypoint numbers </p> + +</div> +</div> +<a class="anchor" id="a51ed64bd569e95af31122e8ba0f7d9b1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structcallback.html">callback</a>* route::route_graph_done_cb</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Callback when route graph is done </p> + +</div> +</div> +<a class="anchor" id="a356b5263ab44b195e2210a8b9bc65215"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structcallback.html">callback</a>* route::route_graph_flood_done_cb</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Callback when route graph flooding is done </p> + +</div> +</div> +<a class="anchor" id="af1a6e165ddec06052971e17c4bff0f68"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int route::route_status</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Route Status </p> + +</div> +</div> +<a class="anchor" id="a0bdbb423178c93cc7d2930ae04804983"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structvehicleprofile.html">vehicleprofile</a>* route::vehicleprofile</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Routing preferences </p> + +<p>Referenced by <a class="el" href="route_8h.html#acd539fe25796de904f57342b14dde071">route_dup()</a>.</p> + +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="route_8c.html">route.c</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="structroute.html">route</a></li> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> + </ul> +</div> +</body> +</html> |