756 lines
28 KiB
HTML
756 lines
28 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="fr">
|
|
<head>
|
|
<!-- Generated by javadoc (11.0.6) on Mon Mar 16 10:16:49 CET 2020 -->
|
|
<title>Path</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="dc.created" content="2020-03-16">
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="Path";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":9,"i1":41,"i2":41,"i3":10,"i4":10,"i5":10,"i6":42,"i7":42,"i8":10,"i9":42,"i10":10,"i11":42,"i12":10};
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../../";
|
|
var useModuleDirectories = true;
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<header role="banner">
|
|
<nav role="navigation">
|
|
<div class="fixedNav">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a id="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/Path.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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<ul class="navListSearch">
|
|
<li><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</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>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
</div>
|
|
<div class="navPadding"> </div>
|
|
<script type="text/javascript"><!--
|
|
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
|
//-->
|
|
</script>
|
|
</nav>
|
|
</header>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<main role="main">
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.insa.graphs.model</a></div>
|
|
<h2 title="Class Path" class="title">Class Path</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>org.insa.graphs.model.Path</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">Path</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block"><p>
|
|
Class representing a path between nodes in a graph.
|
|
</p>
|
|
|
|
<p>
|
|
A path is represented as a list of <a href="Arc.html" title="class in org.insa.graphs.model"><code>Arc</code></a> with an origin and not a list
|
|
of <a href="Node.html" title="class in org.insa.graphs.model"><code>Node</code></a> due to the multi-graph nature (multiple arcs between two
|
|
nodes) of the considered graphs.
|
|
</p></div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="field.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Field</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>private java.util.List<<a href="Arc.html" title="class in org.insa.graphs.model">Arc</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#arcs">arcs</a></span></code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>private <a href="Graph.html" title="class in org.insa.graphs.model">Graph</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#graph">graph</a></span></code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>private <a href="Node.html" title="class in org.insa.graphs.model">Node</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#origin">origin</a></span></code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.insa.graphs.model.Graph)">Path</a></span>​(<a href="Graph.html" title="class in org.insa.graphs.model">Graph</a> graph)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create an empty path corresponding to the given graph.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.insa.graphs.model.Graph,java.util.List)">Path</a></span>​(<a href="Graph.html" title="class in org.insa.graphs.model">Graph</a> graph,
|
|
java.util.List<<a href="Arc.html" title="class in org.insa.graphs.model">Arc</a>> arcs)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create a new path with the given list of arcs.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.insa.graphs.model.Graph,org.insa.graphs.model.Node)">Path</a></span>​(<a href="Graph.html" title="class in org.insa.graphs.model">Graph</a> graph,
|
|
<a href="Node.html" title="class in org.insa.graphs.model">Node</a> node)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create a new path containing a single node.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code>static <a href="Path.html" title="class in org.insa.graphs.model">Path</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#concatenate(org.insa.graphs.model.Path...)">concatenate</a></span>​(<a href="Path.html" title="class in org.insa.graphs.model">Path</a>... paths)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Concatenate the given paths.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>static <a href="Path.html" title="class in org.insa.graphs.model">Path</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createFastestPathFromNodes(org.insa.graphs.model.Graph,java.util.List)">createFastestPathFromNodes</a></span>​(<a href="Graph.html" title="class in org.insa.graphs.model">Graph</a> graph,
|
|
java.util.List<<a href="Node.html" title="class in org.insa.graphs.model">Node</a>> nodes)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Need to be implemented.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>static <a href="Path.html" title="class in org.insa.graphs.model">Path</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createShortestPathFromNodes(org.insa.graphs.model.Graph,java.util.List)">createShortestPathFromNodes</a></span>​(<a href="Graph.html" title="class in org.insa.graphs.model">Graph</a> graph,
|
|
java.util.List<<a href="Node.html" title="class in org.insa.graphs.model">Node</a>> nodes)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Need to be implemented.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>java.util.List<<a href="Arc.html" title="class in org.insa.graphs.model">Arc</a>></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArcs()">getArcs</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code><a href="Node.html" title="class in org.insa.graphs.model">Node</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDestination()">getDestination</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code><a href="Graph.html" title="class in org.insa.graphs.model">Graph</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGraph()">getGraph</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>float</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLength()">getLength</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Need to be implemented.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMinimumTravelTime()">getMinimumTravelTime</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Need to be implemented.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code><a href="Node.html" title="class in org.insa.graphs.model">Node</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrigin()">getOrigin</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTravelTime(double)">getTravelTime</a></span>​(double speed)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Need to be implemented.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmpty()">isEmpty</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Check if this path is empty (it does not contain any node).</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValid()">isValid</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Need to be implemented.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#size()">size</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the number of <b>nodes</b> in this path.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="field.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Detail</h3>
|
|
<a id="graph">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>graph</h4>
|
|
<pre>private final <a href="Graph.html" title="class in org.insa.graphs.model">Graph</a> graph</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="origin">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>origin</h4>
|
|
<pre>private final <a href="Node.html" title="class in org.insa.graphs.model">Node</a> origin</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="arcs">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>arcs</h4>
|
|
<pre>private final java.util.List<<a href="Arc.html" title="class in org.insa.graphs.model">Arc</a>> arcs</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a id="<init>(org.insa.graphs.model.Graph)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Path</h4>
|
|
<pre>public Path​(<a href="Graph.html" title="class in org.insa.graphs.model">Graph</a> graph)</pre>
|
|
<div class="block">Create an empty path corresponding to the given graph.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>graph</code> - Graph containing the path.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="<init>(org.insa.graphs.model.Graph,org.insa.graphs.model.Node)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Path</h4>
|
|
<pre>public Path​(<a href="Graph.html" title="class in org.insa.graphs.model">Graph</a> graph,
|
|
<a href="Node.html" title="class in org.insa.graphs.model">Node</a> node)</pre>
|
|
<div class="block">Create a new path containing a single node.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>graph</code> - Graph containing the path.</dd>
|
|
<dd><code>node</code> - Single node of the path.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="<init>(org.insa.graphs.model.Graph,java.util.List)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>Path</h4>
|
|
<pre>public Path​(<a href="Graph.html" title="class in org.insa.graphs.model">Graph</a> graph,
|
|
java.util.List<<a href="Arc.html" title="class in org.insa.graphs.model">Arc</a>> arcs)</pre>
|
|
<div class="block">Create a new path with the given list of arcs.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>graph</code> - Graph containing the path.</dd>
|
|
<dd><code>arcs</code> - Arcs to construct the path.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a id="createFastestPathFromNodes(org.insa.graphs.model.Graph,java.util.List)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createFastestPathFromNodes</h4>
|
|
<pre class="methodSignature">public static <a href="Path.html" title="class in org.insa.graphs.model">Path</a> createFastestPathFromNodes​(<a href="Graph.html" title="class in org.insa.graphs.model">Graph</a> graph,
|
|
java.util.List<<a href="Node.html" title="class in org.insa.graphs.model">Node</a>> nodes)
|
|
throws java.lang.IllegalArgumentException</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Need to be implemented.</div>
|
|
</div>
|
|
<div class="block">Create a new path that goes through the given list of nodes (in order),
|
|
choosing the fastest route if multiple are available.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>graph</code> - Graph containing the nodes in the list.</dd>
|
|
<dd><code>nodes</code> - List of nodes to build the path.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A path that goes through the given list of nodes.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - If the list of nodes is not valid, i.e. two
|
|
consecutive nodes in the list are not connected in the graph.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="createShortestPathFromNodes(org.insa.graphs.model.Graph,java.util.List)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createShortestPathFromNodes</h4>
|
|
<pre class="methodSignature">public static <a href="Path.html" title="class in org.insa.graphs.model">Path</a> createShortestPathFromNodes​(<a href="Graph.html" title="class in org.insa.graphs.model">Graph</a> graph,
|
|
java.util.List<<a href="Node.html" title="class in org.insa.graphs.model">Node</a>> nodes)
|
|
throws java.lang.IllegalArgumentException</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Need to be implemented.</div>
|
|
</div>
|
|
<div class="block">Create a new path that goes through the given list of nodes (in order),
|
|
choosing the shortest route if multiple are available.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>graph</code> - Graph containing the nodes in the list.</dd>
|
|
<dd><code>nodes</code> - List of nodes to build the path.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A path that goes through the given list of nodes.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - If the list of nodes is not valid, i.e. two
|
|
consecutive nodes in the list are not connected in the graph.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="concatenate(org.insa.graphs.model.Path...)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>concatenate</h4>
|
|
<pre class="methodSignature">public static <a href="Path.html" title="class in org.insa.graphs.model">Path</a> concatenate​(<a href="Path.html" title="class in org.insa.graphs.model">Path</a>... paths)
|
|
throws java.lang.IllegalArgumentException</pre>
|
|
<div class="block">Concatenate the given paths.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>paths</code> - Array of paths to concatenate.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Concatenated path.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if the paths cannot be concatenated (IDs of
|
|
map do not match, or the end of a path is not the beginning of the
|
|
next).</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getGraph()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getGraph</h4>
|
|
<pre class="methodSignature">public <a href="Graph.html" title="class in org.insa.graphs.model">Graph</a> getGraph()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Graph containing the path.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getOrigin()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getOrigin</h4>
|
|
<pre class="methodSignature">public <a href="Node.html" title="class in org.insa.graphs.model">Node</a> getOrigin()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>First node of the path.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getDestination()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDestination</h4>
|
|
<pre class="methodSignature">public <a href="Node.html" title="class in org.insa.graphs.model">Node</a> getDestination()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Last node of the path.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getArcs()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getArcs</h4>
|
|
<pre class="methodSignature">public java.util.List<<a href="Arc.html" title="class in org.insa.graphs.model">Arc</a>> getArcs()</pre>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>List of arcs in the path.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="isEmpty()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isEmpty</h4>
|
|
<pre class="methodSignature">public boolean isEmpty()</pre>
|
|
<div class="block">Check if this path is empty (it does not contain any node).</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if this path is empty, false otherwise.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="size()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>size</h4>
|
|
<pre class="methodSignature">public int size()</pre>
|
|
<div class="block">Get the number of <b>nodes</b> in this path.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Number of nodes in this path.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="isValid()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isValid</h4>
|
|
<pre class="methodSignature">public boolean isValid()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Need to be implemented.</div>
|
|
</div>
|
|
<div class="block">Check if this path is valid.
|
|
|
|
A path is valid if any of the following is true:
|
|
<ul>
|
|
<li>it is empty;</li>
|
|
<li>it contains a single node (without arcs);</li>
|
|
<li>the first arc has for origin the origin of the path and, for two
|
|
consecutive arcs, the destination of the first one is the origin of the
|
|
second one.</li>
|
|
</ul></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the path is valid, false otherwise.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getLength()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLength</h4>
|
|
<pre class="methodSignature">public float getLength()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Need to be implemented.</div>
|
|
</div>
|
|
<div class="block">Compute the length of this path (in meters).</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Total length of the path (in meters).</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getTravelTime(double)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTravelTime</h4>
|
|
<pre class="methodSignature">public double getTravelTime​(double speed)</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Need to be implemented.</div>
|
|
</div>
|
|
<div class="block">Compute the time required to travel this path if moving at the given speed.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>speed</code> - Speed to compute the travel time.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Time (in seconds) required to travel this path at the given speed (in
|
|
kilometers-per-hour).</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="getMinimumTravelTime()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getMinimumTravelTime</h4>
|
|
<pre class="methodSignature">public double getMinimumTravelTime()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Need to be implemented.</div>
|
|
</div>
|
|
<div class="block">Compute the time to travel this path if moving at the maximum allowed speed
|
|
on every arc.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Minimum travel time to travel this path (in seconds).</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a id="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/Path.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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses.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>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</body>
|
|
</html>
|