Google Git
Sign in
eclipse / gerrit / www.eclipse.org / mosaic / d34bf266db7db6621a9cba2a322de650f1980adb / . / java_docs / org / eclipse / mosaic / fed / application / ambassador / simulation / VehicleUnit.html
blob: c228ffaec0f8b3612cf0a4fe139ca2e6ccddd52c [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>VehicleUnit (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="VehicleUnit (Eclipse MOSAIC Parent 20.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/VehicleUnit.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/ambassador/simulation/VehicleParameters.VehicleParametersChangeRequest.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation"><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/ambassador/simulation/VehicleUnit.html" target="_top">Frames</a></li>
<li><a href="VehicleUnit.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.mosaic.fed.application.ambassador.simulation</div>
<h2 title="Class VehicleUnit" class="title">Class VehicleUnit</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">org.eclipse.mosaic.fed.application.ambassador.simulation.AbstractSimulationUnit</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.mosaic.fed.application.ambassador.simulation.VehicleUnit</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><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/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/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/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</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>Direct Known Subclasses:</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></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">VehicleUnit</span>
extends <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">AbstractSimulationUnit</a>
implements <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></pre>
<div class="block">This class represents a vehicle in the application simulator.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.html#VehicleUnit-java.lang.String-org.eclipse.mosaic.lib.objects.vehicle.VehicleType-org.eclipse.mosaic.lib.geo.GeoPoint-">VehicleUnit</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;vehicleName,
<a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleType.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleType</a>&nbsp;vehicleType,
<a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a>&nbsp;initialPosition)</code>
<div class="block">Creates a vehicle simulation unit.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.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/ambassador/simulation/VehicleUnit.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;behaviorRequest)</code>
<div class="block">Applies vehicle parameter changes which are defined in .</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CamBuilder.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CamBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.html#assembleCamMessage-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.CamBuilder-">assembleCamMessage</a></span>(<a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CamBuilder.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CamBuilder</a>&nbsp;camBuilder)</code>
<div class="block">Assembles a <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CamBuilder.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication"><code>CamBuilder</code></a> (Cooperative Awareness Message) using the
given <a href="../../../../../../../org/eclipse/mosaic/lib/objects/v2x/MessageRouting.html" title="class in org.eclipse.mosaic.lib.objects.v2x"><code>MessageRouting</code></a> and the units' status information.</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/ambassador/simulation/VehicleUnit.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="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.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="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.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="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.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="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.html#changeSpeedWithPleasantAcceleration-double-">changeSpeedWithPleasantAcceleration</a></span>(double&nbsp;newSpeed)</code>
<div class="block">Allows control over the vehicle speed.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<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/ambassador/simulation/VehicleUnit.html#getInitialVehicleType--">getInitialVehicleType</a></span>()</code>
<div class="block">Returns the type of the vehicle.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/INavigationModule.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.navigation">INavigationModule</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.html#getNavigationModule--">getNavigationModule</a></span>()</code>
<div class="block">Returns the navigation module of the vehicle.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.html#getPosition--">getPosition</a></span>()</code>
<div class="block">This data element provides an absolute geographical longitude and latitude in a WGS84
coordinate system with a granularity of 1/8 micro degrees.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<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/ambassador/simulation/VehicleUnit.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="i12" class="altColor">
<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/ambassador/simulation/VehicleUnit.html#getVehicleData--">getVehicleData</a></span>()</code>
<div class="block">Returns the current vehicle data state.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<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/ambassador/simulation/VehicleUnit.html#getVehicleParameters--">getVehicleParameters</a></span>()</code>
<div class="block">Returns vehicle parameters.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.html#handleEventResource-java.lang.Object-long-">handleEventResource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;resource,
long&nbsp;eventType)</code>&nbsp;</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/ambassador/simulation/VehicleUnit.html#processEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">processEvent</a></span>(<a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling">Event</a>&nbsp;event)</code>
<div class="block">Processes the given event.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<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/ambassador/simulation/VehicleUnit.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="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.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>VehicleOperatingSystem.changeSpeedWithInterval(double, int)</code></a>.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.html#resume--">resume</a></span>()</code>
<div class="block">Resumes a previously stopped vehicle.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.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="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.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="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.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.ambassador.simulation.AbstractSimulationUnit">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.mosaic.fed.application.ambassador.simulation.<a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">AbstractSimulationUnit</a></h3>
<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#canProcessEvent--">canProcessEvent</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#cleanPastEnvironmentEvents--">cleanPastEnvironmentEvents</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getAdHocModule--">getAdHocModule</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getApplications--">getApplications</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getApplicationsIterator-java.lang.Class-">getApplicationsIterator</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getCellModule--">getCellModule</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getConfigurationPath--">getConfigurationPath</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getEventManager--">getEventManager</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getId--">getId</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getInitialPosition--">getInitialPosition</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getOsLog--">getOsLog</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getSimulationTime--">getSimulationTime</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getStateOfEnvironmentSensor-org.eclipse.mosaic.lib.enums.SensorType-">getStateOfEnvironmentSensor</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#loadApplications-java.util.List-">loadApplications</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#preProcessEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">preProcessEvent</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#processSumoTraciMessage-org.eclipse.mosaic.lib.objects.traffic.SumoTraciResult-">processSumoTraciMessage</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#putEnvironmentEvent-org.eclipse.mosaic.lib.enums.SensorType-org.eclipse.mosaic.lib.objects.environment.EnvironmentEvent-">putEnvironmentEvent</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#sendInteractionToRti-org.eclipse.mosaic.rti.api.Interaction-">sendInteractionToRti</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#sendItefLogTuple-long-int...-">sendItefLogTuple</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#sendSumoTraciRequest-byte:A-">sendSumoTraciRequest</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#setUp--">setUp</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#tearDown--">tearDown</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.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.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<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#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#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>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="VehicleUnit-java.lang.String-org.eclipse.mosaic.lib.objects.vehicle.VehicleType-org.eclipse.mosaic.lib.geo.GeoPoint-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>VehicleUnit</h4>
<pre>public&nbsp;VehicleUnit(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;vehicleName,
<a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleType.html" title="class in org.eclipse.mosaic.lib.objects.vehicle">VehicleType</a>&nbsp;vehicleType,
<a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a>&nbsp;initialPosition)</pre>
<div class="block">Creates a vehicle simulation unit.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vehicleName</code> - vehicle identifier</dd>
<dd><code>vehicleType</code> - vehicle type</dd>
<dd><code>initialPosition</code> - initial position</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getPosition--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPosition</h4>
<pre>public final&nbsp;<a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a>&nbsp;getPosition()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getPosition--">OperatingSystem</a></code></span></div>
<div class="block">This data element provides an absolute geographical longitude and latitude in a WGS84
coordinate system with a granularity of 1/8 micro degrees. Compliant to SAE J2735
DE_Longitude.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#getPosition--">getPosition</a></code>&nbsp;in interface&nbsp;<code><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></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getPosition--">getPosition</a></code>&nbsp;in interface&nbsp;<code><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></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the position.</dd>
</dl>
</li>
</ul>
<a name="processEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processEvent</h4>
<pre>public&nbsp;void&nbsp;processEvent(<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/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling">Event</a>&nbsp;event)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html#processEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">EventProcessor</a></code></span></div>
<div class="block">Processes the given event.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html#processEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">processEvent</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventProcessor</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - the event to process</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="handleEventResource-java.lang.Object-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleEventResource</h4>
<pre>protected&nbsp;boolean&nbsp;handleEventResource(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;resource,
long&nbsp;eventType)</pre>
</li>
</ul>
<a name="changeLane-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeLane</h4>
<pre>public&nbsp;void&nbsp;changeLane(int&nbsp;targetLaneIndex,
int&nbsp;duration)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeLane-int-int-">VehicleOperatingSystem</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeLane-int-int-">changeLane</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<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>public&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeLane-org.eclipse.mosaic.interactions.vehicle.VehicleLaneChange.VehicleLaneChangeMode-int-">VehicleOperatingSystem</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeLane-org.eclipse.mosaic.interactions.vehicle.VehicleLaneChange.VehicleLaneChangeMode-int-">changeLane</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<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>public&nbsp;void&nbsp;slowDown(float&nbsp;speed,
int&nbsp;interval)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#slowDown-float-int-">VehicleOperatingSystem</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#slowDown-float-int-">slowDown</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<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="changeSpeedWithInterval-double-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeSpeedWithInterval</h4>
<pre>public&nbsp;void&nbsp;changeSpeedWithInterval(double&nbsp;newSpeed,
int&nbsp;interval)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeSpeedWithInterval-double-int-">VehicleOperatingSystem</a></code></span></div>
<div class="block">Allows control over the vehicles speed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeSpeedWithInterval-double-int-">changeSpeedWithInterval</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<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>public&nbsp;void&nbsp;changeSpeedWithForcedAcceleration(double&nbsp;newSpeed,
double&nbsp;forcedAcceleration)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeSpeedWithForcedAcceleration-double-double-">VehicleOperatingSystem</a></code></span></div>
<div class="block">Allows control over the vehicle speed and the acceleration.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeSpeedWithForcedAcceleration-double-double-">changeSpeedWithForcedAcceleration</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<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>public&nbsp;void&nbsp;changeSpeedWithPleasantAcceleration(double&nbsp;newSpeed)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeSpeedWithPleasantAcceleration-double-">VehicleOperatingSystem</a></code></span></div>
<div class="block">Allows control over the vehicle speed. The pleasantAcceleration set in DriverProperties will be used.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#changeSpeedWithPleasantAcceleration-double-">changeSpeedWithPleasantAcceleration</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newSpeed</code> - is the target speed in [m/s]</dd>
</dl>
</li>
</ul>
<a name="resetSpeed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetSpeed</h4>
<pre>public&nbsp;void&nbsp;resetSpeed()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#resetSpeed--">VehicleOperatingSystem</a></code></span></div>
<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>VehicleOperatingSystem.changeSpeedWithInterval(double, int)</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#resetSpeed--">resetSpeed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></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>public&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><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-">VehicleOperatingSystem</a></code></span></div>
<div class="block">Sends a stop message to stop the vehicle along the road or by the road side.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><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></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<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>public&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#stopNow-org.eclipse.mosaic.interactions.vehicle.VehicleStop.VehicleStopMode-int-">VehicleOperatingSystem</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#stopNow-org.eclipse.mosaic.interactions.vehicle.VehicleStop.VehicleStopMode-int-">stopNow</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<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>public&nbsp;void&nbsp;resume()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#resume--">VehicleOperatingSystem</a></code></span></div>
<div class="block">Resumes a previously stopped vehicle.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#resume--">resume</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
</dl>
</li>
</ul>
<a name="assembleCamMessage-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.CamBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assembleCamMessage</h4>
<pre>public&nbsp;<a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CamBuilder.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CamBuilder</a>&nbsp;assembleCamMessage(<a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CamBuilder.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CamBuilder</a>&nbsp;camBuilder)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#assembleCamMessage-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.CamBuilder-">CommunicationModuleOwner</a></code></span></div>
<div class="block">Assembles a <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CamBuilder.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication"><code>CamBuilder</code></a> (Cooperative Awareness Message) using the
given <a href="../../../../../../../org/eclipse/mosaic/lib/objects/v2x/MessageRouting.html" title="class in org.eclipse.mosaic.lib.objects.v2x"><code>MessageRouting</code></a> and the units' status information.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><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></code>&nbsp;in interface&nbsp;<code><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></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>camBuilder</code> - the routing for the <a href="../../../../../../../org/eclipse/mosaic/lib/objects/v2x/etsi/Cam.html" title="class in org.eclipse.mosaic.lib.objects.v2x.etsi"><code>Cam</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the assembled <a href="../../../../../../../org/eclipse/mosaic/lib/objects/v2x/etsi/Cam.html" title="class in org.eclipse.mosaic.lib.objects.v2x.etsi"><code>Cam</code></a>, which can be sent</dd>
</dl>
</li>
</ul>
<a name="getInitialVehicleType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialVehicleType</h4>
<pre>public&nbsp;<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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#getInitialVehicleType--">VehicleOperatingSystem</a></code></span></div>
<div class="block">Returns the type of the vehicle.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#getInitialVehicleType--">getInitialVehicleType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<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="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
public&nbsp;<a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleParameters.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">VehicleParameters</a>&nbsp;getVehicleParameters()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#getVehicleParameters--">VehicleOperatingSystem</a></code></span></div>
<div class="block">Returns vehicle parameters.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#getVehicleParameters--">getVehicleParameters</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<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>public&nbsp;<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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#requestVehicleParametersUpdate--">VehicleOperatingSystem</a></code></span></div>
<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>VehicleOperatingSystem.applyVehicleParametersChange(VehicleParameters.VehicleParametersChangeRequest)</code></a> in order
to apply the vehicle parameters.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#requestVehicleParametersUpdate--">requestVehicleParametersUpdate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<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>public&nbsp;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;behaviorRequest)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#applyVehicleParametersChange-org.eclipse.mosaic.fed.application.ambassador.simulation.VehicleParameters.VehicleParametersChangeRequest-">VehicleOperatingSystem</a></code></span></div>
<div class="block">Applies vehicle parameter changes which are defined in .</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#applyVehicleParametersChange-org.eclipse.mosaic.fed.application.ambassador.simulation.VehicleParameters.VehicleParametersChangeRequest-">applyVehicleParametersChange</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>behaviorRequest</code> - The request, which has been created using
<a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#requestVehicleParametersUpdate--"><code>VehicleOperatingSystem.requestVehicleParametersUpdate()</code></a>.</dd>
</dl>
</li>
</ul>
<a name="activateVehicleDistanceSensors-double-org.eclipse.mosaic.interactions.vehicle.VehicleDistanceSensorActivation.DistanceSensors...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>activateVehicleDistanceSensors</h4>
<pre>public&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#activateVehicleDistanceSensors-double-org.eclipse.mosaic.interactions.vehicle.VehicleDistanceSensorActivation.DistanceSensors...-">VehicleOperatingSystem</a></code></span></div>
<div class="block">Activates the detection of the leading vehicle within in a given distance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#activateVehicleDistanceSensors-double-org.eclipse.mosaic.interactions.vehicle.VehicleDistanceSensorActivation.DistanceSensors...-">activateVehicleDistanceSensors</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sensorRange</code> - The maximum distance to look ahead for leading vehicles.</dd>
</dl>
</li>
</ul>
<a name="getNavigationModule--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNavigationModule</h4>
<pre>public&nbsp;<a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/INavigationModule.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.navigation">INavigationModule</a>&nbsp;getNavigationModule()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/INavigationModuleOwner.html#getNavigationModule--">INavigationModuleOwner</a></code></span></div>
<div class="block">Returns the navigation module of the vehicle.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/INavigationModuleOwner.html#getNavigationModule--">getNavigationModule</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/navigation/INavigationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.navigation">INavigationModuleOwner</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the navigation module of the vehicle.</dd>
</dl>
</li>
</ul>
<a name="getVehicleData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVehicleData</h4>
<pre>public&nbsp;<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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#getVehicleData--">VehicleOperatingSystem</a></code></span></div>
<div class="block">Returns the current vehicle data state.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#getVehicleData--">getVehicleData</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current vehicle data state.</dd>
</dl>
</li>
</ul>
<a name="getRoadPosition--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRoadPosition</h4>
<pre>public&nbsp;<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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#getRoadPosition--">VehicleOperatingSystem</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html#getRoadPosition--">getRoadPosition</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current road position</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/VehicleUnit.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/ambassador/simulation/VehicleParameters.VehicleParametersChangeRequest.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation"><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/ambassador/simulation/VehicleUnit.html" target="_top">Frames</a></li>
<li><a href="VehicleUnit.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2020 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p>
</body>
</html>