Google Git
Sign in
eclipse / gerrit / www.eclipse.org / mosaic / 217d1a3f17a8391a16675cbcf59004b3c6a76080 / . / java_docs / org / eclipse / mosaic / fed / application / app / api / CommunicationApplication.html
blob: e6eb1053fba9607fb43fc59c2be14d3b6409366e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_262) on Wed Mar 10 21:50:11 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CommunicationApplication (Eclipse MOSAIC Parent 21.0 API)</title>
<meta name="date" content="2021-03-10">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommunicationApplication (Eclipse MOSAIC Parent 21.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CommunicationApplication.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/ChargingStationApplication.html" title="interface in org.eclipse.mosaic.fed.application.app.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/ElectricVehicleApplication.html" title="interface in org.eclipse.mosaic.fed.application.app.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/mosaic/fed/application/app/api/CommunicationApplication.html" target="_top">Frames</a></li>
<li><a href="CommunicationApplication.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.mosaic.fed.application.app.api</div>
<h2 title="Interface CommunicationApplication" class="title">Interface CommunicationApplication</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/Application.html" title="interface in org.eclipse.mosaic.fed.application.app.api">Application</a>, <a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventProcessor</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../org/eclipse/mosaic/app/tutorial/cam/CamSendingApp.html" title="class in org.eclipse.mosaic.app.tutorial.cam">CamSendingApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/EventSendingApp.html" title="class in org.eclipse.mosaic.app.tutorial">EventSendingApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/TrafficLightApp.html" title="class in org.eclipse.mosaic.app.tutorial">TrafficLightApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/cam/UserTaggedValueReadingApp.html" title="class in org.eclipse.mosaic.app.tutorial.cam">UserTaggedValueReadingApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/WeatherWarningApp.html" title="class in org.eclipse.mosaic.app.tutorial">WeatherWarningApp</a>, <a href="../../../../../../../org/eclipse/mosaic/app/tutorial/WeatherWarningAppCell.html" title="class in org.eclipse.mosaic.app.tutorial">WeatherWarningAppCell</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">CommunicationApplication</span>
extends <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/Application.html" title="interface in org.eclipse.mosaic.fed.application.app.api">Application</a></pre>
<div class="block">All applications that implement some form of V2x communication
are to implement this interface.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/CommunicationApplication.html#onAcknowledgementReceived-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.ReceivedAcknowledgement-">onAcknowledgementReceived</a></span>(<a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/ReceivedAcknowledgement.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">ReceivedAcknowledgement</a>&nbsp;acknowledgement)</code>
<div class="block">Receive an acknowledgement from a previously sent V2X Message.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/CommunicationApplication.html#onCamBuilding-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.CamBuilder-">onCamBuilding</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">This method is called when a CAM is build by different Simulation Units that support CAM connectivity.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/CommunicationApplication.html#onMessageReceived-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.ReceivedV2xMessage-">onMessageReceived</a></span>(<a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/ReceivedV2xMessage.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">ReceivedV2xMessage</a>&nbsp;receivedV2xMessage)</code>
<div class="block">Receive a V2X Message.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/CommunicationApplication.html#onMessageTransmitted-org.eclipse.mosaic.interactions.communication.V2xMessageTransmission-">onMessageTransmitted</a></span>(<a href="../../../../../../../org/eclipse/mosaic/interactions/communication/V2xMessageTransmission.html" title="class in org.eclipse.mosaic.interactions.communication">V2xMessageTransmission</a>&nbsp;v2xMessageTransmission)</code>
<div class="block">This method is called when a V2X message is transmitted.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.fed.application.app.api.Application">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.mosaic.fed.application.app.api.<a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/Application.html" title="interface in org.eclipse.mosaic.fed.application.app.api">Application</a></h3>
<code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/Application.html#onShutdown--">onShutdown</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/Application.html#onStartup--">onStartup</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.lib.util.scheduling.EventProcessor">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.mosaic.lib.util.scheduling.<a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventProcessor</a></h3>
<code><a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html#canProcessEvent--">canProcessEvent</a>, <a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html#processEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">processEvent</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="onMessageReceived-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.ReceivedV2xMessage-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onMessageReceived</h4>
<pre>void&nbsp;onMessageReceived(<a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/ReceivedV2xMessage.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">ReceivedV2xMessage</a>&nbsp;receivedV2xMessage)</pre>
<div class="block">Receive a V2X Message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>receivedV2xMessage</code> - the received message container.</dd>
</dl>
</li>
</ul>
<a name="onAcknowledgementReceived-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.ReceivedAcknowledgement-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onAcknowledgementReceived</h4>
<pre>void&nbsp;onAcknowledgementReceived(<a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/ReceivedAcknowledgement.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">ReceivedAcknowledgement</a>&nbsp;acknowledgement)</pre>
<div class="block">Receive an acknowledgement from a previously sent V2X Message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>acknowledgement</code> - the acknowledgement object which contains the sent V2X Message and the acknowledgement status.</dd>
</dl>
</li>
</ul>
<a name="onCamBuilding-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.CamBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onCamBuilding</h4>
<pre>void&nbsp;onCamBuilding(<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">This method is called when a CAM is build by different Simulation Units that support CAM connectivity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>camBuilder</code> - the builder for the CAM</dd>
</dl>
</li>
</ul>
<a name="onMessageTransmitted-org.eclipse.mosaic.interactions.communication.V2xMessageTransmission-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onMessageTransmitted</h4>
<pre>void&nbsp;onMessageTransmitted(<a href="../../../../../../../org/eclipse/mosaic/interactions/communication/V2xMessageTransmission.html" title="class in org.eclipse.mosaic.interactions.communication">V2xMessageTransmission</a>&nbsp;v2xMessageTransmission)</pre>
<div class="block">This method is called when a V2X message is transmitted.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>v2xMessageTransmission</code> - the container for the V2XMessage to be transmitted</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/CommunicationApplication.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/ChargingStationApplication.html" title="interface in org.eclipse.mosaic.fed.application.app.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/ElectricVehicleApplication.html" title="interface in org.eclipse.mosaic.fed.application.app.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/mosaic/fed/application/app/api/CommunicationApplication.html" target="_top">Frames</a></li>
<li><a href="CommunicationApplication.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2020&#x2013;2021 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p>
</body>
</html>