| <!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>AbstractSimulationUnit (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="AbstractSimulationUnit (Eclipse MOSAIC Parent 20.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractSimulationUnit.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>Prev Class</li> |
| <li><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/ChargingStationUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html" target="_top">Frames</a></li> |
| <li><a href="AbstractSimulationUnit.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</div> |
| <h2 title="Class AbstractSimulationUnit" class="title">Class AbstractSimulationUnit</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.mosaic.fed.application.ambassador.simulation.AbstractSimulationUnit</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CommunicationModuleOwner</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a>, <a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventProcessor</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/ChargingStationUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">ChargingStationUnit</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 abstract class <span class="typeNameLabel">AbstractSimulationUnit</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventProcessor</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></pre> |
| <div class="block">This class is to be extended by all units that can be equipped with applications. |
| It supplies all functionality for loading applications, communication with the RTI |
| and the processing of events, etc.</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#canProcessEvent--">canProcessEvent</a></span>()</code> |
| <div class="block">Checks, if this <a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling"><code>EventProcessor</code></a> is able to process any events.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#cleanPastEnvironmentEvents--">cleanPastEnvironmentEvents</a></span>()</code> |
| <div class="block">The events are mapped into a map on the type.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/AdHocModule.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">AdHocModule</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getAdHocModule--">getAdHocModule</a></span>()</code> |
| <div class="block">Returns the ad-hoc communication module of this unit.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/Application.html" title="interface in org.eclipse.mosaic.fed.application.app.api">Application</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getApplications--">getApplications</a></span>()</code> |
| <div class="block">Get the list of all applications running on this simulation unit.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><A extends <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/Application.html" title="interface in org.eclipse.mosaic.fed.application.app.api">Application</a>><br><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><A></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getApplicationsIterator-java.lang.Class-">getApplicationsIterator</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> applicationClass)</code> |
| <div class="block">Get the list of all applications running on this simulation unit.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CellModule.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CellModule</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getCellModule--">getCellModule</a></span>()</code> |
| <div class="block">Returns the cellular communication module of this unit.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getConfigurationPath--">getConfigurationPath</a></span>()</code> |
| <div class="block">Returns the path to the application simulator configuration directory.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventManager.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getEventManager--">getEventManager</a></span>()</code> |
| <div class="block">Returns the event manager for this task to add events.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getId--">getId</a></span>()</code> |
| <div class="block">Returns the id of the unit.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <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/AbstractSimulationUnit.html#getInitialPosition--">getInitialPosition</a></span>()</code> |
| <div class="block">This data element provides an absolute geographical longitude and latitude in a WGS84 |
| coordinate system with a granularity of 1/8 micro degrees.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>org.slf4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getOsLog--">getOsLog</a></span>()</code> |
| <div class="block">Returns the operating system log.</div> |
| </td> |
| </tr> |
| <tr id="i11" 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/AbstractSimulationUnit.html#getSimulationTime--">getSimulationTime</a></span>()</code> |
| <div class="block">Returns the simulation time.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getStateOfEnvironmentSensor-org.eclipse.mosaic.lib.enums.SensorType-">getStateOfEnvironmentSensor</a></span>(<a href="../../../../../../../org/eclipse/mosaic/lib/enums/SensorType.html" title="enum in org.eclipse.mosaic.lib.enums">SensorType</a> type)</code> |
| <div class="block">Returns The state of the supplied sensor.</div> |
| </td> |
| </tr> |
| <tr id="i13" 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/AbstractSimulationUnit.html#loadApplications-java.util.List-">loadApplications</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> applicationClassNames)</code> |
| <div class="block">Load applications.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#preProcessEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">preProcessEvent</a></span>(<a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling">Event</a> event)</code> |
| <div class="block">This method processes an event, before the extension of the simulation unit should process an event.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#processSumoTraciMessage-org.eclipse.mosaic.lib.objects.traffic.SumoTraciResult-">processSumoTraciMessage</a></span>(<a href="../../../../../../../org/eclipse/mosaic/lib/objects/traffic/SumoTraciResult.html" title="class in org.eclipse.mosaic.lib.objects.traffic">SumoTraciResult</a> sumoTraciResult)</code> |
| <div class="block">Handle the returned information of a request to SUMO via traci.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/objects/environment/EnvironmentEvent.html" title="class in org.eclipse.mosaic.lib.objects.environment">EnvironmentEvent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#putEnvironmentEvent-org.eclipse.mosaic.lib.enums.SensorType-org.eclipse.mosaic.lib.objects.environment.EnvironmentEvent-">putEnvironmentEvent</a></span>(<a href="../../../../../../../org/eclipse/mosaic/lib/enums/SensorType.html" title="enum in org.eclipse.mosaic.lib.enums">SensorType</a> type, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/objects/environment/EnvironmentEvent.html" title="class in org.eclipse.mosaic.lib.objects.environment">EnvironmentEvent</a> environmentEvent)</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.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">Send an interaction to the RTI.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#sendItefLogTuple-long-int...-">sendItefLogTuple</a></span>(long logTupleId, |
| int... values)</code> |
| <div class="block">Send a log tuple for the ITEF visualizer.</div> |
| </td> |
| </tr> |
| <tr id="i19" 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/AbstractSimulationUnit.html#sendSumoTraciRequest-byte:A-">sendSumoTraciRequest</a></span>(byte[] command)</code> |
| <div class="block">Send a byte array message to SUMO TraCI.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#setUp--">setUp</a></span>()</code> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#tearDown--">tearDown</a></span>()</code> |
| <div class="block">Tears down the simulation unit by tearing down all applications and clearing all its application list.</div> |
| </td> |
| </tr> |
| <tr id="i22" 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/AbstractSimulationUnit.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> messageTransmission)</code> |
| <div class="block">This function is called when a Message has been sent.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.lib.util.scheduling.EventProcessor"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface 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#processEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">processEvent</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.fed.application.app.api.os.OperatingSystem"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.mosaic.fed.application.app.api.os.<a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></h3> |
| <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getPosition--">getPosition</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getSimulationTimeMs--">getSimulationTimeMs</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.fed.application.ambassador.simulation.communication.CommunicationModuleOwner"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.mosaic.fed.application.ambassador.simulation.communication.<a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CommunicationModuleOwner</a></h3> |
| <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#assembleCamMessage-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.CamBuilder-">assembleCamMessage</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="getId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a> |
| public final <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> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getId--">OperatingSystem</a></code></span></div> |
| <div class="block">Returns the id of the unit.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#getId--">getId</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CommunicationModuleOwner</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getId--">getId</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The unitName (i.e. veh_1, rsu_0).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="preProcessEvent-org.eclipse.mosaic.lib.util.scheduling.Event-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>preProcessEvent</h4> |
| <pre>public final boolean preProcessEvent(<a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling">Event</a> event)</pre> |
| <div class="block">This method processes an event, before the extension of the simulation unit should process an event. |
| Important: This method should always be called before. |
| It is used to process certain events that are executed in all units equivalent.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the event to process.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this method has processed the given event</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSimulationTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSimulationTime</h4> |
| <pre>public final long getSimulationTime()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getSimulationTime--">OperatingSystem</a></code></span></div> |
| <div class="block">Returns the simulation time. Unit: [ns].</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#getSimulationTime--">getSimulationTime</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CommunicationModuleOwner</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getSimulationTime--">getSimulationTime</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the simulation time. Unit: [ns].</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInitialPosition--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitialPosition</h4> |
| <pre>public <a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a> getInitialPosition()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getInitialPosition--">OperatingSystem</a></code></span></div> |
| <div class="block">This data element provides an absolute geographical longitude and latitude in a WGS84 |
| coordinate system with a granularity of 1/8 micro degrees. Compliant to SAE J2735 |
| DE_Longitude.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getInitialPosition--">getInitialPosition</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the position.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEventManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEventManager</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a> |
| public final <a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventManager.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventManager</a> getEventManager()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getEventManager--">OperatingSystem</a></code></span></div> |
| <div class="block">Returns the event manager for this task to add events.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getEventManager--">getEventManager</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The manager to add events.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOsLog--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOsLog</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a> |
| public final org.slf4j.Logger getOsLog()</pre> |
| <div class="block">Returns the operating system log.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the operating system log.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="tearDown--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tearDown</h4> |
| <pre>public void tearDown()</pre> |
| <div class="block">Tears down the simulation unit by tearing down all applications and clearing all its application list.</div> |
| </li> |
| </ul> |
| <a name="setUp--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUp</h4> |
| <pre>protected void setUp()</pre> |
| </li> |
| </ul> |
| <a name="loadApplications-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadApplications</h4> |
| <pre>public final void loadApplications(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> applicationClassNames)</pre> |
| <div class="block">Load applications.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>applicationClassNames</code> - list of application class names</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendInteractionToRti-org.eclipse.mosaic.rti.api.Interaction-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendInteractionToRti</h4> |
| <pre>public final 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">Send an interaction to the RTI.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#sendInteractionToRti-org.eclipse.mosaic.rti.api.Interaction-">sendInteractionToRti</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CommunicationModuleOwner</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interaction</code> - the interaction.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendItefLogTuple-long-int...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendItefLogTuple</h4> |
| <pre>public final void sendItefLogTuple(long logTupleId, |
| int... values)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#sendItefLogTuple-long-int...-">OperatingSystem</a></code></span></div> |
| <div class="block">Send a log tuple for the ITEF visualizer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#sendItefLogTuple-long-int...-">sendItefLogTuple</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>logTupleId</code> - log tuple identifier</dd> |
| <dd><code>values</code> - list of values to be logged</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendSumoTraciRequest-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendSumoTraciRequest</h4> |
| <pre>public final <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> sendSumoTraciRequest(byte[] command)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#sendSumoTraciRequest-byte:A-">OperatingSystem</a></code></span></div> |
| <div class="block">Send a byte array message to SUMO TraCI.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#sendSumoTraciRequest-byte:A-">sendSumoTraciRequest</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>command</code> - Byte array containing SUMO TraCI message.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a identifier which can be used to match incoming TraCI command response</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="processSumoTraciMessage-org.eclipse.mosaic.lib.objects.traffic.SumoTraciResult-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>processSumoTraciMessage</h4> |
| <pre>public final void processSumoTraciMessage(<a href="../../../../../../../org/eclipse/mosaic/lib/objects/traffic/SumoTraciResult.html" title="class in org.eclipse.mosaic.lib.objects.traffic">SumoTraciResult</a> sumoTraciResult)</pre> |
| <div class="block">Handle the returned information of a request to SUMO via traci.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sumoTraciResult</code> - the result of a request to traci</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putEnvironmentEvent-org.eclipse.mosaic.lib.enums.SensorType-org.eclipse.mosaic.lib.objects.environment.EnvironmentEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putEnvironmentEvent</h4> |
| <pre>public <a href="../../../../../../../org/eclipse/mosaic/lib/objects/environment/EnvironmentEvent.html" title="class in org.eclipse.mosaic.lib.objects.environment">EnvironmentEvent</a> putEnvironmentEvent(<a href="../../../../../../../org/eclipse/mosaic/lib/enums/SensorType.html" title="enum in org.eclipse.mosaic.lib.enums">SensorType</a> type, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/objects/environment/EnvironmentEvent.html" title="class in org.eclipse.mosaic.lib.objects.environment">EnvironmentEvent</a> environmentEvent)</pre> |
| </li> |
| </ul> |
| <a name="cleanPastEnvironmentEvents--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cleanPastEnvironmentEvents</h4> |
| <pre>public final void cleanPastEnvironmentEvents()</pre> |
| <div class="block">The events are mapped into a map on the type. With multiple events to a |
| same type, the last event is always taken. However, it should be part of |
| good form to delete the event you no longer need to save some memory.</div> |
| </li> |
| </ul> |
| <a name="getStateOfEnvironmentSensor-org.eclipse.mosaic.lib.enums.SensorType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStateOfEnvironmentSensor</h4> |
| <pre>public final int getStateOfEnvironmentSensor(<a href="../../../../../../../org/eclipse/mosaic/lib/enums/SensorType.html" title="enum in org.eclipse.mosaic.lib.enums">SensorType</a> type)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getStateOfEnvironmentSensor-org.eclipse.mosaic.lib.enums.SensorType-">OperatingSystem</a></code></span></div> |
| <div class="block">Returns The state of the supplied sensor.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getStateOfEnvironmentSensor-org.eclipse.mosaic.lib.enums.SensorType-">getStateOfEnvironmentSensor</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - The <a href="../../../../../../../org/eclipse/mosaic/lib/enums/SensorType.html" title="enum in org.eclipse.mosaic.lib.enums"><code>SensorType</code></a> type to use.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Strength of the measured environment sensor data.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="triggerOnSendMessage-org.eclipse.mosaic.interactions.communication.V2xMessageTransmission-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>triggerOnSendMessage</h4> |
| <pre>public void triggerOnSendMessage(<a href="../../../../../../../org/eclipse/mosaic/interactions/communication/V2xMessageTransmission.html" title="class in org.eclipse.mosaic.interactions.communication">V2xMessageTransmission</a> messageTransmission)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#triggerOnSendMessage-org.eclipse.mosaic.interactions.communication.V2xMessageTransmission-">CommunicationModuleOwner</a></code></span></div> |
| <div class="block">This function is called when a Message has been sent.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#triggerOnSendMessage-org.eclipse.mosaic.interactions.communication.V2xMessageTransmission-">triggerOnSendMessage</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CommunicationModuleOwner</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>messageTransmission</code> - the sent message</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAdHocModule--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAdHocModule</h4> |
| <pre>public <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/AdHocModule.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">AdHocModule</a> getAdHocModule()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getAdHocModule--">OperatingSystem</a></code></span></div> |
| <div class="block">Returns the ad-hoc communication module of this unit.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getAdHocModule--">getAdHocModule</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/AdHocModule.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication"><code>AdHocModule</code></a> of this unit.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCellModule--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCellModule</h4> |
| <pre>public final <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CellModule.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CellModule</a> getCellModule()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getCellModule--">OperatingSystem</a></code></span></div> |
| <div class="block">Returns the cellular communication module of this unit.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getCellModule--">getCellModule</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CellModule.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation.communication"><code>CellModule</code></a> of this unit.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getApplications--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getApplications</h4> |
| <pre>public final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/Application.html" title="interface in org.eclipse.mosaic.fed.application.app.api">Application</a>> getApplications()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getApplications--">OperatingSystem</a></code></span></div> |
| <div class="block">Get the list of all applications running on this simulation unit.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getApplications--">getApplications</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list containing all applications.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getApplicationsIterator-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getApplicationsIterator</h4> |
| <pre>public <A extends <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="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><A> getApplicationsIterator(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> applicationClass)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getApplicationsIterator-java.lang.Class-">OperatingSystem</a></code></span></div> |
| <div class="block">Get the list of all applications running on this simulation unit.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getApplicationsIterator-java.lang.Class-">getApplicationsIterator</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list containing all applications.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConfigurationPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigurationPath</h4> |
| <pre>public final <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> getConfigurationPath()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getConfigurationPath--">OperatingSystem</a></code></span></div> |
| <div class="block">Returns the path to the application simulator configuration directory.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getConfigurationPath--">getConfigurationPath</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">OperatingSystem</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The path of the configuration directory as <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canProcessEvent--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>canProcessEvent</h4> |
| <pre>public boolean canProcessEvent()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html#canProcessEvent--">EventProcessor</a></code></span></div> |
| <div class="block">Checks, if this <a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling"><code>EventProcessor</code></a> is able to process any events. If the processor |
| is not currently to able to process a given event, those events will be skipped and |
| never reach this <a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling"><code>EventProcessor</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html#canProcessEvent--">canProcessEvent</a></code> in interface <code><a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventProcessor</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if this <a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling"><code>EventProcessor</code></a> is currently able to process events, otherwise <code>false</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractSimulationUnit.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>Prev Class</li> |
| <li><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/ChargingStationUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html" target="_top">Frames</a></li> |
| <li><a href="AbstractSimulationUnit.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> |