blob: 20d1998f9a2c1dadde76df92617648cc8fd37768 [file] [log] [blame]
<!DOCTYPE html><html lang="en-us" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Source Themes Academic 4.8.0">
<meta name="author" content="Fraunhofer FOKUS">
<meta name="description" content="">
<link rel="alternate" hreflang="en-us" href="https://staging.eclipse.org/mosaic/docs/mosaic_configuration/mapping_ambassador_config/">
<meta name="theme-color" content="#68145C">
<script src="/mosaic/js/mathjax-config.js"></script>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/academicons/1.8.6/css/academicons.min.css" integrity="sha512-MCWBwPSput2UWNwyznVFLbD2iUc1e5VsdD1zahsWVzkDSUzyHhMZ4kCS3wgYSRm0mU+glwD/Q9lSJrDPwbUL2A==" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0-1/css/all.min.css" integrity="sha512-ZYg+hQvLlM0W9C3P6vTpes5LmJ66G2EsroxDNzwD6qiulckldb29eD9I672HL2X+LH5nRhY1sQqZLJGB+aUUPg==" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/fancybox/3.5.7/jquery.fancybox.min.css" integrity="sha512-H9jrZiiopUdsLpg94A333EfumgUBpO9MdbxStdeITo+KEIMaNfHNvwyjjDJb+ERPaRS6DpyRlKbvPUasNItRyw==" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/styles/atom-one-light.min.css" crossorigin="anonymous" title="hl-light">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/styles/atom-one-light.min.css" crossorigin="anonymous" title="hl-dark" disabled>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/leaflet/1.5.1/leaflet.css" integrity="sha512-xwE/Az9zrjBIphAcBb3F6JVqxf46+CDLwfLMHloNu6KEQCAWi6HcDUbeOfBIptF7tcCzusKFjFw2yuvEpDL9wQ==" crossorigin="anonymous">
<script src="https://cdnjs.cloudflare.com/ajax/libs/lazysizes/5.2.2/lazysizes.min.js" integrity="sha512-TmDwFLhg3UA4ZG0Eb4MIyT1O1Mb+Oww5kFG0uHqXsdbyZz9DcvYQhKpGgNkamAI6h2lGGZq2X8ftOJvF/XjTUg==" crossorigin="anonymous" async></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.1.0/es5/tex-chtml.min.js" integrity="sha512-uwL1UtpYdWra2iqJlAW8Ts0s9Os6IxWLDJDF/BnWdhDmT7DEMFba3GPsFwmV3QiTNcUyl2GB5vsgycB/MOvo9g==" crossorigin="anonymous" async></script>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,400i,700,700i%7CRoboto+Mono&display=swap">
<link rel="stylesheet" href="/mosaic/css/academic.css">
<link rel="alternate" href="/mosaic/docs/mosaic_configuration/mapping_ambassador_config/index.xml" type="application/rss+xml" title="Eclipse MOSAIC – A Multi-Domain and Multi-Scale Simulation Framework for Connected and Automated Mobility">
<link rel="manifest" href="/mosaic/index.webmanifest">
<link rel="icon" type="image/png" href="/mosaic/images/icon_hu6bdfb97c7e23190c70e41ca0e15a9fce_30436_32x32_fill_lanczos_center_2.png">
<link rel="apple-touch-icon" type="image/png" href="/mosaic/images/icon_hu6bdfb97c7e23190c70e41ca0e15a9fce_30436_192x192_fill_lanczos_center_2.png">
<link rel="canonical" href="https://staging.eclipse.org/mosaic/docs/mosaic_configuration/mapping_ambassador_config/">
<meta property="twitter:card" content="summary">
<meta property="og:site_name" content="Eclipse MOSAIC – A Multi-Domain and Multi-Scale Simulation Framework for Connected and Automated Mobility">
<meta property="og:url" content="https://staging.eclipse.org/mosaic/docs/mosaic_configuration/mapping_ambassador_config/">
<meta property="og:title" content="Mapping Ambassador Configuration | Eclipse MOSAIC – A Multi-Domain and Multi-Scale Simulation Framework for Connected and Automated Mobility">
<meta property="og:description" content=""><meta property="og:image" content="https://staging.eclipse.org/mosaic/images/logo.svg">
<meta property="twitter:image" content="https://staging.eclipse.org/mosaic/images/logo.svg"><meta property="og:locale" content="en-us">
<title>Mapping Ambassador Configuration | Eclipse MOSAIC – A Multi-Domain and Multi-Scale Simulation Framework for Connected and Automated Mobility</title>
</head>
<body id="top" data-spy="scroll" data-offset="70" data-target="#TableOfContents" class=" page-mosaic page-docs page-mosaic_configuration page-mapping_ambassador_config ">
<aside class="search-results" id="search">
<div class="container">
<section class="search-header">
<div class="row no-gutters justify-content-between mb-3">
<div class="col-10 col-md-3">
<div class="logo" style="background-image: url(/mosaic/img/logos/mosaic/EclipseMOSAIC-Logo-RGB-positiv.svg)"></div>
</div>
<div class="col-2 col-md-4 col-search-close">
<a class="js-search" href="#"><i class="fas fa-times-circle text-muted" aria-hidden="true"></i></a>
</div>
</div>
<div id="search-box">
<input name="q" id="search-query" placeholder="Search..." autocapitalize="off"
autocomplete="off" autocorrect="off" spellcheck="false" type="search">
</div>
</section>
<section class="section-search-results">
<div id="search-hits">
</div>
</section>
</div>
</aside>
<nav class="navbar navbar-expand-lg navbar-light compensate-for-scrollbar" id="navbar-main">
<div class="container">
<div class="d-none d-lg-inline-flex">
<a style="visibility:visible;" class="navbar-brand" href="/mosaic/"><img src="/mosaic/images/logo.svg" alt="Eclipse MOSAIC – A Multi-Domain and Multi-Scale Simulation Framework for Connected and Automated Mobility"></a>
</div>
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar-content-mobile" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
<span><i class="fas fa-bars"></i></span>
</button>
<div class="navbar-brand-mobile-wrapper d-inline-flex d-lg-none">
<a class="navbar-brand" href="/mosaic/"><img src="/mosaic/images/logo.svg" alt="Eclipse MOSAIC – A Multi-Domain and Multi-Scale Simulation Framework for Connected and Automated Mobility"></a>
</div>
<div id="navbar-content" class="navbar-collapse main-menu-item collapse justify-content-start">
<ul class="navbar-nav d-md-inline-flex">
<li class="nav-item">
<a class="nav-link " href="/mosaic/about/"><span>About</span></a>
</li>
<li class="nav-item">
<a class="nav-link " href="/mosaic/news/"><span>News</span></a>
</li>
<li class="nav-item">
<a class="nav-link active" href="/mosaic/docs/"><span>Documentation</span></a>
</li>
<li class="nav-item">
<a class="nav-link " href="/mosaic/tutorials/"><span>Tutorials</span></a>
</li>
<li class="nav-item">
<a class="nav-link " href="/mosaic/download/"><span>Download</span></a>
</li>
<li class="nav-item">
<a class="nav-link " href="/mosaic/community/"><span>Community</span></a>
</li>
</ul>
</div>
<ul class="nav-icons navbar-nav flex-row ml-auto d-flex pl-md-2">
<li class="nav-item">
<a class="nav-link js-search" href="#" aria-label="Search"><i class="fas fa-search" aria-hidden="true"></i></a>
</li>
<li class="nav-item ">
<a href="https://github.com/eclipse/mosaic" target="blank">
<i class="fab fa-github" aria-hidden="true"></i>
</a>
</li>
</ul>
<div id="navbar-content-mobile" class="navbar-collapse main-menu-item collapse justify-content-start d-lg-none">
<ul class="navbar-nav d-inline-flex">
<li class="nav-item">
<a class="nav-link " href="/mosaic/about/"><span>About</span></a>
</li>
<li class="nav-item">
<a class="nav-link " href="/mosaic/news/"><span>News</span></a>
</li>
<li class="nav-item">
<a class="nav-link active" href="/mosaic/docs/"><span>Documentation</span></a>
</li>
<li class="nav-item">
<a class="nav-link " href="/mosaic/tutorials/"><span>Tutorials</span></a>
</li>
<li class="nav-item">
<a class="nav-link " href="/mosaic/download/"><span>Download</span></a>
</li>
<li class="nav-item">
<a class="nav-link " href="/mosaic/community/"><span>Community</span></a>
</li>
</ul>
</div>
</div>
</nav>
<div class="docs container">
<div class="row flex-xl-nowrap">
<div class="docs-sidebar col-12 col-md-3 col-xl-3">
<div class="docs-version">
<a class="" data-bs-toggle="tooltip" data-bs-placement="bottom" title="The documentation corresponds to the latest version of Eclipse MOSAIC 21.1-SNAPSHOT." href="https://github.com/eclipse/mosaic">
<i class="fab fa-github"></i>&nbsp;Eclipse MOSAIC 21.1-SNAPSHOT
</a>
</div>
<form class="docs-search d-flex align-items-center">
<button class="btn docs-toggle d-md-none p-0 mr-3" type="button" data-bs-toggle="collapse" data-bs-target="#docs-nav" aria-controls="docs-nav" aria-expanded="false" aria-label="Toggle section navigation">
<span><i class="fas fa-bars"></i></span>
</button>
<input name="q" type="search" class="form-control" placeholder="Search..." autocomplete="off">
</form>
<nav class="collapse docs-links" id="docs-nav">
<div class="docs-toc-item">
<a class="docs-toc-link" href="/mosaic/docs/getting_started/">Getting Started</a>
<ul class="nav docs-sidenav">
<li >
<a href="/mosaic/docs/getting_started/">Download</a>
</li>
<li >
<a href="/mosaic/docs/getting_started/run_mosaic/">Run Eclipse MOSAIC</a>
</li>
<li >
<a href="/mosaic/docs/getting_started/results/">Simulation Results</a>
</li>
</ul>
</div>
<div class="docs-toc-item">
<a class="docs-toc-link" href="/mosaic/docs/visualization/">Visualization</a>
<ul class="nav docs-sidenav">
<li >
<a href="/mosaic/docs/visualization/">WebSocket Visualizer</a>
</li>
<li >
<a href="/mosaic/docs/visualization/filevis/">File Output</a>
</li>
<li >
<a href="/mosaic/docs/visualization/statistics/">Statistics Output</a>
</li>
<li >
<a href="/mosaic/docs/visualization/itef/">ITEF</a>
</li>
<li >
<a href="/mosaic/docs/visualization/phabmap/">PHABMap</a>
</li>
</ul>
</div>
<div class="docs-toc-item">
<a class="docs-toc-link" href="/mosaic/docs/simulators/">Simulators</a>
<ul class="nav docs-sidenav">
<li >
<a href="/mosaic/docs/simulators/">Overview</a>
</li>
<li >
<a href="/mosaic/docs/simulators/application_simulator/">Application - Simulator</a>
</li>
<li >
<a href="/mosaic/docs/simulators/application_mapping/">Application - Mapping</a>
</li>
<li >
<a href="/mosaic/docs/simulators/traffic_simulator_sumo/">Traffic - Eclipse SUMO</a>
</li>
<li >
<a href="/mosaic/docs/simulators/network_simulator_omnetpp/">Network - OMNeT&#43;&#43;</a>
</li>
<li >
<a href="/mosaic/docs/simulators/network_simulator_ns3/">Network - ns-3</a>
</li>
<li >
<a href="/mosaic/docs/simulators/network_simulator_sns/">Network - SNS</a>
</li>
<li >
<a href="/mosaic/docs/simulators/network_simulator_cell/">Network - Cell</a>
</li>
<li >
<a href="/mosaic/docs/simulators/environment_simulator/">Environment Simulator</a>
</li>
<li >
<a href="/mosaic/docs/simulators/battery_simulator/">Battery Simulator</a>
</li>
<li >
<a href="/mosaic/docs/simulators/vms_simulator/">VMS Simulator</a>
</li>
</ul>
</div>
<div class="docs-toc-item">
<a class="docs-toc-link" href="/mosaic/docs/building_scenarios/">Building Scenarios</a>
<ul class="nav docs-sidenav">
<li >
<a href="/mosaic/docs/building_scenarios/">Simulation Scenarios</a>
</li>
<li >
<a href="/mosaic/docs/building_scenarios/scenario_convert/">Scenario Convert</a>
</li>
<li >
<a href="/mosaic/docs/building_scenarios/scenario_configuration/">Additional Scenario Configuration</a>
</li>
</ul>
</div>
<div class="docs-toc-item">
<a class="docs-toc-link" href="/mosaic/docs/develop_applications/">Create Applications</a>
<ul class="nav docs-sidenav">
<li >
<a href="/mosaic/docs/develop_applications/">Basics</a>
</li>
<li >
<a href="/mosaic/docs/develop_applications/communication/">V2X Communication</a>
</li>
<li >
<a href="/mosaic/docs/develop_applications/event_scheduler/">Event Scheduling</a>
</li>
<li >
<a href="/mosaic/docs/develop_applications/road_traffic/">Scenario Database</a>
</li>
</ul>
</div>
<div class="docs-toc-item">
<a class="docs-toc-link" href="/mosaic/docs/mosaic_configuration/">MOSAIC Configuration</a>
<ul class="nav docs-sidenav">
<li >
<a href="/mosaic/docs/mosaic_configuration/">Configuration Files</a>
</li>
<li >
<a href="/mosaic/docs/mosaic_configuration/scenario_config/">Scenario Configuration</a>
</li>
<li class="active">
<a href="/mosaic/docs/mosaic_configuration/mapping_ambassador_config/">Mapping Configuration</a>
</li>
<li >
<a href="/mosaic/docs/mosaic_configuration/environment_config/">Environment Configuration</a>
</li>
<li >
<a href="/mosaic/docs/mosaic_configuration/sns_config/">SNS Configuration</a>
</li>
<li >
<a href="/mosaic/docs/mosaic_configuration/cell_config/">Cell Basic Configuration</a>
</li>
<li >
<a href="/mosaic/docs/mosaic_configuration/cell_network_config/">Cell Network Configuration</a>
</li>
<li >
<a href="/mosaic/docs/mosaic_configuration/cell_region_config/">Cell Region Configuration</a>
</li>
<li >
<a href="/mosaic/docs/mosaic_configuration/sumo_config/">SUMO Configuration</a>
</li>
</ul>
</div>
<div class="docs-toc-item">
<a class="docs-toc-link" href="/mosaic/docs/extending_mosaic/">Extending Eclipse MOSAIC</a>
<ul class="nav docs-sidenav">
<li >
<a href="/mosaic/docs/extending_mosaic/">Core Concepts</a>
</li>
<li >
<a href="/mosaic/docs/extending_mosaic/simulator_coupling/">Simulator Coupling</a>
</li>
<li >
<a href="/mosaic/docs/extending_mosaic/interactions/">Interactions</a>
</li>
<li >
<a href="/mosaic/docs/extending_mosaic/application_ambassador_details/">Application Ambassador</a>
</li>
<li >
<a href="/mosaic/docs/extending_mosaic/sumo_ambassador_details/">Sumo Ambassador</a>
</li>
<li >
<a href="/mosaic/docs/extending_mosaic/omnetpp_details/">OMNeT&#43;&#43; Federate</a>
</li>
<li >
<a href="/mosaic/docs/extending_mosaic/delay_models/">Delay Models</a>
</li>
</ul>
</div>
<div class="docs-toc-item">
<a class="docs-toc-link" href="/mosaic/docs/api_docs/">API Documentation</a>
<ul class="nav docs-sidenav">
<li >
<a href="/mosaic/docs/api_docs/">Javadoc</a>
</li>
</ul>
</div>
<div class="nav-bottom">
<img src="/mosaic/img/logos/mosaic/EclipseMOSAIC-Medallion-RGB-single-navy.svg">
</div>
</nav>
</div>
<div class="docs-toc d-none d-xl-block col-xl-2">
<ul class="nav toc-top">
<li><a href="#" id="back_to_top" class="docs-toc-title">Contents</a></li>
</ul>
<nav id="TableOfContents">
<ul>
<li><a href="#mapping">Mapping</a>
<ul>
<li><a href="#mappingtypedistributions">Mapping.typeDistributions</a></li>
</ul>
</li>
<li><a href="#config">config</a></li>
<li><a href="#prototype">prototype</a>
<ul>
<li><a href="#prototypevehicleclass">prototype.vehicleClass</a></li>
</ul>
</li>
<li><a href="#typedistribution">typeDistribution</a></li>
<li><a href="#vehicle">vehicle</a>
<ul>
<li><a href="#vehicledepartspeedmode">vehicle.departSpeedMode</a></li>
<li><a href="#vehiclelaneselectionmode">vehicle.laneSelectionMode</a></li>
<li><a href="#vehiclespawningmode">vehicle.spawningMode</a></li>
</ul>
</li>
<li><a href="#geocircle">geoCircle</a></li>
<li><a href="#geopoint">GeoPoint</a></li>
<li><a href="#matrixmapper">matrixMapper</a></li>
<li><a href="#odpoint">odPoint</a></li>
<li><a href="#rsu">rsu</a></li>
<li><a href="#server">server</a></li>
<li><a href="#tmc">tmc</a></li>
<li><a href="#trafficlights">trafficLights</a></li>
<li><a href="#chargingstation">chargingStation</a></li>
<li><a href="#chargingspot">chargingSpot</a></li>
</ul>
</nav>
</div>
<style>
@media (min-width:1140px) {
.docs-sidebar {
flex: 0 1 320px;
}
.docs-toc {
flex: 0 1 280px;
}
main.docs-content.no-docs-toc {
padding-bottom: 0 !important;
max-width: calc(100% - 320px) !important;
flex: 0 1 calc(100% - 320px);
width: 100%;
}
main.docs-content {
padding-bottom: 0 !important;
max-width: calc(100% - 600px) !important;
flex: 0 1 calc(100% - 600px);
width: 100%;
}
}
@media (max-width: 770px) {
main.docs-content {
max-width: 100% !important;
width: 100%;
}
}
@media (min-width: 771px) and(max-width: 1139px) {
main.docs-content.no-docs-toc {
padding-bottom: 0 !important;
max-width: calc(100% - 320px) !important;
width: 100%;
}
}
</style>
<main class="docs-content col-12 col-md-9 col-xl-auto py-md-3 pl-md-4" role="main">
<article class="article">
<div class="docs-article-container">
<h1>Mapping Ambassador Configuration</h1>
<div class="article-style">
<div class="alert alert-tip">
<div>
<p>You can use a <a href="/mosaic/docs/mosaic_configuration/#readable-units" title="Readable Unit">Readable Unit</a> anywhere where you
have the option of:</p>
<ul>
<li>
<p><code>number</code> <strong>or</strong> <code>string</code></p>
</li>
<li>
<p><code>integer</code> <strong>or</strong> <code>string</code></p>
</div>
</li>
</ul>
</div>
<hr>
<p>📃 <strong>Corresponding configuration file: <code>mapping/mapping_config.json</code></strong></p>
<hr>
<p><a name="reference-mapping"></a></p>
<h2 id="mapping">Mapping</h2>
<p>This schema describes the JSON file structure for the mapping configuration, which is used to define simulation entities.</p>
<p><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
<th>Boundaries</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>config</td>
<td>
<a href="#reference-config">
<code>config</code>
</a>
</td>
<td>Object to define additional configuration options for the mapping</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>prototypes</td>
<td>
<a href="#reference-prototype">
<code>prototype[]</code>
</a>
</td>
<td>Array of prototypes, which can complete the definitions of other objects. This can be used to re-use certain configurations. All possible properties of objects are available. Only the ones needed will be used (for example an RSU does not have a length, so this property would be ignored).</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>typeDistributions</td>
<td>
<a href="#reference-typedistribution">
<code>typeDistribution</code>
</a>
</td>
<td>Object to define the distribution of prototypes to reuse in vehicle spawners. A typeDistribution is referenced by it&rsquo;s attribute name, which can be set to any valid string.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>vehicles</td>
<td>
<a href="#reference-vehicle">
<code>vehicle[]</code>
</a>
</td>
<td>Array of vehicles to be spawned in the simulation. This property describes the vehicles populatingthe simulation. It is possible to create a single vehicle (maxNumberVehicles should be &lsquo;1&rsquo; in that case) or a streamof one or multiple vehicles. The type(s) are defined in the field types. When more than one type is defined theweights in the prototype can be used to balance them against each other.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>matrixMappers</td>
<td>
<a href="#reference-matrixmapper">
<code>matrixMapper[]</code>
</a>
</td>
<td>Array of items to define additional traffic that will be spawned using OD-matrices.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>rsus</td>
<td>
<a href="#reference-rsu">
<code>rsu[]</code>
</a>
</td>
<td>Array of Road Side Units (RSUs). For RSUs only applications can be defined along with the position.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>servers</td>
<td>
<a href="#reference-server">
<code>server[]</code>
</a>
</td>
<td>Array of servers. Servers are a form of units that have no geographical location. The network properties of a server can be defined in the network.json-configuration in the cell-module.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>tmcs</td>
<td>
<a href="#reference-tmc">
<code>tmc[]</code>
</a>
</td>
<td>Array of Traffic Management Centers (TMCs). TMCs are specialized forms of servers having direct access to data collected by induction loops and lane area detectors. The network properties of a TMC can be defined in the network.json-configuration in the cell-module.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>trafficLights</td>
<td>
<a href="#reference-trafficlights">
<code>trafficLights[]</code>
</a>
</td>
<td>Array of prototypes for traffic lights. Since it is a traffic light only applications can be defined. Traffic light prototypes can be distributed among all traffic lights of an application by weight or assigned to specific traffic lights by using the ID of traffic light groups as reference.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>chargingStations</td>
<td>
<a href="#reference-chargingstation">
<code>chargingStation[]</code>
</a>
</td>
<td>Array of electric vehicle charging stations based on ETSI TS 101 556-1. An infrastructure which provides one or several electric vehicle charging spots to supply electric energy for charging electric vehicles.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
</tbody>
</table>
<p><strong>Further property restrictions:</strong><br>
<a name="restriction-mappingtypedistributions"></a></p>
<h3 id="mappingtypedistributions">Mapping.typeDistributions</h3>
<ul>
<li><strong>Type of each property</strong>: <code>array</code></li>
</ul>
<hr>
<p><a name="reference-config"></a></p>
<h2 id="config">config</h2>
<p>Object to define additional configuration options for the mapping</p>
<p><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
<th>Boundaries</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>start</td>
<td><code>number</code></td>
<td>Defines the point in time (in seconds) to start spawning vehicles. If not set (default), all vehicles will be spawned according to the vehicles configuration.</td>
<td>No</td>
<td>[0, +$\infty$]</td>
<td>None</td>
</tr>
<tr>
<td>end</td>
<td><code>number</code></td>
<td>Defines the point in time (in seconds) to end spawning vehicles. If not set (default), all vehicles will be spawned according to the vehicles configuration or until the simulation ends.</td>
<td>No</td>
<td>[0, +$\infty$]</td>
<td>None</td>
</tr>
<tr>
<td>scaleTraffic</td>
<td><code>number</code></td>
<td>Scales the traffic by the given factor. E.g. 2.0 would double the number of spawned vehicles</td>
<td>No</td>
<td>[0, +$\infty$]</td>
<td><code>1</code></td>
</tr>
<tr>
<td>adjustStartingTimes</td>
<td><code>boolean</code></td>
<td>If set to true and if the parameter start is set, the starting times of each spawner is adjusted accordingly, so that we shouldn&rsquo;t wait in case that the simulation starting time and spawner starting time are widely spread out. All spawners before start will be completely ignored then.</td>
<td>No</td>
<td>None</td>
<td><code>false</code></td>
</tr>
<tr>
<td>randomizeFlows</td>
<td><code>boolean</code></td>
<td>If set to true, all flow definitions defined by vehicle spawners with more than one vehicle resulting in slightly randomized departure times. The specified <code>targetFlow</code> of the vehicle spawner is kept.</td>
<td>No</td>
<td>None</td>
<td><code>false</code></td>
</tr>
<tr>
<td>randomizeStartingTimes</td>
<td><code>boolean</code></td>
<td>If set to true, the starting times of all vehicle spawner definitions are randomized by +-60seconds.</td>
<td>No</td>
<td>None</td>
<td><code>false</code></td>
</tr>
<tr>
<td>randomizeWeights</td>
<td><code>boolean</code></td>
<td>If set to true, the configured weights of all types are slightly randomized by +-1% of the sum of all weights.</td>
<td>No</td>
<td>None</td>
<td><code>false</code></td>
</tr>
</tbody>
</table>
<hr>
<p><a name="reference-prototype"></a></p>
<h2 id="prototype">prototype</h2>
<p>Object to define a prototype, which can complete the definitions of other objects. This can be used to re-use certain configurations. All possible properties of objects are available. Only the ones needed will be used (for example an RSU does not have a length, so this property would be ignored).</p>
<p><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
<th>Boundaries</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td><code>string</code></td>
<td>The name of this prototype is used to match it against other objects.</td>
<td>✓ Yes</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>group</td>
<td><code>string</code></td>
<td>The group name is used for (statistical) evaluation purposes with the StatisticOutput and ITEF. It allows to summarize multiple prototype entities.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>accel</td>
<td><code>number</code></td>
<td>Acceleration in m/s^2.</td>
<td>No</td>
<td>(0, +$\infty$]</td>
<td>None</td>
</tr>
<tr>
<td>decel</td>
<td><code>number</code></td>
<td>Deceleration in m/s^2.</td>
<td>No</td>
<td>(0, +$\infty$]</td>
<td>None</td>
</tr>
<tr>
<td>length</td>
<td><code>string</code><br><code>number</code></td>
<td>Length of the vehicle. If defined as a number, then the default unit is m. Alternatively this can be defined as a string to specify the unit of measurement (e.g. &lsquo;500 cm&rsquo;).</td>
<td>No</td>
<td>(0, +$\infty$]</td>
<td>None</td>
</tr>
<tr>
<td>maxSpeed</td>
<td><code>string</code><br><code>number</code></td>
<td>Maximal speed. If defined as a number, then the default unit is m/s. Alternatively this can be defined as a string to include the unit of measurement (e.g. &lsquo;50 kmh&rsquo;).</td>
<td>No</td>
<td>(0, +$\infty$]</td>
<td>None</td>
</tr>
<tr>
<td>minGap</td>
<td><code>string</code><br><code>number</code></td>
<td>Distance in meter between front bumper of a vehicle and the back bumper of its leader in a traffic jam. If defined as a number, then the default unit is m. Alternatively this can be defined as a string to include the unit of measurement (e.g. &lsquo;300 cm&rsquo;).</td>
<td>No</td>
<td>(0, +$\infty$]</td>
<td>None</td>
</tr>
<tr>
<td>sigma</td>
<td><code>number</code></td>
<td>Driver imperfection. This is a parameter of the car-following model.</td>
<td>No</td>
<td>[0, 1]</td>
<td>None</td>
</tr>
<tr>
<td>tau</td>
<td><code>number</code></td>
<td>Driver reaction time in seconds. This is a parameter of the car-following model.</td>
<td>No</td>
<td>[0, +$\infty$]</td>
<td>None</td>
</tr>
<tr>
<td>weight</td>
<td><code>number</code></td>
<td>The weight is used to distribute objects between multiple types. All weights do NOT have to add up to 1 or 100. (Example: A vehicle spawner defining a traffic stream contains two prototypeDeserializers with the weights being 4 and 6. The resulting traffic stream will consist to 40% of the one type and 60% of the other)</td>
<td>No</td>
<td>[0, +$\infty$]</td>
<td>None</td>
</tr>
<tr>
<td>vehicleClass</td>
<td><code>string</code></td>
<td>Class of the vehicle. The classes are used in lane definitions and allow/disallow the use of lanes for certain vehicle types (e.g. a taxi lane).</td>
<td>No</td>
<td>Enum
<a href="#restriction-prototypevehicleclass">
<i class="fas fa-info-circle"></i>
</a>
</td>
<td>None</td>
</tr>
<tr>
<td>applications</td>
<td><code>string[]</code></td>
<td>The applications to be used for this object.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
</tbody>
</table>
<p><strong>Further property restrictions:</strong><br>
<a name="restriction-prototypevehicleclass"></a></p>
<h3 id="prototypevehicleclass">prototype.vehicleClass</h3>
<ul>
<li><strong>Allowed values</strong>:
<ul>
<li><code>Unknown</code></li>
<li><code>Car</code></li>
<li><code>LightGoodsVehicle</code></li>
<li><code>HeavyGoodsVehicle</code></li>
<li><code>PublicTransportVehicle</code></li>
<li><code>EmergencyVehicle</code></li>
<li><code>WorksVehicle</code></li>
<li><code>ExceptionalSizeVehicle</code></li>
<li><code>VehicleWithTrailer</code></li>
<li><code>HighSideVehicle</code></li>
<li><code>MiniBus</code></li>
<li><code>Taxi</code></li>
<li><code>ElectricVehicle</code></li>
<li><code>AutomatedVehicle</code></li>
<li><code>Bicycle</code></li>
<li><code>Motorcycle</code></li>
<li><code>HighOccupancyVehicle</code></li>
</ul>
</li>
</ul>
<hr>
<p><a name="reference-typedistribution"></a></p>
<h2 id="typedistribution">typeDistribution</h2>
<p>Object to define the distribution of prototypes to reuse in vehicle spawners. A typeDistribution is referenced by it&rsquo;s attribute name, which can be set to any valid string.</p>
<p><strong>The following additional properties are allowed:</strong></p>
<ul>
<li>array[
<a href="#reference-prototype">
prototype
</a>
]</li>
</ul>
<hr>
<p><a name="reference-vehicle"></a></p>
<h2 id="vehicle">vehicle</h2>
<p>Object to define vehicles to be spawned in the simulation. This property describes the vehicles populating the simulation. It is possible to create a single vehicle (maxNumberVehicles should be &lsquo;1&rsquo; 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 prototype can be used to balance them against each other.</p>
<p><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
<th>Boundaries</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>startingTime</td>
<td><code>number</code></td>
<td>Time at which the first vehicle will be created.</td>
<td>No</td>
<td>[0, +$\infty$]</td>
<td><code>0</code></td>
</tr>
<tr>
<td>maxTime</td>
<td><code>number</code></td>
<td>Simulation time in seconds at which no more vehicles will be created.</td>
<td>No</td>
<td>[0, +$\infty$]</td>
<td>None</td>
</tr>
<tr>
<td>targetFlow</td>
<td><code>number</code></td>
<td>Density of vehicles per hour. Vehicles will be spawned uniformly.</td>
<td>No</td>
<td>[0, +$\infty$]</td>
<td><code>600</code></td>
</tr>
<tr>
<td>maxNumberVehicles</td>
<td><code>number</code></td>
<td>Maximum number of vehicles to be created from this source.</td>
<td>No</td>
<td>[0, +$\infty$]</td>
<td>None</td>
</tr>
<tr>
<td>departSpeed</td>
<td><code>string</code><br><code>number</code></td>
<td>The speed at which the vehicle is supposed to depart. If defined as a number, then the default unit is m/s. Alternatively this can be defined as a string to include the unit of measurement (e.g. &lsquo;10 kmh&rsquo;). Depending on the simulator this value may only be used if departSpeedMode is set to PRECISE.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>departSpeedMode</td>
<td><code>string</code></td>
<td>The depart speed mode determines the vehicle&rsquo;s speed at insertion.</td>
<td>No</td>
<td>Enum
<a href="#restriction-vehicledepartspeedmode">
<i class="fas fa-info-circle"></i>
</a>
</td>
<td><code>MAXIMUM</code></td>
</tr>
<tr>
<td>laneSelectionMode</td>
<td><code>string</code></td>
<td>The lane selection mode chooses the lane for the next departing vehicle.</td>
<td>No</td>
<td>Enum
<a href="#restriction-vehiclelaneselectionmode">
<i class="fas fa-info-circle"></i>
</a>
</td>
<td><code>DEFAULT</code></td>
</tr>
<tr>
<td>spawningMode</td>
<td><code>string</code></td>
<td>Adjusts the departure time of individual vehicles.</td>
<td>No</td>
<td>Enum
<a href="#restriction-vehiclespawningmode">
<i class="fas fa-info-circle"></i>
</a>
</td>
<td><code>CONSTANT</code></td>
</tr>
<tr>
<td>deterministic</td>
<td><code>boolean</code></td>
<td>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.</td>
<td>No</td>
<td>None</td>
<td><code>true</code></td>
</tr>
<tr>
<td>pos</td>
<td><code>number</code></td>
<td>Position within the route where the vehicle(s) should be spawned.</td>
<td>No</td>
<td>[0, +$\infty$]</td>
<td><code>0</code></td>
</tr>
<tr>
<td>route</td>
<td><code>string</code></td>
<td>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).</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>lanes</td>
<td><code>number[]</code></td>
<td>Array of numbers to define the 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.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>types</td>
<td>
<a href="#reference-prototype">
<code>prototype[1-*]</code>
</a>
</td>
<td>List of possible vehicle types to be spawned. In this list you can simply refer to an existing prototype by its name attribute to include everything defined there. You can also overwrite every attribute of the prototype. If you don&rsquo;t have an existing prototype the definitions found here will be used as the prototype definition itself.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>typeDistribution</td>
<td><code>string</code></td>
<td>Identifier of the typeDistribution which defines the distribution of vehicle types.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>destination</td>
<td>
<a href="#reference-geocircle">
<code>geoCircle</code>
</a>
</td>
<td>Object to define an immutable pair of a geoPoint center position and a radius in meters.</td>
<td>✓ Yes</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>origin</td>
<td>
<a href="#reference-geocircle">
<code>geoCircle</code>
</a>
</td>
<td>Object to define an immutable pair of a geoPoint center position and a radius in meters.</td>
<td>✓ Yes</td>
<td>None</td>
<td>None</td>
</tr>
</tbody>
</table>
<p><strong>Further property restrictions:</strong><br>
<a name="restriction-vehicledepartspeedmode"></a></p>
<h3 id="vehicledepartspeedmode">vehicle.departSpeedMode</h3>
<ul>
<li><strong>Allowed values</strong>:
<ul>
<li><code>PRECISE</code></li>
<li><code>RANDOM</code></li>
<li><code>MAXIMUM</code>
<a name="restriction-vehiclelaneselectionmode"></a></li>
</ul>
</li>
</ul>
<h3 id="vehiclelaneselectionmode">vehicle.laneSelectionMode</h3>
<ul>
<li><strong>Allowed values</strong>:
<ul>
<li><code>DEFAULT</code></li>
<li><code>ROUNDROBIN</code></li>
<li><code>ROUNDROBIN_HIGHWAY</code></li>
<li><code>HIGHWAY</code></li>
<li><code>RANDOM</code></li>
<li><code>FREE</code></li>
<li><code>ALLOWED</code></li>
<li><code>BEST</code></li>
<li><code>FIRST</code>
<a name="restriction-vehiclespawningmode"></a></li>
</ul>
</li>
</ul>
<h3 id="vehiclespawningmode">vehicle.spawningMode</h3>
<ul>
<li><strong>Allowed values</strong>:
<ul>
<li><code>CONSTANT</code></li>
<li><code>GROW</code></li>
<li><code>POISSON</code></li>
<li><code>SHRINK</code></li>
<li><code>GROW_AND_SHRINK</code></li>
<li><code>GROW_EXPONENTIAL</code></li>
<li><code>SHRINK_EXPONENTIAL</code></li>
<li><code>GROW_AND_SHRINK_EXPONENTIAL</code></li>
</ul>
</li>
</ul>
<hr>
<p><a name="reference-geocircle"></a></p>
<h2 id="geocircle">geoCircle</h2>
<p>Object to define an immutable pair of a geoPoint center position and a radius in meters.</p>
<p><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
<th>Boundaries</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>center</td>
<td>
<a href="#reference-geopoint">
<code>geoPoint</code>
</a>
</td>
<td>Object to define geographical point coordinates.</td>
<td>✓ Yes</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>radius</td>
<td><code>number</code></td>
<td>Radius of the circle.</td>
<td>✓ Yes</td>
<td>[0, +$\infty$]</td>
<td>None</td>
</tr>
</tbody>
</table>
<hr>
<p><a name="reference-geopoint"></a></p>
<h2 id="geopoint">GeoPoint</h2>
<p>Object to define geographical point coordinates.</p>
<p><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
<th>Boundaries</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>longitude</td>
<td><code>number</code></td>
<td>East-west position of a point on earth.</td>
<td>✓ Yes</td>
<td>[-180, 180]</td>
<td>None</td>
</tr>
<tr>
<td>latitude</td>
<td><code>number</code></td>
<td>North-south position of a point on earth.</td>
<td>✓ Yes</td>
<td>[-$\infty$, 90]</td>
<td>None</td>
</tr>
</tbody>
</table>
<hr>
<p><a name="reference-matrixmapper"></a></p>
<h2 id="matrixmapper">matrixMapper</h2>
<p>Object to define a mapper for an Origin-Destination (OD) matrix. The mapper contains a list of points (with varying radius) and a matrix (arrays) of flow values. It creates a series of conventional vehicles spawners from the specified data.</p>
<p><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
<th>Boundaries</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>points</td>
<td>
<a href="#reference-odpoint">
<code>odPoint[]</code>
</a>
</td>
<td>Array of odPoints that can be referenced from the OD-matrix.</td>
<td>✓ Yes</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>types</td>
<td>
<a href="#reference-prototype">
<code>prototype[]</code>
</a>
</td>
<td>Array of prototypes to define the vehicles that should be spawned.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>deterministic</td>
<td><code>boolean</code></td>
<td>If deterministic is true the spawning-process will be exactly the same with every execution. If left false the order is different and the selected weights will be reached slower than in the deterministic mode.</td>
<td>No</td>
<td>None</td>
<td><code>true</code></td>
</tr>
<tr>
<td>odValues</td>
<td><code>array[]</code></td>
<td>Values for the OD-matrix. Unit should be vehicles/hour.</td>
<td>✓ Yes</td>
<td>None</td>
<td>None</td>
</tr>
</tbody>
</table>
<hr>
<p><a name="reference-odpoint"></a></p>
<h2 id="odpoint">odPoint</h2>
<p>Object to define a point that can be referenced from an OD-matrix.</p>
<p><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
<th>Boundaries</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td><code>string</code></td>
<td>The name of the point. This identifier is used to reference the odPoint.</td>
<td>✓ Yes</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>position</td>
<td>
<a href="#reference-geocircle">
<code>geoCircle</code>
</a>
</td>
<td>Object to define an immutable pair of a geoPoint center position and a radius in meters.</td>
<td>✓ Yes</td>
<td>None</td>
<td>None</td>
</tr>
</tbody>
</table>
<hr>
<p><a name="reference-rsu"></a></p>
<h2 id="rsu">rsu</h2>
<p>Object to define a Road Side Unit (RSU). For RSUs only applications can be defined along with the position.</p>
<p><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
<th>Boundaries</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>position</td>
<td>
<a href="#reference-geopoint">
<code>geoPoint</code>
</a>
</td>
<td>Object to define geographical point coordinates.</td>
<td>✓ Yes</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>name</td>
<td><code>string</code></td>
<td>Used to be matched with a prototype. If a prototype name matches this name, all properties not set in this object will be overwritten by those defined in the prototype.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>group</td>
<td><code>string</code></td>
<td>The group name is used for (statistical) evaluation purposes with the StatisticOutput and ITEF. It allows to summarize multiple rsu entities.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>applications</td>
<td><code>string[]</code></td>
<td>Array of strings that specifies the applications to be used for this object. If none are specified, none are used</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
</tbody>
</table>
<hr>
<p><a name="reference-server"></a></p>
<h2 id="server">server</h2>
<p>Object to define a server. Servers are a form of units that have no geographical location. The network properties of a server can be defined in the network.json-configuration in the cell-module.</p>
<p><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
<th>Boundaries</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td><code>string</code></td>
<td>Used to be matched with a prototype. If a prototype name matches this name, all properties not set in this object will be overwritten by those defined in the prototype.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>group</td>
<td><code>string</code></td>
<td>The group name is used to match with configurations in the network.json-configuration in the cell-module.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>applications</td>
<td><code>string[]</code></td>
<td>The applications to be used for this object. If none are specified, none are used.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
</tbody>
</table>
<hr>
<p><a name="reference-tmc"></a></p>
<h2 id="tmc">tmc</h2>
<p>Object to define a Traffic Management Center (TMCs). TMCs are specialized forms of server directly communicating with induction loops and lane area detectors. The network properties of a TMC can be defined in the network.json-configuration in the cell-module.</p>
<p><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
<th>Boundaries</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td><code>string</code></td>
<td>Used to be matched with a prototype. If a prototype name matches this name, all properties not set in this object will be overwritten by those defined in the prototype.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>group</td>
<td><code>string</code></td>
<td>The group name is used to match with configurations in the network.json-configuration in the cell-module.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>applications</td>
<td><code>string[]</code></td>
<td>The applications to be used for this object. If none are specified, none are used.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>inductionLoops</td>
<td><code>string[]</code></td>
<td>The induction loops the TMC shall be matched with. If none are specified, none are used.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>laneAreaDetectors</td>
<td><code>string[]</code></td>
<td>The lane area detectors the TMC shall be matched with. If none are specified, none are used.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
</tbody>
</table>
<hr>
<p><a name="reference-trafficlights"></a></p>
<h2 id="trafficlights">trafficLights</h2>
<p>Object to define a prototype for a traffic light. Since it is a traffic light only applications can be defined. Traffic light prototypes can be distributed among all traffic lights of an application by weight or assigned to specific traffic lights by using the ID of traffic light groups as reference.</p>
<p><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
<th>Boundaries</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td><code>string</code></td>
<td>Used to be matched with a prototype. If a prototype name matches this name, all properties not set in this object will be overwritten by those defined in the prototype.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>tlGroupId</td>
<td><code>string</code></td>
<td>The ID of a traffic light group. This property is used to map applications to specific traffic lights.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>group</td>
<td><code>string</code></td>
<td>The group name is used for (statistical) evaluation purposes with the StatisticOutput and ITEF. It allows to summarize multiple trafficLights entities.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>weight</td>
<td><code>number</code></td>
<td>The weight is used to distribute traffic lights between multiple default types. If tlGroupId is not set, then the default value is 1, otherwise 0. All weights do NOT have to add up to 1 or 100.</td>
<td>No</td>
<td>[0, +$\infty$]</td>
<td>None</td>
</tr>
<tr>
<td>applications</td>
<td><code>string[]</code></td>
<td>The applications to be used for this object. If none are specified, none are used</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
</tbody>
</table>
<hr>
<p><a name="reference-chargingstation"></a></p>
<h2 id="chargingstation">chargingStation</h2>
<p>Object to define an electric vehicle charging station based on ETSI TS 101 556-1. An infrastructure which provides one or several electric vehicle charging spots to supply electric energy for charging electric vehicles.</p>
<p><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
<th>Boundaries</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>position</td>
<td>
<a href="#reference-geopoint">
<code>geoPoint</code>
</a>
</td>
<td>Object to define geographical point coordinates.</td>
<td>✓ Yes</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>operator</td>
<td><code>string</code></td>
<td>The EV charging station operator (e.g. energy provider) identification.</td>
<td>✓ Yes</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>group</td>
<td><code>string</code></td>
<td>The group name is used for (statistical) evaluation purposes with the StatisticOutput and ITEF. It allows to summarize multiple charginStation entities.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>access</td>
<td><code>string</code></td>
<td>Access restrictions, e.g. open to all or restricted to some communities, free of access or paying access.</td>
<td>✓ Yes</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>name</td>
<td><code>string</code></td>
<td>Used to be matched with a prototype. If a prototype name matches this name, all properties not set in this object will be overwritten by those defined in the prototype.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>chargingSpots</td>
<td>
<a href="#reference-chargingspot">
<code>chargingSpot[]</code>
</a>
</td>
<td>List of the electric vehicle charging spots associated with this electric vehicle charging station.</td>
<td>✓ Yes</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>applications</td>
<td><code>string[]</code></td>
<td>The application to be used for this object.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
</tbody>
</table>
<hr>
<p><a name="reference-chargingspot"></a></p>
<h2 id="chargingspot">chargingSpot</h2>
<p>Object to define an electric vehicle charging spot based on ETSI TS 101 556-1. A set of 1 to 4 parking places arranged around a pole, where it is possible to charge an electric vehicle.</p>
<p><strong>Properties</strong></p>
<table>
<thead>
<tr>
<th></th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
<th>Boundaries</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td><code>number</code></td>
<td>Unique identifier of the charging spot.</td>
<td>No</td>
<td>None</td>
<td>None</td>
</tr>
<tr>
<td>type</td>
<td><code>integer</code></td>
<td>The type of this electric vehicle charging spot in compliance with current standards, including IEC 62196-2.</td>
<td>✓ Yes</td>
<td>[1, 3]</td>
<td>None</td>
</tr>
<tr>
<td>parkingPlaces</td>
<td><code>integer</code></td>
<td>Number of available parking places, i.e. 1 to 4 parking places arranged around a pole.</td>
<td>✓ Yes</td>
<td>[1, 4]</td>
<td>None</td>
</tr>
</tbody>
</table>
</div>
<div class="article-widget">
<div class="post-nav prev-next-pages col-12">
<div class="row">
<div class="post-nav-item col-6">
</div>
<div class="post-nav-item col-6 align-self-end">
</div>
</div>
</div>
</div>
</div>
<footer class="site-footer">
<div class="row">
<div class="col-sm-4 mb-3 mb-md-0">
<b>Eclipse MOSAIC</b>
<ul>
<li>
<a href="/mosaic/download/" title="Download Eclipse MOSAIC" >
Download Eclipse MOSAIC
</a>
</li>
<li>
<a href="/mosaic/docs/" title="Documentation" >
Documentation
</a>
</li>
<li>
<a href="/mosaic/tutorials/" title="Tutorials" >
Tutorials
</a>
</li>
<li>
<a href="/mosaic/community/#projects" title="Projects" >
Projects
</a>
</li>
<li>
<a href="/mosaic/publications/" title="Publications" >
Publications
</a>
</li>
</ul>
</div>
<div class="col-sm-4 mb-3 mb-md-0">
<b>Community</b>
<ul>
<li>
<a href="/mosaic/community/" title="Eclipse MOSAIC Community" >
Eclipse MOSAIC Community
</a>
</li>
<li>
<a href="/mosaic/contribution/" title="How to contribute" >
How to contribute
</a>
</li>
<li>
<a href="https://github.com/eclipse/mosaic" title="Github" target="_blank" rel="noopener">
Github
</a>
</li>
<li>
<a href="/mosaic/get_in_contact/" title="Contact &amp; Mailing list" >
Contact & Mailing list
</a>
</li>
</ul>
</div>
<div class="col-sm-4 mb-3 mb-md-0">
<b>Eclipse Foundation</b>
<ul>
<li>
<a href="https://www.eclipse.org/" title="About Eclipse Foundation" target="_blank" rel="noopener">
About Eclipse Foundation
</a>
</li>
<li>
<a href="https://www.eclipse.org/legal/privacy.php" title="Privacy Policy" target="_blank" rel="noopener">
Privacy Policy
</a>
</li>
<li>
<a href="https://www.eclipse.org/legal/termsofuse.php" title="Website terms of use" target="_blank" rel="noopener">
Website terms of use
</a>
</li>
<li>
<a href="https://www.eclipse.org/legal/copyright.php" title="Copyright" target="_blank" rel="noopener">
Copyright
</a>
</li>
<li>
<a href="https://www.eclipse.org/legal" title="Legal" target="_blank" rel="noopener">
Legal
</a>
</li>
</ul>
</div>
</div>
<div class="row justify-content-center mt-3 position-relative">
<p class="powered-by text-center font-italic mb-0 pb-0">
Powered by the
<a href="https://sourcethemes.com/academic/" target="_blank" rel="noopener">Academic theme</a> for
<a href="https://gohugo.io" target="_blank" rel="noopener">Hugo</a>.
<br>
Header image &#169; fanjianhua/ iStock
</p>
</div>
</footer>
</article>
</main>
</div>
</div>
<script src="https://code.jquery.com/jquery-3.4.1.min.js" integrity="sha384-vk5WoKIaW/vJyUAd9n/wmopsmNhiy+L2Z+SBxGYnUkunIxVxAv/UtMOhba/xskxh" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/2.6.0/umd/popper.min.js" integrity="sha512-BmM0/BQlqh02wuK5Gz9yrbe7VyIVwOzD1o40yi1IsTjriX/NGF37NyXHfmFzIlMmoSIBXgqDiG1VNU6kB5dBbA==" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.imagesloaded/4.1.4/imagesloaded.pkgd.min.js" integrity="sha512-S5PZ9GxJZO16tT9r3WJp/Safn31eu8uWrzglMahDT4dsmgqWonRY9grk3j+3tfuPr9WJNsfooOR7Gi7HL5W2jw==" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.isotope/3.0.6/isotope.pkgd.min.js" integrity="sha512-Zq2BOxyhvnRFXu0+WE6ojpZLOU2jdnqbrM1hmVdGzyeCa1DgM3X5Q4A/Is9xA1IkbUeDd7755dNNI/PzSf2Pew==" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/fancybox/3.5.7/jquery.fancybox.min.js" integrity="sha512-uURl+ZXMBrF4AwGaWmEetzrd+J5/8NRkWAvJx5sbPSSuOb0bZLqf+tOzniObO00BjHa/dD7gub9oCGMLPQHtQA==" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mermaid/8.4.8/mermaid.min.js" integrity="sha512-1tS1YUns336Mtxl+vkaLcADPwE1CPNVy3WEf7nrI7DGMMb6/FAVBgL2IzAWVBkB6vVuK94s2zVoiXcw1QZ9S1g==" crossorigin="anonymous" title="mermaid"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/highlight.min.js" integrity="sha512-1LdB3V708w6G4QRl7NsVdTr7MDibyRXr9stQZ+EGjEE0ZPMZkA//ir7kCWmFyxdAJNIRXdR/ZeJmCV0boyiCXw==" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/languages/java.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/languages/json.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/languages/xml.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/languages/shell.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/languages/dos.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/leaflet/1.5.1/leaflet.js" integrity="sha512-GffPMF3RvMeYyc1LWMHtK8EbPv0iNZ8/oTtHPx9/cc2ILxQ+u905qIwdpULaqDkyBKgOaB57QTMg7ztg8Jm2Og==" crossorigin="anonymous"></script>
<script>const code_highlighting = true;</script>
<script>const isSiteThemeDark = false;</script>
<script>
const search_config = {"indexURI":"/mosaic/index.json","minLength":1,"threshold":0.3};
const i18n = {"no_results":"No results found","placeholder":"Search...","results":"results found"};
const content_type = {
'post': "Posts",
'project': "Projects",
'publication' : "Publications",
'talk' : "Talks"
};
</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.1/anchor.min.js" integrity="sha512-aZotBPy6dqn8yVaLJwSrkJ+QxuxV695A4dgodAMvTU5JyNi5mhrr+LeaD3GSS+lx1SMFKNs0tu5ZMJEgNZQP2Q==" crossorigin="anonymous"></script>
<script>
anchors.add();
</script>
<script id="search-hit-fuse-template" type="text/x-template">
<div class="search-hit" id="summary-{{key}}">
<div class="search-hit-content">
<div class="search-hit-name">
<a href="{{relpermalink}}">{{title}}</a>
<div class="article-metadata search-hit-type">{{type}}</div>
<p class="search-hit-description">{{snippet}}</p>
</div>
</div>
</div>
</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/3.2.1/fuse.min.js" integrity="sha512-o38bmzBGX+hD3JHWUFCDA09btWaqrNmoJ3RXLlrysA7PP01Kgs4UlE4MhelE1v5dJR3+cxlR4qQlotsW7jKsnw==" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/jquery.mark.min.js" integrity="sha512-mhbv5DqBMgrWL+32MmsDOt/OAvqr/cHimk6B8y/bx/xS88MVkYGPiVv2ixKVrkywF2qHplNRUvFsAHUdxZ3Krg==" crossorigin="anonymous"></script>
<script type="application/javascript" src="/mosaic/js/academic.min.0992ad8b8d033c3858bb90b03966346a.js"></script>
<script type="application/javascript" src="/mosaic/js/mosaic-wg-cards.js"></script>
<script type="application/javascript" src="/mosaic/js/mosaic-docs.js"></script>
<script>
var tooltipTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]'))
tooltipTriggerList.map(function (tooltipTriggerEl) {
return new window.bootstrap.Tooltip(tooltipTriggerEl)
})
</script>
<div id="modal" class="modal fade" role="dialog">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h5 class="modal-title">Cite</h5>
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
<span aria-hidden="true">&times;</span>
</button>
</div>
<div class="modal-body">
<pre><code class="tex hljs"></code></pre>
</div>
<div class="modal-footer">
<a class="btn btn-outline-primary my-1 js-copy-cite" href="#" target="_blank">
<i class="fas fa-copy"></i> Copy
</a>
<a class="btn btn-outline-primary my-1 js-download-cite" href="#" target="_blank">
<i class="fas fa-download"></i> Download
</a>
<div id="modal-error"></div>
</div>
</div>
</div>
</div>
</body>
</html>