Google Git
Sign in
eclipse / gerrit / www.eclipse.org / mosaic / 217d1a3f17a8391a16675cbcf59004b3c6a76080 / . / java_docs / org / eclipse / mosaic / fed / application / app / api / os / VehicleOperatingSystem.html
blob: a49fd72a0f90918ea5e8bbc0d36056108fddc5f3 [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>VehicleOperatingSystem (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="VehicleOperatingSystem (Eclipse MOSAIC Parent 21.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":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/VehicleOperatingSystem.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/os/TrafficManagementCenterOperatingSystem.ChangeLaneState.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os"><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/os/VehicleOperatingSystem.html" target="_top">Frames</a></li>
<li><a href="VehicleOperatingSystem.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.os</div>
<h2 title="Interface VehicleOperatingSystem" class="title">Interface VehicleOperatingSystem</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/ambassador/simulation/communication/CommunicationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CommunicationModuleOwner</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/INavigationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.navigation">INavigationModuleOwner</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/ElectricVehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">ElectricVehicleOperatingSystem</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/ElectricVehicleUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">ElectricVehicleUnit</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">VehicleUnit</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">VehicleOperatingSystem</span>
extends <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/INavigationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.navigation">INavigationModuleOwner</a></pre>
<div class="block">This interface extends the basic <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os"><code>OperatingSystem</code></a> and
is implemented by the <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation"><code>AbstractSimulationUnit</code></a>
<code>org.eclipse.mosaic.fed.application.ambassador.simulation.VehicleUni</code>.</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/os/VehicleOperatingSystem.html#activateVehicleDistanceSensors-double-org.eclipse.mosaic.interactions.vehicle.VehicleDistanceSensorActivation.DistanceSensors...-">activateVehicleDistanceSensors</a></span>(double&nbsp;sensorRange,
<a href="../../../../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleDistanceSensorActivation.DistanceSensors.html" title="enum in org.eclipse.mosaic.interactions.vehicle">VehicleDistanceSensorActivation.DistanceSensors</a>...&nbsp;sensors)</code>
<div class="block">Activates the detection of the leading vehicle within in a given distance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#applyVehicleParametersChange-org.eclipse.mosaic.fed.application.ambassador.simulation.VehicleParameters.VehicleParametersChangeRequest-">applyVehicleParametersChange</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleParameters.VehicleParametersChangeRequest.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">VehicleParameters.VehicleParametersChangeRequest</a>&nbsp;vehicleParametersRequest)</code>
<div class="block">Applies vehicle parameter changes which are defined in .</div>
</td>
</tr>
<tr id="i2" 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/os/VehicleOperatingSystem.html#changeLane-int-int-">changeLane</a></span>(int&nbsp;targetLaneIndex,
int&nbsp;duration)</code>
<div class="block">Forces a lane change to the lane with the given index; If successful, the
lane will be chosen for the given amount of time.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeLane-org.eclipse.mosaic.interactions.vehicle.VehicleLaneChange.VehicleLaneChangeMode-int-">changeLane</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleLaneChange.VehicleLaneChangeMode.html" title="enum in org.eclipse.mosaic.interactions.vehicle">VehicleLaneChange.VehicleLaneChangeMode</a>&nbsp;vehicleLaneChangeMode,
int&nbsp;duration)</code>
<div class="block">Forces a lane change to the lane according to the specified mode; If
successful, the lane will be chosen for the given amount of time.</div>
</td>
</tr>
<tr id="i4" 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/os/VehicleOperatingSystem.html#changeSpeedWithForcedAcceleration-double-double-">changeSpeedWithForcedAcceleration</a></span>(double&nbsp;newSpeed,
double&nbsp;forcedAcceleration)</code>
<div class="block">Allows control over the vehicle speed and the acceleration.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeSpeedWithInterval-double-int-">changeSpeedWithInterval</a></span>(double&nbsp;newSpeed,
int&nbsp;interval)</code>
<div class="block">Allows control over the vehicles speed.</div>
</td>
</tr>
<tr id="i6" 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/os/VehicleOperatingSystem.html#changeSpeedWithPleasantAcceleration-double-">changeSpeedWithPleasantAcceleration</a></span>(double&nbsp;newSpeed)</code>
<div class="block">Allows control over the vehicle speed.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleType.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#getInitialVehicleType--">getInitialVehicleType</a></span>()</code>
<div class="block">Returns the type of the vehicle.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<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/fed/application/app/api/os/VehicleOperatingSystem.html#getRoadPosition--">getRoadPosition</a></span>()</code>
<div class="block">Returns the road position of the vehicle containing all information about the
vehicle's position within the road network, such as previous and upcoming node or
the way the vehicle is currently driving on.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleData.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleData</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#getVehicleData--">getVehicleData</a></span>()</code>
<div class="block">Returns the current vehicle data state.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleParameters.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">VehicleParameters</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#getVehicleParameters--">getVehicleParameters</a></span>()</code>
<div class="block">Returns vehicle parameters.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleParameters.VehicleParametersChangeRequest.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">VehicleParameters.VehicleParametersChangeRequest</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#requestVehicleParametersUpdate--">requestVehicleParametersUpdate</a></span>()</code>
<div class="block">Returns a request object, which can be used to change vehicle parameters.</div>
</td>
</tr>
<tr id="i12" 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/os/VehicleOperatingSystem.html#resetSpeed--">resetSpeed</a></span>()</code>
<div class="block">Resets the speed of the vehicle to car-following rules after the speed has been set
with <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeSpeedWithInterval-double-int-"><code>changeSpeedWithInterval(double, int)</code></a>.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#resume--">resume</a></span>()</code>
<div class="block">Resumes a previously stopped vehicle.</div>
</td>
</tr>
<tr id="i14" 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/os/VehicleOperatingSystem.html#slowDown-float-int-">slowDown</a></span>(float&nbsp;speed,
int&nbsp;interval)</code>
<div class="block">Slow down the vehicle with the given Id to the given speed until the
given time (the vehicle is not guaranteed to have the given speed at the end of the given time).</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#stop-org.eclipse.mosaic.lib.objects.road.IRoadPosition-org.eclipse.mosaic.interactions.vehicle.VehicleStop.VehicleStopMode-int-">stop</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/lib/objects/road/IRoadPosition.html" title="interface in org.eclipse.mosaic.lib.objects.road">IRoadPosition</a>&nbsp;stopPosition,
<a href="../../../../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleStop.VehicleStopMode.html" title="enum in org.eclipse.mosaic.interactions.vehicle">VehicleStop.VehicleStopMode</a>&nbsp;vehicleStopMode,
int&nbsp;durationInMs)</code>
<div class="block">Sends a stop message to stop the vehicle along the road or by the road side.</div>
</td>
</tr>
<tr id="i16" 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/os/VehicleOperatingSystem.html#stopNow-org.eclipse.mosaic.interactions.vehicle.VehicleStop.VehicleStopMode-int-">stopNow</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleStop.VehicleStopMode.html" title="enum in org.eclipse.mosaic.interactions.vehicle">VehicleStop.VehicleStopMode</a>&nbsp;vehicleStopMode,
int&nbsp;durationInMs)</code>
<div class="block">Sends a stop message to stop the vehicle along the road or by the road side.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.fed.application.app.api.os.OperatingSystem">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.mosaic.fed.application.app.api.os.<a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></h3>
<code><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getAdHocModule--">getAdHocModule</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getApplications--">getApplications</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getApplicationsIterator-java.lang.Class-">getApplicationsIterator</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getCellModule--">getCellModule</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getConfigurationPath--">getConfigurationPath</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getEventManager--">getEventManager</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getId--">getId</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getInitialPosition--">getInitialPosition</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getPosition--">getPosition</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getSimulationTime--">getSimulationTime</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getSimulationTimeMs--">getSimulationTimeMs</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getStateOfEnvironmentSensor-org.eclipse.mosaic.lib.enums.SensorType-">getStateOfEnvironmentSensor</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#sendItefLogTuple-long-int...-">sendItefLogTuple</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#sendSumoTraciRequest-byte:A-">sendSumoTraciRequest</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.fed.application.ambassador.simulation.communication.CommunicationModuleOwner">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.mosaic.fed.application.ambassador.simulation.communication.<a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CommunicationModuleOwner</a></h3>
<code><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#assembleCamMessage-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.CamBuilder-">assembleCamMessage</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#sendInteractionToRti-org.eclipse.mosaic.rti.api.Interaction-">sendInteractionToRti</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#triggerOnSendMessage-org.eclipse.mosaic.interactions.communication.V2xMessageTransmission-">triggerOnSendMessage</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.fed.application.ambassador.navigation.INavigationModuleOwner">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.mosaic.fed.application.ambassador.navigation.<a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/INavigationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.navigation">INavigationModuleOwner</a></h3>
<code><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/INavigationModuleOwner.html#getNavigationModule--">getNavigationModule</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="getVehicleData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVehicleData</h4>
<pre><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;getVehicleData()</pre>
<div class="block">Returns the current vehicle data state.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current vehicle data state.</dd>
</dl>
</li>
</ul>
<a name="changeLane-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeLane</h4>
<pre>void&nbsp;changeLane(int&nbsp;targetLaneIndex,
int&nbsp;duration)</pre>
<div class="block">Forces a lane change to the lane with the given index; If successful, the
lane will be chosen for the given amount of time.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>targetLaneIndex</code> - index of target lane</dd>
<dd><code>duration</code> - the duration for the lane change in millisecond</dd>
</dl>
</li>
</ul>
<a name="changeLane-org.eclipse.mosaic.interactions.vehicle.VehicleLaneChange.VehicleLaneChangeMode-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeLane</h4>
<pre>void&nbsp;changeLane(<a href="../../../../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleLaneChange.VehicleLaneChangeMode.html" title="enum in org.eclipse.mosaic.interactions.vehicle">VehicleLaneChange.VehicleLaneChangeMode</a>&nbsp;vehicleLaneChangeMode,
int&nbsp;duration)</pre>
<div class="block">Forces a lane change to the lane according to the specified mode; If
successful, the lane will be chosen for the given amount of time.
<p></p>
Note: use <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeLane-int-int-"><code>changeLane()</code></a>, for
mode <code>VehicleLaneChangeMode.index</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vehicleLaneChangeMode</code> - mode to change lane</dd>
<dd><code>duration</code> - the duration for the lane change in millisecond</dd>
</dl>
</li>
</ul>
<a name="slowDown-float-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>slowDown</h4>
<pre>void&nbsp;slowDown(float&nbsp;speed,
int&nbsp;interval)</pre>
<div class="block">Slow down the vehicle with the given Id to the given speed until the
given time (the vehicle is not guaranteed to have the given speed at the end of the given time).
With this command it is possible to simulate e.g., instant brakes, slowing down, etc.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>speed</code> - new speed</dd>
<dd><code>interval</code> - Time interval for which the slow down should be valid, after that
interval the vehicle will accelerate again. Unit: [ms].</dd>
</dl>
</li>
</ul>
<a name="resetSpeed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetSpeed</h4>
<pre>void&nbsp;resetSpeed()</pre>
<div class="block">Resets the speed of the vehicle to car-following rules after the speed has been set
with <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeSpeedWithInterval-double-int-"><code>changeSpeedWithInterval(double, int)</code></a>.</div>
</li>
</ul>
<a name="changeSpeedWithInterval-double-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeSpeedWithInterval</h4>
<pre>void&nbsp;changeSpeedWithInterval(double&nbsp;newSpeed,
int&nbsp;interval)</pre>
<div class="block">Allows control over the vehicles speed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newSpeed</code> - is the target speed in [m/s]</dd>
<dd><code>interval</code> - the new speed should be reached in [ms]</dd>
</dl>
</li>
</ul>
<a name="changeSpeedWithForcedAcceleration-double-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeSpeedWithForcedAcceleration</h4>
<pre>void&nbsp;changeSpeedWithForcedAcceleration(double&nbsp;newSpeed,
double&nbsp;forcedAcceleration)</pre>
<div class="block">Allows control over the vehicle speed and the acceleration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newSpeed</code> - is the target speed in [m/s]</dd>
<dd><code>forcedAcceleration</code> - is the acceleration in m/s², forced acceleration with highest priority</dd>
</dl>
</li>
</ul>
<a name="changeSpeedWithPleasantAcceleration-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeSpeedWithPleasantAcceleration</h4>
<pre>void&nbsp;changeSpeedWithPleasantAcceleration(double&nbsp;newSpeed)</pre>
<div class="block">Allows control over the vehicle speed. The pleasantAcceleration set in DriverProperties will be used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newSpeed</code> - is the target speed in [m/s]</dd>
</dl>
</li>
</ul>
<a name="stop-org.eclipse.mosaic.lib.objects.road.IRoadPosition-org.eclipse.mosaic.interactions.vehicle.VehicleStop.VehicleStopMode-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>void&nbsp;stop(<a href="../../../../../../../../org/eclipse/mosaic/lib/objects/road/IRoadPosition.html" title="interface in org.eclipse.mosaic.lib.objects.road">IRoadPosition</a>&nbsp;stopPosition,
<a href="../../../../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleStop.VehicleStopMode.html" title="enum in org.eclipse.mosaic.interactions.vehicle">VehicleStop.VehicleStopMode</a>&nbsp;vehicleStopMode,
int&nbsp;durationInMs)</pre>
<div class="block">Sends a stop message to stop the vehicle along the road or by the road side.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stopPosition</code> - Position on road where the vehicle is supposed to stop at</dd>
<dd><code>vehicleStopMode</code> - Stop mode</dd>
<dd><code>durationInMs</code> - Duration of the stop, unit: [ms]</dd>
</dl>
</li>
</ul>
<a name="stopNow-org.eclipse.mosaic.interactions.vehicle.VehicleStop.VehicleStopMode-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopNow</h4>
<pre>void&nbsp;stopNow(<a href="../../../../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleStop.VehicleStopMode.html" title="enum in org.eclipse.mosaic.interactions.vehicle">VehicleStop.VehicleStopMode</a>&nbsp;vehicleStopMode,
int&nbsp;durationInMs)</pre>
<div class="block">Sends a stop message to stop the vehicle along the road or by the road side. The
vehicle is tried to stop as soon as possible.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vehicleStopMode</code> - Stop mode</dd>
<dd><code>durationInMs</code> - Duration of the stop, unit: [ms]</dd>
</dl>
</li>
</ul>
<a name="resume--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resume</h4>
<pre>void&nbsp;resume()</pre>
<div class="block">Resumes a previously stopped vehicle.</div>
</li>
</ul>
<a name="getRoadPosition--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoadPosition</h4>
<pre><a href="../../../../../../../../org/eclipse/mosaic/lib/objects/road/IRoadPosition.html" title="interface in org.eclipse.mosaic.lib.objects.road">IRoadPosition</a>&nbsp;getRoadPosition()</pre>
<div class="block">Returns the road position of the vehicle containing all information about the
vehicle's position within the road network, such as previous and upcoming node or
the way the vehicle is currently driving on.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current road position</dd>
</dl>
</li>
</ul>
<a name="getInitialVehicleType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialVehicleType</h4>
<pre><a href="../../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleType.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleType</a>&nbsp;getInitialVehicleType()</pre>
<div class="block">Returns the type of the vehicle.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the type of the vehicle.</dd>
</dl>
</li>
</ul>
<a name="getVehicleParameters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVehicleParameters</h4>
<pre><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleParameters.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">VehicleParameters</a>&nbsp;getVehicleParameters()</pre>
<div class="block">Returns vehicle parameters.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the behavioral parameters of the vehicle (such as maximum speed or lane-change-behavior)</dd>
</dl>
</li>
</ul>
<a name="requestVehicleParametersUpdate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestVehicleParametersUpdate</h4>
<pre><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleParameters.VehicleParametersChangeRequest.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">VehicleParameters.VehicleParametersChangeRequest</a>&nbsp;requestVehicleParametersUpdate()</pre>
<div class="block">Returns a request object, which can be used to change vehicle parameters. After
changing relevant parameters, this request object must be passed to
<a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#applyVehicleParametersChange-org.eclipse.mosaic.fed.application.ambassador.simulation.VehicleParameters.VehicleParametersChangeRequest-"><code>applyVehicleParametersChange(VehicleParameters.VehicleParametersChangeRequest)</code></a> in order
to apply the vehicle parameters.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an request object, which can be used to change vehicle parameters.</dd>
</dl>
</li>
</ul>
<a name="applyVehicleParametersChange-org.eclipse.mosaic.fed.application.ambassador.simulation.VehicleParameters.VehicleParametersChangeRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyVehicleParametersChange</h4>
<pre>void&nbsp;applyVehicleParametersChange(<a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleParameters.VehicleParametersChangeRequest.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">VehicleParameters.VehicleParametersChangeRequest</a>&nbsp;vehicleParametersRequest)</pre>
<div class="block">Applies vehicle parameter changes which are defined in .</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vehicleParametersRequest</code> - The request, which has been created using
<a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#requestVehicleParametersUpdate--"><code>requestVehicleParametersUpdate()</code></a>.</dd>
</dl>
</li>
</ul>
<a name="activateVehicleDistanceSensors-double-org.eclipse.mosaic.interactions.vehicle.VehicleDistanceSensorActivation.DistanceSensors...-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>activateVehicleDistanceSensors</h4>
<pre>void&nbsp;activateVehicleDistanceSensors(double&nbsp;sensorRange,
<a href="../../../../../../../../org/eclipse/mosaic/interactions/vehicle/VehicleDistanceSensorActivation.DistanceSensors.html" title="enum in org.eclipse.mosaic.interactions.vehicle">VehicleDistanceSensorActivation.DistanceSensors</a>...&nbsp;sensors)</pre>
<div class="block">Activates the detection of the leading vehicle within in a given distance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sensorRange</code> - The maximum distance to look ahead for leading vehicles.</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/VehicleOperatingSystem.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/os/TrafficManagementCenterOperatingSystem.ChangeLaneState.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os"><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/os/VehicleOperatingSystem.html" target="_top">Frames</a></li>
<li><a href="VehicleOperatingSystem.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&#x2013;2021 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p>
</body>
</html>