| <!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>OperatingSystem (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="OperatingSystem (Eclipse MOSAIC Parent 21.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":18,"i11":6,"i12":6,"i13":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/OperatingSystem.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/os/ElectricVehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/RoadSideUnitOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" target="_top">Frames</a></li> |
| <li><a href="OperatingSystem.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.app.api.os</div> |
| <h2 title="Interface OperatingSystem" class="title">Interface OperatingSystem</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/ambassador/simulation/communication/CommunicationModuleOwner.html" title="interface in org.eclipse.mosaic.fed.application.ambassador.simulation.communication">CommunicationModuleOwner</a></dd> |
| </dl> |
| <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/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/ServerOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os">ServerOperatingSystem</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/ServerUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">ServerUnit</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">OperatingSystem</span> |
| extends <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></pre> |
| <div class="block">This interface describes all necessary functionality for units to be |
| simulated.</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><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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/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/app/api/os/OperatingSystem.html#getAdHocModule--">getAdHocModule</a></span>()</code> |
| <div class="block">Returns the ad-hoc communication module of this unit.</div> |
| </td> |
| </tr> |
| <tr id="i1" 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><? extends <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/app/api/os/OperatingSystem.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="i2" 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/app/api/os/OperatingSystem.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="i3" 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/app/api/os/OperatingSystem.html#getCellModule--">getCellModule</a></span>()</code> |
| <div class="block">Returns the cellular communication module of this unit.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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/app/api/os/OperatingSystem.html#getConfigurationPath--">getConfigurationPath</a></span>()</code> |
| <div class="block">Returns the path to the application simulator configuration directory.</div> |
| </td> |
| </tr> |
| <tr id="i5" 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/app/api/os/OperatingSystem.html#getEventManager--">getEventManager</a></span>()</code> |
| <div class="block">Returns the event manager for this task to add events.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/app/api/os/OperatingSystem.html#getId--">getId</a></span>()</code> |
| <div class="block">Returns the id of the unit.</div> |
| </td> |
| </tr> |
| <tr id="i7" 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/app/api/os/OperatingSystem.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="i8" 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/app/api/os/OperatingSystem.html#getPosition--">getPosition</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="i9" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getSimulationTime--">getSimulationTime</a></span>()</code> |
| <div class="block">Returns the simulation time.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>default long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getSimulationTimeMs--">getSimulationTimeMs</a></span>()</code> |
| <div class="block">Returns the time difference in milliseconds since a well-defined start time - |
| here milliseconds since the simulation start time.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.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="i12" 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/os/OperatingSystem.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="i13" 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/app/api/os/OperatingSystem.html#sendSumoTraciRequest-byte:A-">sendSumoTraciRequest</a></span>(byte[] command)</code> |
| <div class="block">Send a byte array message to SUMO TraCI.</div> |
| </td> |
| </tr> |
| </table> |
| <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>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#sendInteractionToRti-org.eclipse.mosaic.rti.api.Interaction-">sendInteractionToRti</a>, <a href="../../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#triggerOnSendMessage-org.eclipse.mosaic.interactions.communication.V2xMessageTransmission-">triggerOnSendMessage</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="getConfigurationPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigurationPath</h4> |
| <pre><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">Returns the path to the application simulator configuration directory.</div> |
| <dl> |
| <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="getEventManager--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEventManager</h4> |
| <pre><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">Returns the event manager for this task to add events.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The manager to add events.</dd> |
| </dl> |
| </li> |
| </ul> |
| <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> |
| <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="returnLabel">Returns:</span></dt> |
| <dd>The unitName (i.e. veh_1, rsu_0).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSimulationTime--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSimulationTime</h4> |
| <pre>long getSimulationTime()</pre> |
| <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="returnLabel">Returns:</span></dt> |
| <dd>the simulation time. Unit: [ns].</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSimulationTimeMs--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSimulationTimeMs</h4> |
| <pre>default long getSimulationTimeMs()</pre> |
| <div class="block">Returns the time difference in milliseconds since a well-defined start time - |
| here milliseconds since the simulation start time. |
| 1.1.1970 00:00:00.000 Needs to be aligned with SAE J2735 |
| DF_DDateTime, DF_DTime, DE_DSecond. Unit: [ms].</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the simulation time. Unit: [ms].</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInitialPosition--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitialPosition</h4> |
| <pre><a href="../../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a> getInitialPosition()</pre> |
| <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="returnLabel">Returns:</span></dt> |
| <dd>the position.</dd> |
| </dl> |
| </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">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/ambassador/simulation/communication/CommunicationModuleOwner.html#getPosition--">getPosition</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="returnLabel">Returns:</span></dt> |
| <dd>the position.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendItefLogTuple-long-int...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendItefLogTuple</h4> |
| <pre>void sendItefLogTuple(long logTupleId, |
| int... values)</pre> |
| <div class="block">Send a log tuple for the ITEF visualizer.</div> |
| <dl> |
| <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><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">Send a byte array message to SUMO TraCI.</div> |
| <dl> |
| <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="getStateOfEnvironmentSensor-org.eclipse.mosaic.lib.enums.SensorType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStateOfEnvironmentSensor</h4> |
| <pre>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">Returns The state of the supplied sensor.</div> |
| <dl> |
| <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="getCellModule--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCellModule</h4> |
| <pre><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">Returns the cellular communication module of this unit.</div> |
| <dl> |
| <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="getAdHocModule--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAdHocModule</h4> |
| <pre><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">Returns the ad-hoc communication module of this unit.</div> |
| <dl> |
| <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="getApplications--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getApplications</h4> |
| <pre><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><? extends <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">Get the list of all applications running on this simulation unit.</div> |
| <dl> |
| <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="blockListLast"> |
| <li class="blockList"> |
| <h4>getApplicationsIterator</h4> |
| <pre><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">Get the list of all applications running on this simulation unit.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list containing all applications.</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/OperatingSystem.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/os/ElectricVehicleOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/RoadSideUnitOperatingSystem.html" title="interface in org.eclipse.mosaic.fed.application.app.api.os"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html" target="_top">Frames</a></li> |
| <li><a href="OperatingSystem.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–2021 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p> |
| </body> |
| </html> |