blob: 0417144f5ceddce0ce06d1149cc31913ea70f279 [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:08 GMT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>VehicleApplication (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="VehicleApplication (Eclipse MOSAIC Parent 20.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/VehicleApplication.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/fed/application/app/api/TrafficSignAwareApplication.html" title="interface in org.eclipse.mosaic.fed.application.app.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/mosaic/fed/application/app/api/VehicleApplication.html" target="_top">Frames</a></li>
<li><a href="VehicleApplication.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>Constr&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>Constr&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.fed.application.app.api</div>
<h2 title="Interface VehicleApplication" class="title">Interface VehicleApplication</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/Application.html" title="interface in org.eclipse.mosaic.fed.application.app.api">Application</a>, <a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventProcessor</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/ElectricVehicleApplication.html" title="interface in org.eclipse.mosaic.fed.application.app.api">ElectricVehicleApplication</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../org/eclipse/mosaic/app/tutorial/interappcommunication/AdditionalProcessingApp.html" title="class in org.eclipse.mosaic.app.tutorial.interappcommunication">AdditionalProcessingApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/cam/CamSendingApp.html" title="class in org.eclipse.mosaic.app.tutorial.cam">CamSendingApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/EventSendingApp.html" title="class in org.eclipse.mosaic.app.tutorial">EventSendingApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/interappcommunication/InterconnectApp.html" title="class in org.eclipse.mosaic.app.tutorial.interappcommunication">InterconnectApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/interunitcommunication/MosaicInteractionHandlingApp.html" title="class in org.eclipse.mosaic.app.tutorial.interunitcommunication">MosaicInteractionHandlingApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/interappcommunication/NotProcessingApp.html" title="class in org.eclipse.mosaic.app.tutorial.interappcommunication">NotProcessingApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/vehicle/OnVehicleUpdatedApp.html" title="class in org.eclipse.mosaic.app.tutorial.vehicle">OnVehicleUpdatedApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/SlowDownApp.html" title="class in org.eclipse.mosaic.app.tutorial">SlowDownApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/traci/SumoTraciInteractionApp.html" title="class in org.eclipse.mosaic.app.tutorial.traci">SumoTraciInteractionApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/cam/UserTaggedValueReadingApp.html" title="class in org.eclipse.mosaic.app.tutorial.cam">UserTaggedValueReadingApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/WeatherWarningApp.html" title="class in org.eclipse.mosaic.app.tutorial">WeatherWarningApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/WeatherWarningAppCell.html" title="class in org.eclipse.mosaic.app.tutorial">WeatherWarningAppCell</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">VehicleApplication</span>
extends <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/Application.html" title="interface in org.eclipse.mosaic.fed.application.app.api">Application</a></pre>
<div class="block">All applications on vehicles that should be informed about the vehicles movements should implement this interface.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/VehicleApplication.html#onVehicleUpdated-org.eclipse.mosaic.lib.objects.vehicle.VehicleData-org.eclipse.mosaic.lib.objects.vehicle.VehicleData-">onVehicleUpdated</a></span>(<a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleData.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleData</a>&nbsp;previousVehicleData,
<a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleData.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleData</a>&nbsp;updatedVehicleData)</code>
<div class="block">Is called when ever the vehicle has moved.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.fed.application.app.api.Application">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.mosaic.fed.application.app.api.<a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/Application.html" title="interface in org.eclipse.mosaic.fed.application.app.api">Application</a></h3>
<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/Application.html#onShutdown--">onShutdown</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/Application.html#onStartup--">onStartup</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.lib.util.scheduling.EventProcessor">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.mosaic.lib.util.scheduling.<a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventProcessor</a></h3>
<code><a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html#canProcessEvent--">canProcessEvent</a>, <a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html#processEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">processEvent</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="onVehicleUpdated-org.eclipse.mosaic.lib.objects.vehicle.VehicleData-org.eclipse.mosaic.lib.objects.vehicle.VehicleData-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onVehicleUpdated</h4>
<pre>void&nbsp;onVehicleUpdated(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
<a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleData.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleData</a>&nbsp;previousVehicleData,
<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/objects/vehicle/VehicleData.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleData</a>&nbsp;updatedVehicleData)</pre>
<div class="block">Is called when ever the vehicle has moved. That is, if the <a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleData.html" title="class in org.eclipse.mosaic.lib.objects.vehicle"><code>VehicleData</code></a> of the unit
has been updated.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>previousVehicleData</code> - the previous state of the vehicle</dd>
<dd><code>updatedVehicleData</code> - the updated state of the vehicle</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/VehicleApplication.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/fed/application/app/api/TrafficSignAwareApplication.html" title="interface in org.eclipse.mosaic.fed.application.app.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/mosaic/fed/application/app/api/VehicleApplication.html" target="_top">Frames</a></li>
<li><a href="VehicleApplication.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>Constr&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>Constr&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>