| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_262) on Thu Oct 29 15:52:08 GMT 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>IRoutingModule (Eclipse MOSAIC Parent 20.0 API)</title> |
| <meta name="date" content="2020-10-29"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IRoutingModule (Eclipse MOSAIC Parent 20.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/IRoutingModule.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/INavigationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.navigation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/NavigationModule.html" title="class in org.eclipse.mosaic.fed.application.ambassador.navigation"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/eclipse/mosaic/fed/application/ambassador/navigation/IRoutingModule.html" target="_top">Frames</a></li> |
| <li><a href="IRoutingModule.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.mosaic.fed.application.ambassador.navigation</div> |
| <h2 title="Interface IRoutingModule" class="title">Interface IRoutingModule</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/NavigationModule.html" title="class in org.eclipse.mosaic.fed.application.ambassador.navigation">NavigationModule</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">IRoutingModule</span></pre> |
| <div class="block">Interface to access the central navigation component from road side units.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/routing/RoutingResponse.html" title="class in org.eclipse.mosaic.lib.routing">RoutingResponse</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/IRoutingModule.html#calculateRoutes-org.eclipse.mosaic.lib.routing.RoutingPosition-org.eclipse.mosaic.lib.routing.RoutingPosition-org.eclipse.mosaic.lib.routing.RoutingParameters-">calculateRoutes</a></span>(<a href="../../../../../../../org/eclipse/mosaic/lib/routing/RoutingPosition.html" title="class in org.eclipse.mosaic.lib.routing">RoutingPosition</a> sourcePosition, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/routing/RoutingPosition.html" title="class in org.eclipse.mosaic.lib.routing">RoutingPosition</a> targetPosition, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/routing/RoutingParameters.html" title="class in org.eclipse.mosaic.lib.routing">RoutingParameters</a> routingParameters)</code> |
| <div class="block">Calculates one or more routes from the position of the vehicle to the given target location.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/objects/road/INode.html" title="interface in org.eclipse.mosaic.lib.objects.road">INode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/IRoutingModule.html#getClosestNode-org.eclipse.mosaic.lib.geo.GeoPoint-">getClosestNode</a></span>(<a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a> geoPoint)</code> |
| <div class="block">Returns the node object, which is closest to the given <a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo"><code>GeoPoint</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/objects/road/IRoadPosition.html" title="interface in org.eclipse.mosaic.lib.objects.road">IRoadPosition</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/IRoutingModule.html#getClosestRoadPosition-org.eclipse.mosaic.lib.geo.GeoPoint-">getClosestRoadPosition</a></span>(<a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a> geoPoint)</code> |
| <div class="block">Returns the road position, which is closest to the given <a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo"><code>GeoPoint</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/objects/road/INode.html" title="interface in org.eclipse.mosaic.lib.objects.road">INode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/IRoutingModule.html#getNode-java.lang.String-">getNode</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nodeId)</code> |
| <div class="block">Returns the node object identified by the given nodeId.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="calculateRoutes-org.eclipse.mosaic.lib.routing.RoutingPosition-org.eclipse.mosaic.lib.routing.RoutingPosition-org.eclipse.mosaic.lib.routing.RoutingParameters-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>calculateRoutes</h4> |
| <pre><a href="../../../../../../../org/eclipse/mosaic/lib/routing/RoutingResponse.html" title="class in org.eclipse.mosaic.lib.routing">RoutingResponse</a> calculateRoutes(<a href="../../../../../../../org/eclipse/mosaic/lib/routing/RoutingPosition.html" title="class in org.eclipse.mosaic.lib.routing">RoutingPosition</a> sourcePosition, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/routing/RoutingPosition.html" title="class in org.eclipse.mosaic.lib.routing">RoutingPosition</a> targetPosition, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/routing/RoutingParameters.html" title="class in org.eclipse.mosaic.lib.routing">RoutingParameters</a> routingParameters)</pre> |
| <div class="block">Calculates one or more routes from the position of the vehicle to the given target location.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sourcePosition</code> - The source position of the required route.</dd> |
| <dd><code>targetPosition</code> - The target position of the required route.</dd> |
| <dd><code>routingParameters</code> - Properties defining the way routes are calculated (e.g. number of routes, weighting).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The response including a set of routes towards the target.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNode-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNode</h4> |
| <pre><a href="../../../../../../../org/eclipse/mosaic/lib/objects/road/INode.html" title="interface in org.eclipse.mosaic.lib.objects.road">INode</a> getNode(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nodeId)</pre> |
| <div class="block">Returns the node object identified by the given nodeId.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeId</code> - The id of the requested node.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The node object identified by the given nodeId.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClosestNode-org.eclipse.mosaic.lib.geo.GeoPoint-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClosestNode</h4> |
| <pre><a href="../../../../../../../org/eclipse/mosaic/lib/objects/road/INode.html" title="interface in org.eclipse.mosaic.lib.objects.road">INode</a> getClosestNode(<a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a> geoPoint)</pre> |
| <div class="block">Returns the node object, which is closest to the given <a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo"><code>GeoPoint</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>geoPoint</code> - The geographical location to search a node for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The node object, which is closest to the given location.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClosestRoadPosition-org.eclipse.mosaic.lib.geo.GeoPoint-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getClosestRoadPosition</h4> |
| <pre><a href="../../../../../../../org/eclipse/mosaic/lib/objects/road/IRoadPosition.html" title="interface in org.eclipse.mosaic.lib.objects.road">IRoadPosition</a> getClosestRoadPosition(<a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a> geoPoint)</pre> |
| <div class="block">Returns the road position, which is closest to the given <a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo"><code>GeoPoint</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>geoPoint</code> - The geographical location to search a road position for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The road position, which is closest to the given location.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/IRoutingModule.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/INavigationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.navigation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/NavigationModule.html" title="class in org.eclipse.mosaic.fed.application.ambassador.navigation"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/eclipse/mosaic/fed/application/ambassador/navigation/IRoutingModule.html" target="_top">Frames</a></li> |
| <li><a href="IRoutingModule.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2020 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
