| <!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:04 GMT 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TrafficLightStateChange (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="TrafficLightStateChange (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}; |
| 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/TrafficLightStateChange.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/interactions/traffic/TrafficDetectorUpdates.html" title="class in org.eclipse.mosaic.interactions.traffic"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.ParamType.html" title="enum in org.eclipse.mosaic.interactions.traffic"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html" target="_top">Frames</a></li> |
| <li><a href="TrafficLightStateChange.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.interactions.traffic</div> |
| <h2 title="Class TrafficLightStateChange" class="title">Class TrafficLightStateChange</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/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api">org.eclipse.mosaic.rti.api.Interaction</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.mosaic.interactions.traffic.TrafficLightStateChange</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api">Interaction</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">TrafficLightStateChange</span> |
| extends <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api">Interaction</a></pre> |
| <div class="block">This extension of <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api"><code>Interaction</code></a> is intended to be used to |
| forward a request to change the state of a simulated traffic light.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.eclipse.mosaic.interactions.traffic.TrafficLightStateChange">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.ParamType.html" title="enum in org.eclipse.mosaic.interactions.traffic">TrafficLightStateChange.ParamType</a></span></code> |
| <div class="block">Identifies which kind of parameter type is used in this TrafficLightStateChange.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/interactions/traffic/TrafficLightStateChange.html#TYPE_ID">TYPE_ID</a></span></code> |
| <div class="block">String identifying the type of this interaction.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.eclipse.mosaic.rti.api.Interaction"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.mosaic.rti.api.<a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api">Interaction</a></h3> |
| <code><a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html#time">time</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== 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/interactions/traffic/TrafficLightStateChange.html#TrafficLightStateChange-long-java.lang.String-">TrafficLightStateChange</a></span>(long time, |
| <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> trafficLightGroupId)</code> |
| <div class="block">Constructs <a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html" title="class in org.eclipse.mosaic.interactions.traffic"><code>TrafficLightStateChange</code></a>>.</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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html#equals-java.lang.Object-">equals</a></span>(<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> obj)</code> </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><<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/interactions/traffic/TrafficLightStateChange.html#getCustomStateList--">getCustomStateList</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.ParamType.html" title="enum in org.eclipse.mosaic.interactions.traffic">TrafficLightStateChange.ParamType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html#getParameterType--">getParameterType</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html#getPhaseIndex--">getPhaseIndex</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html#getPhaseRemainingDuration--">getPhaseRemainingDuration</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" 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/interactions/traffic/TrafficLightStateChange.html#getProgramId--">getProgramId</a></span>()</code> </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/interactions/traffic/TrafficLightStateChange.html#getTrafficLightGroupId--">getTrafficLightGroupId</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html#hashCode--">hashCode</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html#reset--">reset</a></span>()</code> |
| <div class="block">Resets the pre-defined parameter type and the corresponding parameters.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html#setCustomState-java.util.List-">setCustomState</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">Sets a custom state which will be set for the traffic light.</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/interactions/traffic/TrafficLightStateChange.html#setPhaseIndex-int-">setPhaseIndex</a></span>(int phaseIndex)</code> |
| <div class="block">Sets index of the new traffic light program phase.</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/interactions/traffic/TrafficLightStateChange.html#setPhaseRemainingDuration-double-">setPhaseRemainingDuration</a></span>(double remainingDuration)</code> |
| <div class="block">Sets the phase remaining duration.</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/interactions/traffic/TrafficLightStateChange.html#setProgramId-java.lang.String-">setProgramId</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> programId)</code> |
| <div class="block">Sets id of the new traffic light program.</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/interactions/traffic/TrafficLightStateChange.html#setProgramWithPhase-java.lang.String-int-">setProgramWithPhase</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> programId, |
| int phaseId)</code> |
| <div class="block">Sets id of the new traffic light program and index of the new phase for the new program.</div> |
| </td> |
| </tr> |
| <tr id="i14" 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/interactions/traffic/TrafficLightStateChange.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.rti.api.Interaction"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.mosaic.rti.api.<a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api">Interaction</a></h3> |
| <code><a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html#compareTo-org.eclipse.mosaic.rti.api.Interaction-">compareTo</a>, <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html#createTypeIdentifier-java.lang.Class-">createTypeIdentifier</a>, <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html#getId--">getId</a>, <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html#getSenderId--">getSenderId</a>, <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html#getTime--">getTime</a>, <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html#getTypeId--">getTypeId</a>, <a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html#setSenderId-java.lang.String-">setSenderId</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#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#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#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> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="TYPE_ID"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TYPE_ID</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> TYPE_ID</pre> |
| <div class="block">String identifying the type of this interaction.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TrafficLightStateChange-long-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TrafficLightStateChange</h4> |
| <pre>public TrafficLightStateChange(long time, |
| <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> trafficLightGroupId)</pre> |
| <div class="block">Constructs <a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html" title="class in org.eclipse.mosaic.interactions.traffic"><code>TrafficLightStateChange</code></a>>. |
| The parameter type is initially <code>ParamType.Undefined</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>time</code> - Timestamp of this interaction, unit: [ns]</dd> |
| <dd><code>trafficLightGroupId</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="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>public void reset()</pre> |
| <div class="block">Resets the pre-defined parameter type and the corresponding parameters. |
| The parameter type of this <a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html" title="class in org.eclipse.mosaic.interactions.traffic"><code>TrafficLightStateChange</code></a> changes to |
| <code>ParamType.Undefined</code>.</div> |
| </li> |
| </ul> |
| <a name="setPhaseRemainingDuration-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPhaseRemainingDuration</h4> |
| <pre>public void setPhaseRemainingDuration(double remainingDuration)</pre> |
| <div class="block">Sets the phase remaining duration. |
| The parameter type of this <a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html" title="class in org.eclipse.mosaic.interactions.traffic"><code>TrafficLightStateChange</code></a> changes to |
| <code>ParamType.RemainingDuration</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>remainingDuration</code> - new phase remaining duration in millisecond</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setProgramId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProgramId</h4> |
| <pre>public void setProgramId(<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> programId)</pre> |
| <div class="block">Sets id of the new traffic light program. |
| The parameter type of this <a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html" title="class in org.eclipse.mosaic.interactions.traffic"><code>TrafficLightStateChange</code></a> changes to |
| <code>ParamType.ProgramId</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>programId</code> - id of the new traffic light program</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPhaseIndex-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPhaseIndex</h4> |
| <pre>public void setPhaseIndex(int phaseIndex)</pre> |
| <div class="block">Sets index of the new traffic light program phase. |
| The parameter type of this <a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html" title="class in org.eclipse.mosaic.interactions.traffic"><code>TrafficLightStateChange</code></a> changes to |
| <code>ParamType.ChangePhase</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>phaseIndex</code> - index of the new traffic light program phase</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setProgramWithPhase-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProgramWithPhase</h4> |
| <pre>public void setProgramWithPhase(<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> programId, |
| int phaseId)</pre> |
| <div class="block">Sets id of the new traffic light program and index of the new phase for the new program. |
| The parameter type of this <a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html" title="class in org.eclipse.mosaic.interactions.traffic"><code>TrafficLightStateChange</code></a> changes to |
| <code>ParamType.ChangeProgramWithPhase</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>programId</code> - index of the new traffic light program</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCustomState-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCustomState</h4> |
| <pre>public void setCustomState(<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">Sets a custom state which will be set for the traffic light.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stateList</code> - the list of states for all traffic lights of the group</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTrafficLightGroupId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrafficLightGroupId</h4> |
| <pre>public <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> getTrafficLightGroupId()</pre> |
| </li> |
| </ul> |
| <a name="getParameterType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameterType</h4> |
| <pre>public <a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.ParamType.html" title="enum in org.eclipse.mosaic.interactions.traffic">TrafficLightStateChange.ParamType</a> getParameterType()</pre> |
| </li> |
| </ul> |
| <a name="getPhaseRemainingDuration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPhaseRemainingDuration</h4> |
| <pre>public double getPhaseRemainingDuration()</pre> |
| </li> |
| </ul> |
| <a name="getProgramId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProgramId</h4> |
| <pre>public <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> getProgramId()</pre> |
| </li> |
| </ul> |
| <a name="getPhaseIndex--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPhaseIndex</h4> |
| <pre>public int getPhaseIndex()</pre> |
| </li> |
| </ul> |
| <a name="getCustomStateList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCustomStateList</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/TrafficLightState.html" title="class in org.eclipse.mosaic.lib.objects.trafficlight">TrafficLightState</a>> getCustomStateList()</pre> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html#hashCode--">hashCode</a></code> in class <code><a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api">Interaction</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(<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> obj)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html#equals-java.lang.Object-">equals</a></code> in class <code><a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api">Interaction</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <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> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html#toString--">toString</a></code> in class <code><a href="../../../../../org/eclipse/mosaic/rti/api/Interaction.html" title="class in org.eclipse.mosaic.rti.api">Interaction</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TrafficLightStateChange.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/interactions/traffic/TrafficDetectorUpdates.html" title="class in org.eclipse.mosaic.interactions.traffic"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.ParamType.html" title="enum in org.eclipse.mosaic.interactions.traffic"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/mosaic/interactions/traffic/TrafficLightStateChange.html" target="_top">Frames</a></li> |
| <li><a href="TrafficLightStateChange.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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> |