blob: 175a6ef1e30bd54352e463f1070a816772a49fad [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 Thu Oct 29 15:52:03 GMT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Edge (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="Edge (Eclipse MOSAIC Parent 20.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":9,"i3":10,"i4":9,"i5":10,"i6":10,"i7":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/Edge.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/database/route/Route.html" title="class in org.eclipse.mosaic.lib.database.route"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/mosaic/lib/database/route/Edge.html" target="_top">Frames</a></li>
<li><a href="Edge.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.database.route</div>
<h2 title="Class Edge" class="title">Class Edge</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.database.route.Edge</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Edge</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">This represents part of a <a href="../../../../../../org/eclipse/mosaic/lib/database/route/Route.html" title="class in org.eclipse.mosaic.lib.database.route"><code>Route</code></a> which contains all necessary information for
node- and edge-based traffic simulators.</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/database/route/Edge.html#Edge-org.eclipse.mosaic.lib.database.road.Connection-org.eclipse.mosaic.lib.database.road.Node-org.eclipse.mosaic.lib.database.road.Node-">Edge</a></span>(<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road">Connection</a>&nbsp;connection,
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;from,
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;to)</code>
<div class="block">Constructor for completely new connections based on an imported osm network.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#Edge-org.eclipse.mosaic.lib.database.road.Connection-java.lang.String-org.eclipse.mosaic.lib.database.road.Node-org.eclipse.mosaic.lib.database.road.Node-">Edge</a></span>(<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road">Connection</a>&nbsp;connection,
<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;id,
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;from,
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;to)</code>
<div class="block">Constructor for completely new connections based on an imported osm network with a given id.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#Edge-java.lang.String-org.eclipse.mosaic.lib.database.road.Connection-org.eclipse.mosaic.lib.database.road.Node-org.eclipse.mosaic.lib.database.road.Node-">Edge</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;id,
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road">Connection</a>&nbsp;connection,
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;from,
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;to)</code>
<div class="block">Default constructor.</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#createEdgeId-org.eclipse.mosaic.lib.database.road.Connection-org.eclipse.mosaic.lib.database.road.Node-">createEdgeId</a></span>(<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road">Connection</a>&nbsp;connection,
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;fromNode)</code>
<div class="block">Create an edge id in the compatible MOSAIC format.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road">Connection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#getConnection--">getConnection</a></span>()</code>
<div class="block">The <a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road"><code>Connection</code></a> this edge is a part from.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#getConnectionIdFromId-java.lang.String-">getConnectionIdFromId</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;edgeId)</code>
<div class="block">This parses the edge id and extracts the connection id from it.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#getFromNode--">getFromNode</a></span>()</code>
<div class="block">The <a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road"><code>Node</code></a> the edge starts on the <a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road"><code>Connection</code></a> (see <a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#getConnection--"><code>getConnection()</code></a>).</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#getFromNodeIdFromId-java.lang.String-">getFromNodeIdFromId</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;edgeId)</code>
<div class="block">This parses the edge id and extracts the id of the 'from' node from it.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#getId--">getId</a></span>()</code>
<div class="block">Generates an edge id out of the dependant data.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#getToNode--">getToNode</a></span>()</code>
<div class="block">The <a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road"><code>Node</code></a> the edge ends on the <a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road"><code>Connection</code></a> (see <a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#getConnection--"><code>getConnection()</code></a>).</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#isScenarioCompatible-java.lang.String-">isScenarioCompatible</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;edgeId)</code>
<div class="block">This checks if the given edge id follows a format compatible with the edge id format.</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="Edge-org.eclipse.mosaic.lib.database.road.Connection-java.lang.String-org.eclipse.mosaic.lib.database.road.Node-org.eclipse.mosaic.lib.database.road.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Edge</h4>
<pre>public&nbsp;Edge(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road">Connection</a>&nbsp;connection,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<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;id,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;from,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;to)</pre>
<div class="block">Constructor for completely new connections based on an imported osm network with a given id.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connection</code> - Connection</dd>
</dl>
</li>
</ul>
<a name="Edge-org.eclipse.mosaic.lib.database.road.Connection-org.eclipse.mosaic.lib.database.road.Node-org.eclipse.mosaic.lib.database.road.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Edge</h4>
<pre>public&nbsp;Edge(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road">Connection</a>&nbsp;connection,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;from,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;to)</pre>
<div class="block">Constructor for completely new connections based on an imported osm network.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connection</code> - Connection</dd>
<dd><code>from</code> - Node</dd>
<dd><code>to</code> - Node</dd>
</dl>
</li>
</ul>
<a name="Edge-java.lang.String-org.eclipse.mosaic.lib.database.road.Connection-org.eclipse.mosaic.lib.database.road.Node-org.eclipse.mosaic.lib.database.road.Node-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Edge</h4>
<pre>public&nbsp;Edge(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<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;id,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road">Connection</a>&nbsp;connection,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;from,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;to)</pre>
<div class="block">Default constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - String</dd>
<dd><code>connection</code> - Connection</dd>
<dd><code>from</code> - Node</dd>
<dd><code>to</code> - Node</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="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public&nbsp;<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;getId()</pre>
<div class="block">Generates an edge id out of the dependant data.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Id of the edge.</dd>
</dl>
</li>
</ul>
<a name="getConnection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnection</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public&nbsp;<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road">Connection</a>&nbsp;getConnection()</pre>
<div class="block">The <a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road"><code>Connection</code></a> this edge is a part from. To determine which part please have a look
at <a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#getFromNode--"><code>getFromNode()</code></a> and <a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#getToNode--"><code>getToNode()</code></a>;</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Connection of the edge.</dd>
</dl>
</li>
</ul>
<a name="getFromNode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFromNode</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public&nbsp;<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;getFromNode()</pre>
<div class="block">The <a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road"><code>Node</code></a> the edge starts on the <a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road"><code>Connection</code></a> (see <a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#getConnection--"><code>getConnection()</code></a>).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Node from the connection starts.</dd>
</dl>
</li>
</ul>
<a name="getToNode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getToNode</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public&nbsp;<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;getToNode()</pre>
<div class="block">The <a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road"><code>Node</code></a> the edge ends on the <a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road"><code>Connection</code></a> (see <a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#getConnection--"><code>getConnection()</code></a>).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>End node of the connection.</dd>
</dl>
</li>
</ul>
<a name="isScenarioCompatible-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isScenarioCompatible</h4>
<pre>public static&nbsp;boolean&nbsp;isScenarioCompatible(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<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;edgeId)</pre>
<div class="block">This checks if the given edge id follows a format compatible with the edge id format.
ATTENTION: this does NOT assure that the id actually is generated by the database but only,
that we can read the format and try to analyze the values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>edgeId</code> - Edge id to check whether it is compatible with MOSAIC format.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the scenario is compatible</dd>
</dl>
</li>
</ul>
<a name="createEdgeId-org.eclipse.mosaic.lib.database.road.Connection-org.eclipse.mosaic.lib.database.road.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createEdgeId</h4>
<pre>public static&nbsp;<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;createEdgeId(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Connection.html" title="class in org.eclipse.mosaic.lib.database.road">Connection</a>&nbsp;connection,
<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<a href="../../../../../../org/eclipse/mosaic/lib/database/road/Node.html" title="class in org.eclipse.mosaic.lib.database.road">Node</a>&nbsp;fromNode)</pre>
<div class="block">Create an edge id in the compatible MOSAIC format.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connection</code> - Id of the connection to create the first part of the edge Id.</dd>
<dd><code>fromNode</code> - Node Id to build the last part of the edge Id.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Created edge Id.</dd>
</dl>
</li>
</ul>
<a name="getConnectionIdFromId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionIdFromId</h4>
<pre>public static&nbsp;<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;getConnectionIdFromId(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<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;edgeId)</pre>
<div class="block">This parses the edge id and extracts the connection id from it.
This only works as long as the assumptions about the composed single IDs are correct and
<a href="../../../../../../org/eclipse/mosaic/lib/database/route/Edge.html#isScenarioCompatible-java.lang.String-"><code>isScenarioCompatible(java.lang.String)</code></a> is true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>edgeId</code> - Edge id from the connection Id will be extracted.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Connection id.</dd>
</dl>
</li>
</ul>
<a name="getFromNodeIdFromId-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getFromNodeIdFromId</h4>
<pre>public static&nbsp;<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;getFromNodeIdFromId(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
<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;edgeId)</pre>
<div class="block">This parses the edge id and extracts the id of the 'from' node from it.
This only works, as long as the assumptions about the composed single IDs are correct.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>edgeId</code> - Edge id from the node Id will be extracted.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>connection id</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/Edge.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/database/route/Route.html" title="class in org.eclipse.mosaic.lib.database.route"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/mosaic/lib/database/route/Edge.html" target="_top">Frames</a></li>
<li><a href="Edge.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 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p>
</body>
</html>