Google Git
Sign in
eclipse / gerrit / www.eclipse.org / mosaic / 217d1a3f17a8391a16675cbcf59004b3c6a76080 / . / java_docs / org / eclipse / mosaic / lib / routing / database / DatabaseRouting.html
blob: 327697fa9dd46aff910676e79e12076ef0d97b40 [file] [log] [blame]
<!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>DatabaseRouting (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="DatabaseRouting (Eclipse MOSAIC Parent 21.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":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/DatabaseRouting.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&nbsp;Class</li>
<li><a href="../../../../../../org/eclipse/mosaic/lib/routing/database/LazyLoadingConnection.html" title="class in org.eclipse.mosaic.lib.routing.database"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/mosaic/lib/routing/database/DatabaseRouting.html" target="_top">Frames</a></li>
<li><a href="DatabaseRouting.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.lib.routing.database</div>
<h2 title="Class DatabaseRouting" class="title">Class DatabaseRouting</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.lib.routing.database.DatabaseRouting</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">DatabaseRouting</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>
implements <a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a></pre>
<div class="block">An 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 which provides access to routing functions
based on data of the scenario-database.</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">&nbsp;</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/lib/routing/database/DatabaseRouting.html#DatabaseRouting--">DatabaseRouting</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/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/lib/routing/database/DatabaseRouting.html#approximateCostsForCandidateRoute-org.eclipse.mosaic.lib.routing.CandidateRoute-java.lang.String-">approximateCostsForCandidateRoute</a></span>(<a href="../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing">CandidateRoute</a>&nbsp;route,
<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>&nbsp;lastNodeId)</code>
<div class="block">Approximates the costs of a <a href="../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing"><code>CandidateRoute</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<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/lib/routing/database/DatabaseRouting.html#createRouteForRTI-org.eclipse.mosaic.lib.routing.CandidateRoute-">createRouteForRTI</a></span>(<a href="../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing">CandidateRoute</a>&nbsp;candidateRoute)</code>
<div class="block">Build a new route out of a list with node ID's.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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/lib/routing/database/DatabaseRouting.html#findClosestNode-org.eclipse.mosaic.lib.geo.GeoPoint-">findClosestNode</a></span>(<a href="../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a>&nbsp;point)</code>
<div class="block">Searches for the closest node to .</div>
</td>
</tr>
<tr id="i3" 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/lib/routing/database/DatabaseRouting.html#findClosestRoadPosition-org.eclipse.mosaic.lib.geo.GeoPoint-">findClosestRoadPosition</a></span>(<a href="../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a>&nbsp;location)</code>
<div class="block">Searches for the closest edge to the geo location.</div>
</td>
</tr>
<tr id="i4" 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/lib/routing/database/DatabaseRouting.html#findRoutes-org.eclipse.mosaic.lib.routing.RoutingRequest-">findRoutes</a></span>(<a href="../../../../../../org/eclipse/mosaic/lib/routing/RoutingRequest.html" title="class in org.eclipse.mosaic.lib.routing">RoutingRequest</a>&nbsp;routingRequest)</code>
<div class="block">This method finds alternative routes including the "best" route in regards to the given cost function.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/lib/objects/road/IConnection.html" title="interface in org.eclipse.mosaic.lib.objects.road">IConnection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/routing/database/DatabaseRouting.html#getConnection-java.lang.String-">getConnection</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>&nbsp;nodeId)</code>
<div class="block">Getter for the connection by given Id.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/routing/database/DatabaseRouting.html#getMaxSpeedOfConnection-java.lang.String-">getMaxSpeedOfConnection</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>&nbsp;scenarioDatabaseConnectionId)</code>
<div class="block">This will return the speed limit of a connection given by its ID.</div>
</td>
</tr>
<tr id="i7" 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/lib/routing/database/DatabaseRouting.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>&nbsp;nodeId)</code>
<div class="block">Getter for the node by given Id.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleRoute.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleRoute</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/routing/database/DatabaseRouting.html#getRoutesFromDatabaseForMessage--">getRoutesFromDatabaseForMessage</a></span>()</code>
<div class="block">This will return a list of all known routes which are stored in the
database in a message friendly way.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/lib/database/Database.html" title="class in org.eclipse.mosaic.lib.database">Database</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/routing/database/DatabaseRouting.html#getScenarioDatabase--">getScenarioDatabase</a></span>()</code>
<div class="block">Provides the <a href="../../../../../../org/eclipse/mosaic/lib/database/Database.html" title="class in org.eclipse.mosaic.lib.database"><code>Database</code></a> of the simulation scenario.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/routing/database/DatabaseRouting.html#initialize-org.eclipse.mosaic.lib.routing.config.CRouting-java.io.File-">initialize</a></span>(<a href="../../../../../../org/eclipse/mosaic/lib/routing/config/CRouting.html" title="class in org.eclipse.mosaic.lib.routing.config">CRouting</a>&nbsp;configuration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;baseDirectory)</code>
<div class="block">Initializes the connection to the belonging database.</div>
</td>
</tr>
<tr id="i11" 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/lib/routing/database/DatabaseRouting.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>&nbsp;roadPosition)</code>
<div class="block">This method refines the road position while obtaining the missing information from the database.</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&nbsp;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="DatabaseRouting--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DatabaseRouting</h4>
<pre>public&nbsp;DatabaseRouting()</pre>
</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.lib.routing.config.CRouting-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre>public&nbsp;void&nbsp;initialize(<a href="../../../../../../org/eclipse/mosaic/lib/routing/config/CRouting.html" title="class in org.eclipse.mosaic.lib.routing.config">CRouting</a>&nbsp;configuration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;baseDirectory)
throws <a href="../../../../../../org/eclipse/mosaic/rti/api/InternalFederateException.html" title="class in org.eclipse.mosaic.rti.api">InternalFederateException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#initialize-org.eclipse.mosaic.lib.routing.config.CRouting-java.io.File-">Routing</a></code></span></div>
<div class="block">Initializes the connection to the belonging database.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#initialize-org.eclipse.mosaic.lib.routing.config.CRouting-java.io.File-">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a></code></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></dd>
</dl>
</li>
</ul>
<a name="getRoutesFromDatabaseForMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoutesFromDatabaseForMessage</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleRoute.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleRoute</a>&gt;&nbsp;getRoutesFromDatabaseForMessage()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#getRoutesFromDatabaseForMessage--">Routing</a></code></span></div>
<div class="block">This will return a list of all known routes which are stored in the
database in a message friendly way.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#getRoutesFromDatabaseForMessage--">getRoutesFromDatabaseForMessage</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>HashMap<routeId, Route></dd>
</dl>
</li>
</ul>
<a name="getMaxSpeedOfConnection-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxSpeedOfConnection</h4>
<pre>public&nbsp;double&nbsp;getMaxSpeedOfConnection(<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>&nbsp;scenarioDatabaseConnectionId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#getMaxSpeedOfConnection-java.lang.String-">Routing</a></code></span></div>
<div class="block">This will return the speed limit of a connection given by its ID.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#getMaxSpeedOfConnection-java.lang.String-">getMaxSpeedOfConnection</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Maximum speed of a given connection.</dd>
</dl>
</li>
</ul>
<a name="getNode-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNode</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/mosaic/lib/objects/road/INode.html" title="interface in org.eclipse.mosaic.lib.objects.road">INode</a>&nbsp;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>&nbsp;nodeId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#getNode-java.lang.String-">Routing</a></code></span></div>
<div class="block">Getter for the node by given Id.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#getNode-java.lang.String-">getNode</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a></code></dd>
<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="getConnection-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnection</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/mosaic/lib/objects/road/IConnection.html" title="interface in org.eclipse.mosaic.lib.objects.road">IConnection</a>&nbsp;getConnection(<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>&nbsp;nodeId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#getConnection-java.lang.String-">Routing</a></code></span></div>
<div class="block">Getter for the connection by given Id.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#getConnection-java.lang.String-">getConnection</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nodeId</code> - the id of the requested connection.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the connection object identified by the given nodeId.</dd>
</dl>
</li>
</ul>
<a name="findRoutes-org.eclipse.mosaic.lib.routing.RoutingRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findRoutes</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/mosaic/lib/routing/RoutingResponse.html" title="class in org.eclipse.mosaic.lib.routing">RoutingResponse</a>&nbsp;findRoutes(<a href="../../../../../../org/eclipse/mosaic/lib/routing/RoutingRequest.html" title="class in org.eclipse.mosaic.lib.routing">RoutingRequest</a>&nbsp;routingRequest)</pre>
<div class="block">This method finds alternative routes including the "best" route in regards to the given cost function.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#findRoutes-org.eclipse.mosaic.lib.routing.RoutingRequest-">findRoutes</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>routingRequest</code> - Information for a routing request.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response to the routing request.</dd>
</dl>
</li>
</ul>
<a name="createRouteForRTI-org.eclipse.mosaic.lib.routing.CandidateRoute-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createRouteForRTI</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleRoute.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleRoute</a>&nbsp;createRouteForRTI(<a href="../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing">CandidateRoute</a>&nbsp;candidateRoute)
throws <a href="../../../../../../org/eclipse/mosaic/lib/routing/IllegalRouteException.html" title="class in org.eclipse.mosaic.lib.routing">IllegalRouteException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#createRouteForRTI-org.eclipse.mosaic.lib.routing.CandidateRoute-">Routing</a></code></span></div>
<div class="block">Build a new route out of a list with node ID's. The route gets a new ID
and can be stored in the database.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#createRouteForRTI-org.eclipse.mosaic.lib.routing.CandidateRoute-">createRouteForRTI</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>simplified version of the route</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="refineRoadPosition-org.eclipse.mosaic.lib.objects.road.IRoadPosition-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refineRoadPosition</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/mosaic/lib/objects/road/IRoadPosition.html" title="interface in org.eclipse.mosaic.lib.objects.road">IRoadPosition</a>&nbsp;refineRoadPosition(<a href="../../../../../../org/eclipse/mosaic/lib/objects/road/IRoadPosition.html" title="interface in org.eclipse.mosaic.lib.objects.road">IRoadPosition</a>&nbsp;roadPosition)</pre>
<div class="block">This method refines the road position while obtaining the missing information from the database.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#refineRoadPosition-org.eclipse.mosaic.lib.objects.road.IRoadPosition-">refineRoadPosition</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>roadPosition</code> - <a href="../../../../../../org/eclipse/mosaic/lib/objects/road/IRoadPosition.html" title="interface in org.eclipse.mosaic.lib.objects.road"><code>IRoadPosition</code></a> containing position information such as upcoming and previous node Ids.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The refined road position as<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="approximateCostsForCandidateRoute-org.eclipse.mosaic.lib.routing.CandidateRoute-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>approximateCostsForCandidateRoute</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing">CandidateRoute</a>&nbsp;approximateCostsForCandidateRoute(<a href="../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing">CandidateRoute</a>&nbsp;route,
<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>&nbsp;lastNodeId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#approximateCostsForCandidateRoute-org.eclipse.mosaic.lib.routing.CandidateRoute-java.lang.String-">Routing</a></code></span></div>
<div class="block">Approximates the costs of a <a href="../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing"><code>CandidateRoute</code></a>. Pass a <a href="../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing"><code>CandidateRoute</code></a>
and the ID of the last Node the vehicle passed on to the method and it will return a new
Candidate route with the approximated values in its "length" and "time" field.
The method approximates by calculating distance and time between the candidate route's first intersection
and last intersection. The calculation will be done on the fly and might thus have impact
on overall performance of a simulation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#approximateCostsForCandidateRoute-org.eclipse.mosaic.lib.routing.CandidateRoute-java.lang.String-">approximateCostsForCandidateRoute</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>route</code> - CandidateRoute to be cost-approximated</dd>
<dd><code>lastNodeId</code> - ID of last passed node</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="../../../../../../org/eclipse/mosaic/lib/routing/CandidateRoute.html" title="class in org.eclipse.mosaic.lib.routing"><code>CandidateRoute</code></a></dd>
</dl>
</li>
</ul>
<a name="findClosestRoadPosition-org.eclipse.mosaic.lib.geo.GeoPoint-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findClosestRoadPosition</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/mosaic/lib/objects/road/IRoadPosition.html" title="interface in org.eclipse.mosaic.lib.objects.road">IRoadPosition</a>&nbsp;findClosestRoadPosition(<a href="../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a>&nbsp;location)</pre>
<div class="block">Searches for the closest edge to the geo location.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#findClosestRoadPosition-org.eclipse.mosaic.lib.geo.GeoPoint-">findClosestRoadPosition</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>location</code> - The closest road position to the given location.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Closest edge to the given location.</dd>
</dl>
</li>
</ul>
<a name="findClosestNode-org.eclipse.mosaic.lib.geo.GeoPoint-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findClosestNode</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/mosaic/lib/objects/road/INode.html" title="interface in org.eclipse.mosaic.lib.objects.road">INode</a>&nbsp;findClosestNode(<a href="../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a>&nbsp;point)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#findClosestNode-org.eclipse.mosaic.lib.geo.GeoPoint-">Routing</a></code></span></div>
<div class="block">Searches for the closest node to .</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html#findClosestNode-org.eclipse.mosaic.lib.geo.GeoPoint-">findClosestNode</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/mosaic/lib/routing/Routing.html" title="interface in org.eclipse.mosaic.lib.routing">Routing</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>point</code> - The closest node to the given location.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The closest node as <a href="../../../../../../org/eclipse/mosaic/lib/objects/road/INode.html" title="interface in org.eclipse.mosaic.lib.objects.road"><code>INode</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getScenarioDatabase--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getScenarioDatabase</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/mosaic/lib/database/Database.html" title="class in org.eclipse.mosaic.lib.database">Database</a>&nbsp;getScenarioDatabase()</pre>
<div class="block">Provides the <a href="../../../../../../org/eclipse/mosaic/lib/database/Database.html" title="class in org.eclipse.mosaic.lib.database"><code>Database</code></a> of the simulation scenario.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../../../../../../org/eclipse/mosaic/lib/database/Database.html" title="class in org.eclipse.mosaic.lib.database"><code>Database</code></a> containing all required information (nodes, ways, etc).</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/DatabaseRouting.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&nbsp;Class</li>
<li><a href="../../../../../../org/eclipse/mosaic/lib/routing/database/LazyLoadingConnection.html" title="class in org.eclipse.mosaic.lib.routing.database"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/mosaic/lib/routing/database/DatabaseRouting.html" target="_top">Frames</a></li>
<li><a href="DatabaseRouting.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2020&#x2013;2021 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p>
</body>
</html>