blob: 7a3c1b51d1770eaf1b071f79b7a3ea30e4ff31e4 [file] [log] [blame]
<!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:09 GMT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TrafficLightSetProgram (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="TrafficLightSetProgram (Eclipse MOSAIC Parent 20.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":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/TrafficLightSetProgram.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/sumo/traci/commands/TrafficLightSetPhaseIndex.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightSetRemainingPhaseDuration.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightSetProgram.html" target="_top">Frames</a></li>
<li><a href="TrafficLightSetProgram.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.eclipse.mosaic.fed.sumo.traci.AbstractTraciCommand">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.sumo.traci.commands</div>
<h2 title="Class TrafficLightSetProgram" class="title">Class TrafficLightSetProgram</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/sumo/traci/AbstractTraciCommand.html" title="class in org.eclipse.mosaic.fed.sumo.traci">org.eclipse.mosaic.fed.sumo.traci.AbstractTraciCommand</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.eclipse.mosaic.fed.sumo.traci.commands.TrafficLightSetProgram</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">TrafficLightSetProgram</span>
extends <a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html" title="class in org.eclipse.mosaic.fed.sumo.traci">AbstractTraciCommand</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;</pre>
<div class="block">This class represents the traci command which allows to set the traffic light program.</div>
</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>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.eclipse.mosaic.fed.sumo.traci.AbstractTraciCommand">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.eclipse.mosaic.fed.sumo.traci.<a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html" title="class in org.eclipse.mosaic.fed.sumo.traci">AbstractTraciCommand</a></h3>
<code><a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.TraciCommandResultReaderBuilder.html" title="class in org.eclipse.mosaic.fed.sumo.traci">AbstractTraciCommand.TraciCommandResultReaderBuilder</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.TraciCommandWriterBuilder.html" title="class in org.eclipse.mosaic.fed.sumo.traci">AbstractTraciCommand.TraciCommandWriterBuilder</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">&nbsp;</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/sumo/traci/commands/TrafficLightSetProgram.html#TrafficLightSetProgram--">TrafficLightSetProgram</a></span>()</code>
<div class="block">Creates a new <a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightSetProgram.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands"><code>TrafficLightSetProgram</code></a> object.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightSetProgram.html#constructResult-org.eclipse.mosaic.fed.sumo.traci.complex.Status-java.lang.Object...-">constructResult</a></span>(<a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/complex/Status.html" title="class in org.eclipse.mosaic.fed.sumo.traci.complex">Status</a>&nbsp;status,
<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>...&nbsp;objects)</code>
<div class="block">This method is called during reading the command response when all readers have been executed.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightSetProgram.html#execute-org.eclipse.mosaic.fed.sumo.traci.TraciConnection-java.lang.String-java.lang.String-">execute</a></span>(<a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html" title="interface in org.eclipse.mosaic.fed.sumo.traci">TraciConnection</a>&nbsp;con,
<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>&nbsp;tlId,
<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>&nbsp;programId)</code>
<div class="block">This method executes the command with the given arguments in order to set the traffic light program.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.fed.sumo.traci.AbstractTraciCommand">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.mosaic.fed.sumo.traci.<a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html" title="class in org.eclipse.mosaic.fed.sumo.traci">AbstractTraciCommand</a></h3>
<code><a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#execute-org.eclipse.mosaic.fed.sumo.traci.TraciConnection-java.lang.Object...-">execute</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#executeAndReturn-org.eclipse.mosaic.fed.sumo.traci.TraciConnection-java.lang.Object...-">executeAndReturn</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#executeAndReturnList-org.eclipse.mosaic.fed.sumo.traci.TraciConnection-java.lang.Object...-">executeAndReturnList</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#read--">read</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#write--">write</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&nbsp;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>
</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="TrafficLightSetProgram--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TrafficLightSetProgram</h4>
<pre>public&nbsp;TrafficLightSetProgram()</pre>
<div class="block">Creates a new <a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightSetProgram.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands"><code>TrafficLightSetProgram</code></a> object.
Access needs to be public, because command is called using Reflection.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://sumo.dlr.de/docs/TraCI/Change_Traffic_Lights_State.html">Traffic Lights State Change</a></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="execute-org.eclipse.mosaic.fed.sumo.traci.TraciConnection-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public&nbsp;void&nbsp;execute(<a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html" title="interface in org.eclipse.mosaic.fed.sumo.traci">TraciConnection</a>&nbsp;con,
<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>&nbsp;tlId,
<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>&nbsp;programId)
throws <a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciCommandException.html" title="class in org.eclipse.mosaic.fed.sumo.traci">TraciCommandException</a>,
<a href="../../../../../../../org/eclipse/mosaic/rti/api/InternalFederateException.html" title="class in org.eclipse.mosaic.rti.api">InternalFederateException</a></pre>
<div class="block">This method executes the command with the given arguments in order to set the traffic light program.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>con</code> - Connection to Traci.</dd>
<dd><code>tlId</code> - Id of the traffic light.</dd>
<dd><code>programId</code> - Id of the traffic light program.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciCommandException.html" title="class in org.eclipse.mosaic.fed.sumo.traci">TraciCommandException</a></code> - if the status code of the response is ERROR. The TraCI connection is still available.</dd>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/rti/api/InternalFederateException.html" title="class in org.eclipse.mosaic.rti.api">InternalFederateException</a></code> - if some serious error occurs during writing or reading. The TraCI connection is shut down.</dd>
</dl>
</li>
</ul>
<a name="constructResult-org.eclipse.mosaic.fed.sumo.traci.complex.Status-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>constructResult</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&nbsp;constructResult(<a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/complex/Status.html" title="class in org.eclipse.mosaic.fed.sumo.traci.complex">Status</a>&nbsp;status,
<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>...&nbsp;objects)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#constructResult-org.eclipse.mosaic.fed.sumo.traci.complex.Status-java.lang.Object...-">AbstractTraciCommand</a></code></span></div>
<div class="block">This method is called during reading the command response when all readers have been executed.
The results of the readers are passed to this method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#constructResult-org.eclipse.mosaic.fed.sumo.traci.complex.Status-java.lang.Object...-">constructResult</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html" title="class in org.eclipse.mosaic.fed.sumo.traci">AbstractTraciCommand</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>status</code> - the status of the response</dd>
<dd><code>objects</code> - the objects created by the configured readers</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the final result constructed from the passed objects</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/TrafficLightSetProgram.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/sumo/traci/commands/TrafficLightSetPhaseIndex.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightSetRemainingPhaseDuration.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightSetProgram.html" target="_top">Frames</a></li>
<li><a href="TrafficLightSetProgram.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.eclipse.mosaic.fed.sumo.traci.AbstractTraciCommand">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2020 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p>
</body>
</html>