| <!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>CommunicationModuleOwner (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="CommunicationModuleOwner (Eclipse MOSAIC Parent 20.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/CommunicationModuleOwner.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CellModuleConfiguration.CellCamConfiguration.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/ReceivedAcknowledgement.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html" target="_top">Frames</a></li> |
| <li><a href="CommunicationModuleOwner.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.mosaic.fed.application.ambassador.simulation.communication</div> |
| <h2 title="Interface CommunicationModuleOwner" class="title">Interface CommunicationModuleOwner</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/ChargingStationOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">ChargingStationOperatingSystem</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/ElectricVehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">ElectricVehicleOperatingSystem</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/RoadSideUnitOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">RoadSideUnitOperatingSystem</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">TrafficLightOperatingSystem</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficManagementCenterOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">TrafficManagementCenterOperatingSystem</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/VehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">VehicleOperatingSystem</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">AbstractSimulationUnit</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/ChargingStationUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">ChargingStationUnit</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/ElectricVehicleUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">ElectricVehicleUnit</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/RoadSideUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">RoadSideUnit</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/TrafficLightGroupUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">TrafficLightGroupUnit</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/TrafficManagementCenterUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">TrafficManagementCenterUnit</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/VehicleUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">VehicleUnit</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">CommunicationModuleOwner</span></pre> |
| <div class="block">Interface to be implemented by classes providing a communication module. |
| Requires callback methods for the modules.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CamBuilder.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CamBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#assembleCamMessage-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.CamBuilder-">assembleCamMessage</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CamBuilder.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CamBuilder</a> camBuilder)</code> |
| <div class="block">Assembles a <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CamBuilder.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication"><code>CamBuilder</code></a> (Cooperative Awareness Message) using the |
| given <a href="../../../../../../../../org/eclipse/mosaic/lib/objects/v2x/MessageRouting.html" title="class in org.eclipse.mosaic.lib.objects.v2x"><code>MessageRouting</code></a> and the units' status information.</div> |
| </td> |
| </tr> |
| <tr id="i1" 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/application/ambassador/simulation/communication/CommunicationModuleOwner.html#getId--">getId</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#getPosition--">getPosition</a></span>()</code> |
| <div class="block">Returns the current position as a <a href="../../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo"><code>GeoPoint</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#getSimulationTime--">getSimulationTime</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#sendInteractionToRti-org.eclipse.mosaic.rti.api.Interaction-">sendInteractionToRti</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api">Interaction</a> interaction)</code> |
| <div class="block">Sends the given <a href="../../../../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api"><code>Interaction</code></a> to the runtime infrastructure.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#triggerOnSendMessage-org.eclipse.mosaic.interactions.communication.V2xMessageTransmission-">triggerOnSendMessage</a></span>(<a href="../../../../../../../../org/eclipse/mosaic/interactions/communication/V2xMessageTransmission.html" title="class in org.eclipse.mosaic.interactions.communication">V2xMessageTransmission</a> message)</code> |
| <div class="block">This function is called when a Message has been sent.</div> |
| </td> |
| </tr> |
| </table> |
| </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="getId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre><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> getId()</pre> |
| </li> |
| </ul> |
| <a name="getPosition--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPosition</h4> |
| <pre><a href="../../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a> getPosition()</pre> |
| <div class="block">Returns the current position as a <a href="../../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo"><code>GeoPoint</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current position.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSimulationTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSimulationTime</h4> |
| <pre>long getSimulationTime()</pre> |
| </li> |
| </ul> |
| <a name="sendInteractionToRti-org.eclipse.mosaic.rti.api.Interaction-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendInteractionToRti</h4> |
| <pre>void sendInteractionToRti(<a href="../../../../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api">Interaction</a> interaction)</pre> |
| <div class="block">Sends the given <a href="../../../../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api"><code>Interaction</code></a> to the runtime infrastructure.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interaction</code> - the <a href="../../../../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api"><code>Interaction</code></a> to be send</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assembleCamMessage-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.CamBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assembleCamMessage</h4> |
| <pre><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> assembleCamMessage(<a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CamBuilder.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CamBuilder</a> camBuilder)</pre> |
| <div class="block">Assembles a <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CamBuilder.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication"><code>CamBuilder</code></a> (Cooperative Awareness Message) using the |
| given <a href="../../../../../../../../org/eclipse/mosaic/lib/objects/v2x/MessageRouting.html" title="class in org.eclipse.mosaic.lib.objects.v2x"><code>MessageRouting</code></a> and the units' status information.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>camBuilder</code> - the routing for the <a href="../../../../../../../../org/eclipse/mosaic/lib/objects/v2x/etsi/Cam.html" title="class in org.eclipse.mosaic.lib.objects.v2x.etsi"><code>Cam</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the assembled <a href="../../../../../../../../org/eclipse/mosaic/lib/objects/v2x/etsi/Cam.html" title="class in org.eclipse.mosaic.lib.objects.v2x.etsi"><code>Cam</code></a>, which can be sent</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="triggerOnSendMessage-org.eclipse.mosaic.interactions.communication.V2xMessageTransmission-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>triggerOnSendMessage</h4> |
| <pre>void triggerOnSendMessage(<a href="../../../../../../../../org/eclipse/mosaic/interactions/communication/V2xMessageTransmission.html" title="class in org.eclipse.mosaic.interactions.communication">V2xMessageTransmission</a> message)</pre> |
| <div class="block">This function is called when a Message has been sent.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - the sent message</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/CommunicationModuleOwner.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CellModuleConfiguration.CellCamConfiguration.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/ReceivedAcknowledgement.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html" target="_top">Frames</a></li> |
| <li><a href="CommunicationModuleOwner.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2020 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
