| <!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>TrafficLightGroupUnit (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="TrafficLightGroupUnit (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}; |
| 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/TrafficLightGroupUnit.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/RoadSideUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/TrafficManagementCenterUnit.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/TrafficLightGroupUnit.html" target="_top">Frames</a></li> |
| <li><a href="TrafficLightGroupUnit.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 TrafficLightGroupUnit" class="title">Class TrafficLightGroupUnit</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><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">org.eclipse.mosaic.fed.application.ambassador.simulation.AbstractSimulationUnit</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.mosaic.fed.application.ambassador.simulation.TrafficLightGroupUnit</li> |
| </ul> |
| </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/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/lib/util/scheduling/EventProcessor.html" title="interface in org.eclipse.mosaic.lib.util.scheduling">EventProcessor</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">TrafficLightGroupUnit</span> |
| extends <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">AbstractSimulationUnit</a> |
| implements <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></pre> |
| <div class="block">Simulation unit that represents a traffic light group.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/TrafficLightGroupUnit.html#TrafficLightGroupUnit-java.lang.String-org.eclipse.mosaic.lib.geo.GeoPoint-org.eclipse.mosaic.lib.objects.trafficlight.TrafficLightGroup-">TrafficLightGroupUnit</a></span>(<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> simulationUnitId, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a> trafficLightPosition, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/objects/trafficlight/TrafficLightGroup.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightGroup</a> trafficLightGroup)</code> |
| <div class="block">Creates a new traffic light group simulation unit.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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><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/TrafficLightGroupUnit.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/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../../org/eclipse/mosaic/lib/objects/trafficlight/TrafficLightProgram.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightProgram</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/TrafficLightGroupUnit.html#getAllPrograms--">getAllPrograms</a></span>()</code> |
| <div class="block">Returns all traffic light programs that are registered for a traffic light group using this operating system.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <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/lib/objects/trafficlight/TrafficLight.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLight</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/TrafficLightGroupUnit.html#getAllTrafficLights--">getAllTrafficLights</a></span>()</code> |
| <div class="block">Returns all traffic lights a traffic light group using this operating system consist of</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/TrafficLightGroupUnit.html#getControlledLanes--">getControlledLanes</a></span>()</code> |
| <div class="block">Returns a collection of incoming lanes controlled by this traffic light group.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/objects/trafficlight/TrafficLightProgramPhase.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightProgramPhase</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/TrafficLightGroupUnit.html#getCurrentPhase--">getCurrentPhase</a></span>()</code> |
| <div class="block">Returns the traffic light program phase that is currently running on a traffic light group using this operating system.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/objects/trafficlight/TrafficLightProgram.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightProgram</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/TrafficLightGroupUnit.html#getCurrentProgram--">getCurrentProgram</a></span>()</code> |
| <div class="block">Returns the traffic light program that is currently running on a traffic light group using this operating system.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/TrafficLightGroupUnit.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="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/ambassador/simulation/TrafficLightGroupUnit.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="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../../org/eclipse/mosaic/lib/objects/trafficlight/TrafficLightState.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightState</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/TrafficLightGroupUnit.html#getSignalSequence-java.lang.String-int-">getSignalSequence</a></span>(<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> trafficLightProgramId, |
| int trafficLightId)</code> |
| <div class="block">Returns a sequence of states for a certain traffic light, |
| where each state represents a state of the traffic light during a phase within a traffic light program.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/eclipse/mosaic/lib/objects/trafficlight/TrafficLightGroup.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightGroup</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/TrafficLightGroupUnit.html#getTrafficLightGroup--">getTrafficLightGroup</a></span>()</code> |
| <div class="block">Getter for the traffic light group.</div> |
| </td> |
| </tr> |
| <tr id="i10" 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/TrafficLightGroupUnit.html#processEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">processEvent</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">Processes the given event.</div> |
| </td> |
| </tr> |
| <tr id="i11" 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/TrafficLightGroupUnit.html#setRemainingDurationOfCurrentPhase-long-">setRemainingDurationOfCurrentPhase</a></span>(long remainingDuration)</code> |
| <div class="block">Set the remaining duration of the current traffic light program phase of this traffic light |
| group.</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/ambassador/simulation/TrafficLightGroupUnit.html#switchToCustomState-java.util.List-">switchToCustomState</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="../../../../../../../org/eclipse/mosaic/lib/objects/trafficlight/TrafficLightState.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightState</a>> stateList)</code> |
| <div class="block">Switches all traffic lights which belong to this group to the given |
| state.</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/TrafficLightGroupUnit.html#switchToPhaseIndex-int-">switchToPhaseIndex</a></span>(int newPhaseId)</code> |
| <div class="block">Switches the phase in the current traffic light program to the phase with the given id.</div> |
| </td> |
| </tr> |
| <tr id="i14" 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/TrafficLightGroupUnit.html#switchToProgram-java.lang.String-">switchToProgram</a></span>(<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> newProgramId)</code> |
| <div class="block">Sets a new traffic light program, identified by the given <code>newProgramId</code>, to |
| this traffic light group.</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/TrafficLightGroupUnit.html#switchToProgramAndPhase-java.lang.String-int-">switchToProgramAndPhase</a></span>(<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> newProgramId, |
| int phaseId)</code> |
| <div class="block">Sets a new traffic light program with the given id to this traffic light group |
| and also sets the wanted phase for the new program.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.fed.application.ambassador.simulation.AbstractSimulationUnit"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.mosaic.fed.application.ambassador.simulation.<a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">AbstractSimulationUnit</a></h3> |
| <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#canProcessEvent--">canProcessEvent</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#cleanPastEnvironmentEvents--">cleanPastEnvironmentEvents</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getAdHocModule--">getAdHocModule</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getApplications--">getApplications</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getApplicationsIterator-java.lang.Class-">getApplicationsIterator</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getCellModule--">getCellModule</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getConfigurationPath--">getConfigurationPath</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getEventManager--">getEventManager</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getId--">getId</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getOsLog--">getOsLog</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getSimulationTime--">getSimulationTime</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getStateOfEnvironmentSensor-org.eclipse.mosaic.lib.enums.SensorType-">getStateOfEnvironmentSensor</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#loadApplications-java.util.List-">loadApplications</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#preProcessEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">preProcessEvent</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#processSumoTraciMessage-org.eclipse.mosaic.lib.objects.traffic.SumoTraciResult-">processSumoTraciMessage</a>, <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>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#sendInteractionToRti-org.eclipse.mosaic.rti.api.Interaction-">sendInteractionToRti</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#sendItefLogTuple-long-int...-">sendItefLogTuple</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#sendSumoTraciRequest-byte:A-">sendSumoTraciRequest</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#setUp--">setUp</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#tearDown--">tearDown</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#triggerOnSendMessage-org.eclipse.mosaic.interactions.communication.V2xMessageTransmission-">triggerOnSendMessage</a></code></li> |
| </ul> |
| <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.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#getAdHocModule--">getAdHocModule</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getApplications--">getApplications</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getApplicationsIterator-java.lang.Class-">getApplicationsIterator</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getCellModule--">getCellModule</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getConfigurationPath--">getConfigurationPath</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getEventManager--">getEventManager</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getId--">getId</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getSimulationTime--">getSimulationTime</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getSimulationTimeMs--">getSimulationTimeMs</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getStateOfEnvironmentSensor-org.eclipse.mosaic.lib.enums.SensorType-">getStateOfEnvironmentSensor</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#sendItefLogTuple-long-int...-">sendItefLogTuple</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#sendSumoTraciRequest-byte:A-">sendSumoTraciRequest</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#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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TrafficLightGroupUnit-java.lang.String-org.eclipse.mosaic.lib.geo.GeoPoint-org.eclipse.mosaic.lib.objects.trafficlight.TrafficLightGroup-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TrafficLightGroupUnit</h4> |
| <pre>public TrafficLightGroupUnit(<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> simulationUnitId, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a> trafficLightPosition, |
| <a href="../../../../../../../org/eclipse/mosaic/lib/objects/trafficlight/TrafficLightGroup.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightGroup</a> trafficLightGroup)</pre> |
| <div class="block">Creates a new traffic light group simulation unit.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>simulationUnitId</code> - internal traffic light group identifier</dd> |
| <dd><code>trafficLightPosition</code> - traffic light position</dd> |
| <dd><code>trafficLightGroup</code> - traffic light group identifier</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getPosition--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPosition</h4> |
| <pre>public <a href="../../../../../../../org/eclipse/mosaic/lib/geo/GeoPoint.html" title="interface in org.eclipse.mosaic.lib.geo">GeoPoint</a> getPosition()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getPosition--">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/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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/OperatingSystem.html#getPosition--">getPosition</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="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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html#getInitialPosition--">getInitialPosition</a></code> in class <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/AbstractSimulationUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation">AbstractSimulationUnit</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the position.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="processEvent-org.eclipse.mosaic.lib.util.scheduling.Event-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>processEvent</h4> |
| <pre>public void processEvent(<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> |
| <a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/Event.html" title="class in org.eclipse.mosaic.lib.util.scheduling">Event</a> event) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html#processEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">EventProcessor</a></code></span></div> |
| <div class="block">Processes the given event.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/lib/util/scheduling/EventProcessor.html#processEvent-org.eclipse.mosaic.lib.util.scheduling.Event-">processEvent</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="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the event to process</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRemainingDurationOfCurrentPhase-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRemainingDurationOfCurrentPhase</h4> |
| <pre>public void setRemainingDurationOfCurrentPhase(long remainingDuration)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#setRemainingDurationOfCurrentPhase-long-">TrafficLightOperatingSystem</a></code></span></div> |
| <div class="block">Set the remaining duration of the current traffic light program phase of this traffic light |
| group. |
| Please consider only using numbers that fulfill the condition >= 0 to avoid unwanted changes. |
| Negative numbers usage will affect the next phase |
| so that the absolute value of the given negative number will be subtracted from the remaining duration of the next phase.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#setRemainingDurationOfCurrentPhase-long-">setRemainingDurationOfCurrentPhase</a></code> in interface <code><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></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>remainingDuration</code> - the new phase remaining duration in millisecond</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="switchToPhaseIndex-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>switchToPhaseIndex</h4> |
| <pre>public void switchToPhaseIndex(int newPhaseId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#switchToPhaseIndex-int-">TrafficLightOperatingSystem</a></code></span></div> |
| <div class="block">Switches the phase in the current traffic light program to the phase with the given id. |
| Remaining phase duration will be reset.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#switchToPhaseIndex-int-">switchToPhaseIndex</a></code> in interface <code><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></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newPhaseId</code> - id of the phase it will be switched to</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="switchToCustomState-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>switchToCustomState</h4> |
| <pre>public void switchToCustomState(<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/lib/objects/trafficlight/TrafficLightState.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightState</a>> stateList)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#switchToCustomState-java.util.List-">TrafficLightOperatingSystem</a></code></span></div> |
| <div class="block">Switches all traffic lights which belong to this group to the given |
| state. The states will be held until switched to another list of states, |
| or to another program or phase index.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#switchToCustomState-java.util.List-">switchToCustomState</a></code> in interface <code><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></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stateList</code> - the list of states to set (one state for each traffic light in the correct order)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="switchToProgram-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>switchToProgram</h4> |
| <pre>public void switchToProgram(<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> newProgramId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#switchToProgram-java.lang.String-">TrafficLightOperatingSystem</a></code></span></div> |
| <div class="block">Sets a new traffic light program, identified by the given <code>newProgramId</code>, to |
| this traffic light group. |
| Important: when interacting with SUMO one should consider that after changing a program |
| the new program will NOT begin from its first phase, |
| but from the time at which the previous program was interrupted (and from the according phase). |
| Consider using the <a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#switchToProgramAndPhase-java.lang.String-int-"><code>TrafficLightOperatingSystem.switchToProgramAndPhase(String newProgramId, int phaseId)</code></a> method to avoid this effect. |
| Therefore changing the program to the same program doesn't change anything.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#switchToProgram-java.lang.String-">switchToProgram</a></code> in interface <code><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></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newProgramId</code> - Id of the new traffic light program.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="switchToProgramAndPhase-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>switchToProgramAndPhase</h4> |
| <pre>public void switchToProgramAndPhase(<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> newProgramId, |
| int phaseId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#switchToProgramAndPhase-java.lang.String-int-">TrafficLightOperatingSystem</a></code></span></div> |
| <div class="block">Sets a new traffic light program with the given id to this traffic light group |
| and also sets the wanted phase for the new program. |
| Important: Internal this is made with *two* TraCI commands |
| because it's not possible to do it in one step while interacting with SUMO.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#switchToProgramAndPhase-java.lang.String-int-">switchToProgramAndPhase</a></code> in interface <code><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></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newProgramId</code> - Id of the new traffic light program</dd> |
| <dd><code>phaseId</code> - the index of the phase to switch to</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSignalSequence-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSignalSequence</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../../org/eclipse/mosaic/lib/objects/trafficlight/TrafficLightState.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightState</a>> getSignalSequence(<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> trafficLightProgramId, |
| int trafficLightId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#getSignalSequence-java.lang.String-int-">TrafficLightOperatingSystem</a></code></span></div> |
| <div class="block">Returns a sequence of states for a certain traffic light, |
| where each state represents a state of the traffic light during a phase within a traffic light program. |
| If there is no program with given id, a sequence of states for the current program is returned.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#getSignalSequence-java.lang.String-int-">getSignalSequence</a></code> in interface <code><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></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>trafficLightProgramId</code> - id of the traffic light program to look into</dd> |
| <dd><code>trafficLightId</code> - id of a traffic light</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a sequence of states for a certain traffic light within a traffic light program with given id |
| or a sequence of states for the current program.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getControlledLanes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getControlledLanes</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</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>> getControlledLanes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#getControlledLanes--">TrafficLightOperatingSystem</a></code></span></div> |
| <div class="block">Returns a collection of incoming lanes controlled by this traffic light group.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#getControlledLanes--">getControlledLanes</a></code> in interface <code><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></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>controlled lanes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTrafficLightGroup--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrafficLightGroup</h4> |
| <pre>public <a href="../../../../../../../org/eclipse/mosaic/lib/objects/trafficlight/TrafficLightGroup.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightGroup</a> getTrafficLightGroup()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#getTrafficLightGroup--">TrafficLightOperatingSystem</a></code></span></div> |
| <div class="block">Getter for the traffic light group.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#getTrafficLightGroup--">getTrafficLightGroup</a></code> in interface <code><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></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Traffic light group</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllPrograms--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllPrograms</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../../org/eclipse/mosaic/lib/objects/trafficlight/TrafficLightProgram.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightProgram</a>> getAllPrograms()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#getAllPrograms--">TrafficLightOperatingSystem</a></code></span></div> |
| <div class="block">Returns all traffic light programs that are registered for a traffic light group using this operating system.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#getAllPrograms--">getAllPrograms</a></code> in interface <code><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></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all traffic light programs that are registered for a traffic light group</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCurrentProgram--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrentProgram</h4> |
| <pre>public <a href="../../../../../../../org/eclipse/mosaic/lib/objects/trafficlight/TrafficLightProgram.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightProgram</a> getCurrentProgram()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#getCurrentProgram--">TrafficLightOperatingSystem</a></code></span></div> |
| <div class="block">Returns the traffic light program that is currently running on a traffic light group using this operating system.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#getCurrentProgram--">getCurrentProgram</a></code> in interface <code><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></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current traffic light program</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCurrentPhase--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrentPhase</h4> |
| <pre>public <a href="../../../../../../../org/eclipse/mosaic/lib/objects/trafficlight/TrafficLightProgramPhase.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightProgramPhase</a> getCurrentPhase()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#getCurrentPhase--">TrafficLightOperatingSystem</a></code></span></div> |
| <div class="block">Returns the traffic light program phase that is currently running on a traffic light group using this operating system.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#getCurrentPhase--">getCurrentPhase</a></code> in interface <code><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></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current traffic light program phase</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllTrafficLights--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllTrafficLights</h4> |
| <pre>public <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/lib/objects/trafficlight/TrafficLight.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLight</a>> getAllTrafficLights()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#getAllTrafficLights--">TrafficLightOperatingSystem</a></code></span></div> |
| <div class="block">Returns all traffic lights a traffic light group using this operating system consist of</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/application/app/api/os/TrafficLightOperatingSystem.html#getAllTrafficLights--">getAllTrafficLights</a></code> in interface <code><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></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all traffic lights within a traffic light group</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assembleCamMessage-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.CamBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>assembleCamMessage</h4> |
| <pre>public <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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/communication/CommunicationModuleOwner.html#assembleCamMessage-org.eclipse.mosaic.fed.application.ambassador.simulation.communication.CamBuilder-">CommunicationModuleOwner</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><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> 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>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> |
| </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/TrafficLightGroupUnit.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/RoadSideUnit.html" title="class in org.eclipse.mosaic.fed.application.ambassador.simulation"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/eclipse/mosaic/fed/application/ambassador/simulation/TrafficManagementCenterUnit.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/TrafficLightGroupUnit.html" target="_top">Frames</a></li> |
| <li><a href="TrafficLightGroupUnit.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |