| <!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 Wed Mar 10 21:50:11 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CentralNavigationComponent (Eclipse MOSAIC Parent 21.0 API)</title> |
| <meta name="date" content="2021-03-10"> |
| <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="CentralNavigationComponent (Eclipse MOSAIC Parent 21.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/CentralNavigationComponent.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>Prev Class</li> |
| <li><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/INavigationModule.html" title="interface 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/CentralNavigationComponent.html" target="_top">Frames</a></li> |
| <li><a href="CentralNavigationComponent.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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="Class CentralNavigationComponent" class="title">Class CentralNavigationComponent</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.mosaic.fed.application.ambassador.navigation.CentralNavigationComponent</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">CentralNavigationComponent</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">The <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/CentralNavigationComponent.html" title="class in org.eclipse.mosaic.fed.application.ambassador.navigation"><code>CentralNavigationComponent</code></a> unites functionality concerned with |
| routing. This includes switching the routes of vehicles or calculating |
| distances / costs of routes.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/CentralNavigationComponent.html#CentralNavigationComponent-org.eclipse.mosaic.rti.api.parameters.AmbassadorParameter-org.eclipse.mosaic.fed.application.config.CApplicationAmbassador.CRoutingByType-">CentralNavigationComponent</a></span>(<a href="../../../../../../../org/eclipse/mosaic/rti/api/parameters/AmbassadorParameter.html" title="class in org.eclipse.mosaic.rti.api.parameters">AmbassadorParameter</a> ambassadorParameter, |
| <a href="../../../../../../../org/eclipse/mosaic/fed/application/config/CApplicationAmbassador.CRoutingByType.html" title="class in org.eclipse.mosaic.fed.application.config">CApplicationAmbassador.CRoutingByType</a> navigationConfiguration)</code> |
| <div class="block">Constructor for the CentralNavigationComponent.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing">CandidateRoute</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/CentralNavigationComponent.html#approximateCosts-java.util.Collection-java.lang.String-">approximateCosts</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing">CandidateRoute</a>> candidateRoutes, |
| <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> lastNodeId)</code> |
| <div class="block">Approximates the costs for all <a href="../../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing"><code>CandidateRoute</code></a>s passed to the function.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleDeparture.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleDeparture</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/CentralNavigationComponent.html#createRouteForOdInfo-long-org.eclipse.mosaic.lib.objects.mapping.OriginDestinationPair-">createRouteForOdInfo</a></span>(long time, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/objects/mapping/OriginDestinationPair.html" title="class in org.eclipse.mosaic.lib.objects.mapping">OriginDestinationPair</a> odInfo)</code> |
| <div class="block">This method tries to create a route for an <a href="../../../../../../../org/eclipse/mosaic/lib/objects/mapping/OriginDestinationPair.html" title="class in org.eclipse.mosaic.lib.objects.mapping"><code>OriginDestinationPair</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/CentralNavigationComponent.html#getRouting--">getRouting</a></span>()</code> |
| <div class="block">Provides the current routing API implementation.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/CentralNavigationComponent.html#getSourcePositionOfRoute-java.lang.String-">getSourcePositionOfRoute</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> routeId)</code> |
| <div class="block">Get the source position of a route for a specific route ID.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/CentralNavigationComponent.html#initialize-org.eclipse.mosaic.rti.api.RtiAmbassador-">initialize</a></span>(<a href="../../../../../../../org/eclipse/mosaic/rti/api/RtiAmbassador.html" title="interface in org.eclipse.mosaic.rti.api">RtiAmbassador</a> rtiAmbassador)</code> |
| <div class="block">This method initializes the <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/CentralNavigationComponent.html" title="class in org.eclipse.mosaic.fed.application.ambassador.navigation"><code>CentralNavigationComponent</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <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/CentralNavigationComponent.html#refineRoadPosition-org.eclipse.mosaic.lib.objects.road.IRoadPosition-">refineRoadPosition</a></span>(<a href="../../../../../../../org/eclipse/mosaic/lib/objects/road/IRoadPosition.html" title="interface in org.eclipse.mosaic.lib.objects.road">IRoadPosition</a> roadPosition)</code> |
| <div class="block">This method refines the road position depending on the |
| implementation of the <a href="../../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing"><code>Routing</code></a> interface this can have |
| different levels of complexity.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleRoute.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleRoute</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/CentralNavigationComponent.html#switchRoute-org.eclipse.mosaic.lib.objects.vehicle.VehicleData-org.eclipse.mosaic.lib.routing.CandidateRoute-org.eclipse.mosaic.lib.objects.vehicle.VehicleRoute-long-">switchRoute</a></span>(<a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleData.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleData</a> vehicleData, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing">CandidateRoute</a> rawRoute, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleRoute.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleRoute</a> currentRoute, |
| long time)</code> |
| <div class="block">Switch to a specific route.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="CentralNavigationComponent-org.eclipse.mosaic.rti.api.parameters.AmbassadorParameter-org.eclipse.mosaic.fed.application.config.CApplicationAmbassador.CRoutingByType-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CentralNavigationComponent</h4> |
| <pre>public CentralNavigationComponent(<a href="../../../../../../../org/eclipse/mosaic/rti/api/parameters/AmbassadorParameter.html" title="class in org.eclipse.mosaic.rti.api.parameters">AmbassadorParameter</a> ambassadorParameter, |
| <a href="../../../../../../../org/eclipse/mosaic/fed/application/config/CApplicationAmbassador.CRoutingByType.html" title="class in org.eclipse.mosaic.fed.application.config">CApplicationAmbassador.CRoutingByType</a> navigationConfiguration)</pre> |
| <div class="block">Constructor for the CentralNavigationComponent. |
| Sets the logger and the configuration for navigation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ambassadorParameter</code> - The ApplicationAmbassadorParameter. |
| These include the parameters for the |
| CentralNavigationComponent.</dd> |
| <dd><code>navigationConfiguration</code> - The routing configuration.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="initialize-org.eclipse.mosaic.rti.api.RtiAmbassador-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>public void initialize(<a href="../../../../../../../org/eclipse/mosaic/rti/api/RtiAmbassador.html" title="interface in org.eclipse.mosaic.rti.api">RtiAmbassador</a> rtiAmbassador) |
| throws <a href="../../../../../../../org/eclipse/mosaic/rti/api/InternalFederateException.html" title="class in org.eclipse.mosaic.rti.api">InternalFederateException</a></pre> |
| <div class="block">This method initializes the <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/CentralNavigationComponent.html" title="class in org.eclipse.mosaic.fed.application.ambassador.navigation"><code>CentralNavigationComponent</code></a>. It is called |
| by the <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/ApplicationAmbassador.html" title="class in org.eclipse.mosaic.fed.application.ambassador"><code>ApplicationAmbassador</code></a>. |
| The <code>#routingApi</code> will be created and initialized and other simulators will be informed |
| using a <a href="../../../../../../../org/eclipse/mosaic/interactions/traffic/VehicleRoutesInitialization.html" title="class in org.eclipse.mosaic.interactions.traffic"><code>VehicleRoutesInitialization</code></a> interaction.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rtiAmbassador</code> - the ambassador of the run time infrastructure</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/rti/api/InternalFederateException.html" title="class in org.eclipse.mosaic.rti.api">InternalFederateException</a></code> - if the <code>#routingApi</code> couldn't be initialized or the |
| <a href="../../../../../../../org/eclipse/mosaic/interactions/traffic/VehicleRoutesInitialization.html" title="class in org.eclipse.mosaic.interactions.traffic"><code>VehicleRoutesInitialization</code></a> interaction couldn't be send to the rti</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="switchRoute-org.eclipse.mosaic.lib.objects.vehicle.VehicleData-org.eclipse.mosaic.lib.routing.CandidateRoute-org.eclipse.mosaic.lib.objects.vehicle.VehicleRoute-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>switchRoute</h4> |
| <pre>public <a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleRoute.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleRoute</a> switchRoute(<a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleData.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleData</a> vehicleData, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing">CandidateRoute</a> rawRoute, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleRoute.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleRoute</a> currentRoute, |
| long time) |
| throws <a href="../../../../../../../org/eclipse/mosaic/lib/routing/IllegalRouteException.html" title="class in org.eclipse.mosaic.lib.routing">IllegalRouteException</a></pre> |
| <div class="block">Switch to a specific route.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rawRoute</code> - A <a href="../../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing"><code>CandidateRoute</code></a>, which the vehicle might change to.</dd> |
| <dd><code>vehicleData</code> - The <a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleData.html" title="class in org.eclipse.mosaic.lib.objects.vehicle"><code>VehicleData</code></a> of the vehicle, |
| which is going to switch routes.</dd> |
| <dd><code>time</code> - Time at which the route change should happen.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/lib/routing/IllegalRouteException.html" title="class in org.eclipse.mosaic.lib.routing">IllegalRouteException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSourcePositionOfRoute-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourcePositionOfRoute</h4> |
| <pre>public <a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a> getSourcePositionOfRoute(<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> routeId)</pre> |
| <div class="block">Get the source position of a route for a specific route ID.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>routeId</code> - The id of the route, that the source position is wanted of.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo"><code>GeoPoint</code></a>-target of the given route, <code>null</code> if route doesn't exist.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRouting--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRouting</h4> |
| <pre>public <a href="../../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a> getRouting()</pre> |
| <div class="block">Provides the current routing API implementation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <a href="../../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing"><code>Routing</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createRouteForOdInfo-long-org.eclipse.mosaic.lib.objects.mapping.OriginDestinationPair-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createRouteForOdInfo</h4> |
| <pre>public <a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleDeparture.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleDeparture</a> createRouteForOdInfo(long time, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/objects/mapping/OriginDestinationPair.html" title="class in org.eclipse.mosaic.lib.objects.mapping">OriginDestinationPair</a> odInfo)</pre> |
| <div class="block">This method tries to create a route for an <a href="../../../../../../../org/eclipse/mosaic/lib/objects/mapping/OriginDestinationPair.html" title="class in org.eclipse.mosaic.lib.objects.mapping"><code>OriginDestinationPair</code></a>. |
| If the <a href="../../../../../../../org/eclipse/mosaic/lib/objects/mapping/OriginDestinationPair.html" title="class in org.eclipse.mosaic.lib.objects.mapping"><code>OriginDestinationPair</code></a> contains a valid route, that route is used for the |
| <a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleDeparture.html" title="class in org.eclipse.mosaic.lib.objects.vehicle"><code>VehicleDeparture</code></a>. Otherwise, a route will be generated and checked. |
| If that created route is valid it will be used for the <a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleDeparture.html" title="class in org.eclipse.mosaic.lib.objects.vehicle"><code>VehicleDeparture</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>time</code> - Time of propagation message</dd> |
| <dd><code>odInfo</code> - The <a href="../../../../../../../org/eclipse/mosaic/lib/objects/mapping/OriginDestinationPair.html" title="class in org.eclipse.mosaic.lib.objects.mapping"><code>OriginDestinationPair</code></a>, that a route should be created for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleDeparture.html" title="class in org.eclipse.mosaic.lib.objects.vehicle"><code>VehicleDeparture</code></a> if a valid route was found, otherwise <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="refineRoadPosition-org.eclipse.mosaic.lib.objects.road.IRoadPosition-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refineRoadPosition</h4> |
| <pre>public <a href="../../../../../../../org/eclipse/mosaic/lib/objects/road/IRoadPosition.html" title="interface in org.eclipse.mosaic.lib.objects.road">IRoadPosition</a> refineRoadPosition(<a href="../../../../../../../org/eclipse/mosaic/lib/objects/road/IRoadPosition.html" title="interface in org.eclipse.mosaic.lib.objects.road">IRoadPosition</a> roadPosition)</pre> |
| <div class="block">This method refines the road position depending on the |
| implementation of the <a href="../../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing"><code>Routing</code></a> interface this can have |
| different levels of complexity.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>roadPosition</code> - the <a href="../../../../../../../org/eclipse/mosaic/lib/objects/road/IRoadPosition.html" title="interface in org.eclipse.mosaic.lib.objects.road"><code>IRoadPosition</code></a> to be refined</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the refined <a href="../../../../../../../org/eclipse/mosaic/lib/objects/road/IRoadPosition.html" title="interface in org.eclipse.mosaic.lib.objects.road"><code>IRoadPosition</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="approximateCosts-java.util.Collection-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>approximateCosts</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing">CandidateRoute</a>> approximateCosts(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing">CandidateRoute</a>> candidateRoutes, |
| <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> lastNodeId)</pre> |
| <div class="block">Approximates the costs for all <a href="../../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing"><code>CandidateRoute</code></a>s passed to the function.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>candidateRoutes</code> - A collection of <a href="../../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing"><code>CandidateRoute</code></a>s</dd> |
| <dd><code>lastNodeId</code> - The ID of the Node last passed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new collection of <a href="../../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing"><code>CandidateRoute</code></a>s wit approximated costs.</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/CentralNavigationComponent.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>Prev Class</li> |
| <li><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/INavigationModule.html" title="interface 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/CentralNavigationComponent.html" target="_top">Frames</a></li> |
| <li><a href="CentralNavigationComponent.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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–2021 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
