Google Git
Sign in
eclipse / gerrit / www.eclipse.org / mosaic / d34bf266db7db6621a9cba2a322de650f1980adb / . / java_docs / org / eclipse / mosaic / fed / mapping / config / units / CVehicle.html
blob: ca55f10a8a1039f88693de214ce082792e9de22b [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>CVehicle (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="CVehicle (Eclipse MOSAIC Parent 20.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":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/CVehicle.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/mapping/config/units/CTrafficManagementCenter.html" title="class in org.eclipse.mosaic.fed.mapping.config.units"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.COriginDestinationMatrixMapper.html" title="class in org.eclipse.mosaic.fed.mapping.config.units"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html" target="_top">Frames</a></li>
<li><a href="CVehicle.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.mapping.config.units</div>
<h2 title="Class CVehicle" class="title">Class CVehicle</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>org.eclipse.mosaic.fed.mapping.config.units.CVehicle</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html" title="class in org.eclipse.mosaic.fed.mapping.config.units">CVehicle</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">CVehicle</span>
extends <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>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html" title="class in org.eclipse.mosaic.fed.mapping.config.units">CVehicle</a>&gt;</pre>
<div class="block">Class defining a vehicle to be spawned in the simulation. Will be parsed against
JSON-configuration. This class is responsible for describing the vehicles
populating the simulation. It is possible to create a single vehicle
(maxNumberVehicles should be one in that case) or a stream of one or multiple
vehicles. The types (or type) are defined in the field types. When more than
one type is defined the weights in the <a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/CPrototype.html" title="class in org.eclipse.mosaic.fed.mapping.config"><code>CPrototype</code></a>
can be used to balance them against each other.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.COriginDestinationMatrixMapper.html" title="class in org.eclipse.mosaic.fed.mapping.config.units">CVehicle.COriginDestinationMatrixMapper</a></span></code>
<div class="block">Mapper to define an Origin-Destination Matrix.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.COriginDestinationPoint.html" title="class in org.eclipse.mosaic.fed.mapping.config.units">CVehicle.COriginDestinationPoint</a></span></code>
<div class="block">Defines a point that can be referenced from an OD-matrix.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.SpawningMode.html" title="enum in org.eclipse.mosaic.fed.mapping.config.units">CVehicle.SpawningMode</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#departSpeed">departSpeed</a></span></code>
<div class="block">The speed at which the vehicle is supposed to depart.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleDeparture.DepartSpeedMode.html" title="enum in org.eclipse.mosaic.lib.objects.vehicle">VehicleDeparture.DepartSpeedMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#departSpeedMode">departSpeedMode</a></span></code>
<div class="block">The depart speed mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoCircle.html" title="class in org.eclipse.mosaic.lib.geo">GeoCircle</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#destination">destination</a></span></code>
<div class="block">Point to which the vehicles will travel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#deterministic">deterministic</a></span></code>
<div class="block">Determines if selection of a vehicles type when spawning follows a deterministic or stochastic model.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#group">group</a></span></code>
<div class="block">Define a group for grouping in ITEF Visualizer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#lanes">lanes</a></span></code>
<div class="block">List of lanes to be used.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleDeparture.LaneSelectionMode.html" title="enum in org.eclipse.mosaic.lib.objects.vehicle">VehicleDeparture.LaneSelectionMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#laneSelectionMode">laneSelectionMode</a></span></code>
<div class="block">The lane selection mode which chooses the lane for the next departing vehicle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#maxNumberVehicles">maxNumberVehicles</a></span></code>
<div class="block">Defining a maximum number of vehicles to be created from this source.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#maxTime">maxTime</a></span></code>
<div class="block">Simulation time in seconds at which no more vehicles will be created.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoCircle.html" title="class in org.eclipse.mosaic.lib.geo">GeoCircle</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#origin">origin</a></span></code>
<div class="block">Point from which the vehicles will be spawned.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#pos">pos</a></span></code>
<div class="block">Position within the route where the vehicle(-s) should be spawned.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#route">route</a></span></code>
<div class="block">Route that the vehicle(-s) should use.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.SpawningMode.html" title="enum in org.eclipse.mosaic.fed.mapping.config.units">CVehicle.SpawningMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#spawningMode">spawningMode</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#startingTime">startingTime</a></span></code>
<div class="block">Time when the first vehicle will be created.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#targetFlow">targetFlow</a></span></code>
<div class="block">Density of vehicles per hour.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#typeDistribution">typeDistribution</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/CPrototype.html" title="class in org.eclipse.mosaic.fed.mapping.config">CPrototype</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#types">types</a></span></code>
<div class="block">List of possible vehicle types to be spawned.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/mapping/config/units/CVehicle.html#CVehicle--">CVehicle</a></span>()</code>&nbsp;</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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#compareTo-org.eclipse.mosaic.fed.mapping.config.units.CVehicle-">compareTo</a></span>(<a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html" title="class in org.eclipse.mosaic.fed.mapping.config.units">CVehicle</a>&nbsp;o)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#equals-java.lang.Object-">equals</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;o)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
</table>
<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#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#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>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="startingTime">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startingTime</h4>
<pre>public&nbsp;double startingTime</pre>
<div class="block">Time when the first vehicle will be created.</div>
</li>
</ul>
<a name="maxTime">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxTime</h4>
<pre>@SerializedName(value="maxTime",
alternate="endingTime")
public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang">Double</a> maxTime</pre>
<div class="block">Simulation time in seconds at which no more vehicles will be created.</div>
</li>
</ul>
<a name="targetFlow">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>targetFlow</h4>
<pre>@SerializedName(value="targetFlow",
alternate="targetDensity")
public&nbsp;double targetFlow</pre>
<div class="block">Density of vehicles per hour. Vehicles will be spawned uniformly.</div>
</li>
</ul>
<a name="spawningMode">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>spawningMode</h4>
<pre>public&nbsp;<a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.SpawningMode.html" title="enum in org.eclipse.mosaic.fed.mapping.config.units">CVehicle.SpawningMode</a> spawningMode</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.SpawningMode.html#CONSTANT"><code>spawns vehicles by the given targetFlow</code></a>,
<a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.SpawningMode.html#GROW"><code>increases the vehicle flow demand exponentially to targetFlow until maxTime is reached</code></a>,
<a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.SpawningMode.html#SHRINK"><code>decreases the vehicle flow demand exponentially from targetFlow until maxTime is reached</code></a></dd>
</dl>
</li>
</ul>
<a name="maxNumberVehicles">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxNumberVehicles</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> maxNumberVehicles</pre>
<div class="block">Defining a maximum number of vehicles to be created from this source.</div>
</li>
</ul>
<a name="lanes">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lanes</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt; lanes</pre>
<div class="block">List of lanes to be used. The vehicles will be evenly distributed among
the given lanes. When no value is given lane zero will be used for all
vehicles</div>
</li>
</ul>
<a name="laneSelectionMode">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>laneSelectionMode</h4>
<pre>public&nbsp;<a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleDeparture.LaneSelectionMode.html" title="enum in org.eclipse.mosaic.lib.objects.vehicle">VehicleDeparture.LaneSelectionMode</a> laneSelectionMode</pre>
<div class="block">The lane selection mode which chooses the lane for the next departing vehicle.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleDeparture.LaneSelectionMode.html#ROUNDROBIN"><code>VehicleDeparture.LaneSelectionMode.ROUNDROBIN</code></a>,
<a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleDeparture.LaneSelectionMode.html#FREE"><code>VehicleDeparture.LaneSelectionMode.FREE</code></a>,
<a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleDeparture.LaneSelectionMode.html#BEST"><code>VehicleDeparture.LaneSelectionMode.BEST</code></a>,
<a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleDeparture.LaneSelectionMode.html#HIGHWAY"><code>VehicleDeparture.LaneSelectionMode.HIGHWAY</code></a></dd>
</dl>
</li>
</ul>
<a name="departSpeed">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>departSpeed</h4>
<pre>public&nbsp;double departSpeed</pre>
<div class="block">The speed at which the vehicle is supposed to depart. Depending on the simulator
this value may only be used if <a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#departSpeedMode"><code>departSpeedMode</code></a> is set to PRECISE.</div>
</li>
</ul>
<a name="departSpeedMode">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>departSpeedMode</h4>
<pre>public&nbsp;<a href="../../../../../../../org/eclipse/mosaic/lib/objects/vehicle/VehicleDeparture.DepartSpeedMode.html" title="enum in org.eclipse.mosaic.lib.objects.vehicle">VehicleDeparture.DepartSpeedMode</a> departSpeedMode</pre>
<div class="block">The depart speed mode. Depending on the value the depart speed behaves
as follows:
<p></p>
PRECISE = Use the value given in <a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#departSpeed"><code>departSpeed</code></a>
RANDOM = The <a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#departSpeed"><code>departSpeed</code></a> will be overridden by a random value
MAXIMUM = The <a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html#departSpeed"><code>departSpeed</code></a> will be overridden by the max value</div>
</li>
</ul>
<a name="types">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>types</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/CPrototype.html" title="class in org.eclipse.mosaic.fed.mapping.config">CPrototype</a>&gt; types</pre>
<div class="block">List of possible vehicle types to be spawned. In this list you can simply refer to an
existing <a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/CPrototype.html" title="class in org.eclipse.mosaic.fed.mapping.config"><code>CPrototype</code></a> by its <a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/CPrototype.html#name"><code>CPrototype.name</code></a> attribute to include everything
defined there. You can also overwrite every attribute of the prototype.
If you don't have an existing prototype the definitions found here will be used as the
prototype definition itself. <br />
<br />
Example configuration file:
<pre>
{
"prototypeDeserializers":[
{
"name":"PKW",
"accel":2.5,
"decel":4.5,
"length":5.0,
"minGap":2.5,
"maxSpeed":70.0
}
],
"vehicles":[
{
"route":"0",
"types":[
{ "name":"PKW" },
{
"name":"PKW",
"accel":2.0,
"length":7.0
}
]
}
]
}
</pre></div>
</li>
</ul>
<a name="typeDistribution">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>typeDistribution</h4>
<pre>public&nbsp;<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> typeDistribution</pre>
</li>
</ul>
<a name="deterministic">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deterministic</h4>
<pre>public&nbsp;boolean deterministic</pre>
<div class="block">Determines if selection of a vehicles type when spawning follows a deterministic or stochastic model.
When set to true the spawning-process will choose exactly the same types with every execution.
When set to false the order of types may be different and selected weights will be reached more slowly.</div>
</li>
</ul>
<a name="pos">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pos</h4>
<pre>public&nbsp;int pos</pre>
<div class="block">Position within the route where the vehicle(-s) should be spawned.</div>
</li>
</ul>
<a name="route">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>route</h4>
<pre>public&nbsp;<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> route</pre>
<div class="block">Route that the vehicle(-s) should use. If an origin and a destination are
specified this route will be treated as a preference (i.e. it will be
selected if it connects the two points in question)</div>
</li>
</ul>
<a name="origin">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>origin</h4>
<pre>public&nbsp;<a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoCircle.html" title="class in org.eclipse.mosaic.lib.geo">GeoCircle</a> origin</pre>
<div class="block">Point from which the vehicles will be spawned.</div>
</li>
</ul>
<a name="destination">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destination</h4>
<pre>public&nbsp;<a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoCircle.html" title="class in org.eclipse.mosaic.lib.geo">GeoCircle</a> destination</pre>
<div class="block">Point to which the vehicles will travel.</div>
</li>
</ul>
<a name="group">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>group</h4>
<pre>public&nbsp;<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> group</pre>
<div class="block">Define a group for grouping in ITEF Visualizer.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CVehicle--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CVehicle</h4>
<pre>public&nbsp;CVehicle()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="compareTo-org.eclipse.mosaic.fed.mapping.config.units.CVehicle-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>public&nbsp;int&nbsp;compareTo(<a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html" title="class in org.eclipse.mosaic.fed.mapping.config.units">CVehicle</a>&nbsp;o)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true#compareTo-T-" title="class or interface in java.lang">compareTo</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html" title="class in org.eclipse.mosaic.fed.mapping.config.units">CVehicle</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<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;o)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></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/CVehicle.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/mapping/config/units/CTrafficManagementCenter.html" title="class in org.eclipse.mosaic.fed.mapping.config.units"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/eclipse/mosaic/fed/mapping/config/units/CVehicle.COriginDestinationMatrixMapper.html" title="class in org.eclipse.mosaic.fed.mapping.config.units"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/mosaic/fed/mapping/config/units/CVehicle.html" target="_top">Frames</a></li>
<li><a href="CVehicle.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>