blob: b5e01a651533e00fb4bb8d6394a90591d1a83e14 [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:09 GMT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.eclipse.mosaic.interactions.vehicle (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="org.eclipse.mosaic.interactions.vehicle (Eclipse MOSAIC Parent 20.0 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/mosaic/interactions/trafficsigns/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/eclipse/mosaic/lib/coupling/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/mosaic/interactions/vehicle/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.eclipse.mosaic.interactions.vehicle</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleDistanceSensorActivation.html" title="class in org.eclipse.mosaic.interactions.vehicle">VehicleDistanceSensorActivation</a></td>
<td class="colLast">
<div class="block">This extension of <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api"><code>Interaction</code></a> is intended to be used to enable distance sensors of vehicles.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleFederateAssignment.html" title="class in org.eclipse.mosaic.interactions.vehicle">VehicleFederateAssignment</a></td>
<td class="colLast">
<div class="block">This extension of <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api"><code>Interaction</code></a> is intended for the
Phabmacs + SUMO Controlling Ambassador (PhaSCA) to notify SUMO and
Phabmacs of any vehicles that are simulated externally.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleLaneChange.html" title="class in org.eclipse.mosaic.interactions.vehicle">VehicleLaneChange</a></td>
<td class="colLast">
<div class="block">This extension of <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api"><code>Interaction</code></a> is intended to be used to
forward a request to change the lane of a simulated vehicle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleParametersChange.html" title="class in org.eclipse.mosaic.interactions.vehicle">VehicleParametersChange</a></td>
<td class="colLast">
<div class="block">This extension of <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api"><code>Interaction</code></a> stores a list of <a href="../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleParameter.html" title="class in org.eclipse.mosaic.lib.objects.vehicle"><code>VehicleParameter</code></a>s,
that shall be changed of a specific vehicle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleResume.html" title="class in org.eclipse.mosaic.interactions.vehicle">VehicleResume</a></td>
<td class="colLast">
<div class="block">This extension of <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api"><code>Interaction</code></a> is intended to be used to forward a request to resume a
stopped vehicle to the RTI.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleRouteChange.html" title="class in org.eclipse.mosaic.interactions.vehicle">VehicleRouteChange</a></td>
<td class="colLast">
<div class="block">This extension of <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api"><code>Interaction</code></a> changes the vehicles route.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleRouteRegistration.html" title="class in org.eclipse.mosaic.interactions.vehicle">VehicleRouteRegistration</a></td>
<td class="colLast">
<div class="block">Extension of <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api"><code>Interaction</code></a> that propagates information about an added route.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleSightDistanceConfiguration.html" title="class in org.eclipse.mosaic.interactions.vehicle">VehicleSightDistanceConfiguration</a></td>
<td class="colLast">
<div class="block">This extension of <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api"><code>Interaction</code></a> informs about a vehicles' sight distance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleSlowDown.html" title="class in org.eclipse.mosaic.interactions.vehicle">VehicleSlowDown</a></td>
<td class="colLast">
<div class="block">This extension of <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api"><code>Interaction</code></a> is intended to be used to
forward a request to reduce the speed of a simulated vehicle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleSpeedChange.html" title="class in org.eclipse.mosaic.interactions.vehicle">VehicleSpeedChange</a></td>
<td class="colLast">
<div class="block">This represents a 'change of speed' instruction to the used traffic simulator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleStop.html" title="class in org.eclipse.mosaic.interactions.vehicle">VehicleStop</a></td>
<td class="colLast">
<div class="block">This extension of <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api"><code>Interaction</code></a> is intended to be used to forward a request to stop a
vehicle to the RTI.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleDistanceSensorActivation.DistanceSensors.html" title="enum in org.eclipse.mosaic.interactions.vehicle">VehicleDistanceSensorActivation.DistanceSensors</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleLaneChange.VehicleLaneChangeMode.html" title="enum in org.eclipse.mosaic.interactions.vehicle">VehicleLaneChange.VehicleLaneChangeMode</a></td>
<td class="colLast">
<div class="block">This mode tells what is the target lane from the current lane of the vehicle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleSpeedChange.VehicleSpeedChangeType.html" title="enum in org.eclipse.mosaic.interactions.vehicle">VehicleSpeedChange.VehicleSpeedChangeType</a></td>
<td class="colLast">
<div class="block">These are all available types of speed changes currently supported.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleStop.VehicleStopMode.html" title="enum in org.eclipse.mosaic.interactions.vehicle">VehicleStop.VehicleStopMode</a></td>
<td class="colLast">
<div class="block">Describes how to stop the vehicle.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/mosaic/interactions/trafficsigns/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/eclipse/mosaic/lib/coupling/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/mosaic/interactions/vehicle/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>