Google Git
Sign in
eclipse / gerrit / www.eclipse.org / mosaic / d34bf266db7db6621a9cba2a322de650f1980adb / . / java_docs / org / eclipse / mosaic / fed / sumo / traci / AbstractTraciCommand.html
blob: 9f4a16dc433b407d18fbdaee403ece747ab373d6 [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:08 GMT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AbstractTraciCommand (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="AbstractTraciCommand (Eclipse MOSAIC Parent 20.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/AbstractTraciCommand.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.TraciCommandResultReaderBuilder.html" title="class in org.eclipse.mosaic.fed.sumo.traci"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html" target="_top">Frames</a></li>
<li><a href="AbstractTraciCommand.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.class.summary">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</div>
<h2 title="Class AbstractTraciCommand" class="title">Class AbstractTraciCommand&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.mosaic.fed.sumo.traci.AbstractTraciCommand&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/AbstractVehicleSetSingleDoubleValue.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">AbstractVehicleSetSingleDoubleValue</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/AbstractVehicleSetSingleIntegerValue.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">AbstractVehicleSetSingleIntegerValue</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/InductionLoopSubscribe.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">InductionLoopSubscribe</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/JunctionGetPosition.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">JunctionGetPosition</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/LaneAreaSubscribe.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">LaneAreaSubscribe</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/LaneGetLength.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">LaneGetLength</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/LaneSetAllow.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">LaneSetAllow</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/LaneSetDisallow.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">LaneSetDisallow</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/LaneSetMaxSpeed.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">LaneSetMaxSpeed</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/PoiAdd.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">PoiAdd</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/PoiRemove.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">PoiRemove</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/PoiSetAngle.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">PoiSetAngle</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/PoiSetHeight.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">PoiSetHeight</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/PoiSetImage.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">PoiSetImage</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/PoiSetWidth.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">PoiSetWidth</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/RouteAdd.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">RouteAdd</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/RouteGetEdges.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">RouteGetEdges</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/RouteGetIds.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">RouteGetIds</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/SimulationClose.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">SimulationClose</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/SimulationGetDepartedVehicleIds.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">SimulationGetDepartedVehicleIds</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/SimulationGetTrafficLightIds.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">SimulationGetTrafficLightIds</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/SimulationGetVersion.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">SimulationGetVersion</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/SimulationSimulateStep.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">SimulationSimulateStep</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/SimulationTraciRequest.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">SimulationTraciRequest</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightAddProgram.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">TrafficLightAddProgram</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightGetControlledLanes.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">TrafficLightGetControlledLanes</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightGetControlledLinks.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">TrafficLightGetControlledLinks</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightGetCurrentPhase.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">TrafficLightGetCurrentPhase</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightGetCurrentProgram.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">TrafficLightGetCurrentProgram</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightGetPrograms.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">TrafficLightGetPrograms</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightGetState.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">TrafficLightGetState</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightGetTimeOfNextSwitch.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">TrafficLightGetTimeOfNextSwitch</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightSetPhaseIndex.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">TrafficLightSetPhaseIndex</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightSetProgram.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">TrafficLightSetProgram</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightSetRemainingPhaseDuration.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">TrafficLightSetRemainingPhaseDuration</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightSetState.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">TrafficLightSetState</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/TrafficLightSubscribe.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">TrafficLightSubscribe</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleAdd.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleAdd</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleGetLeader.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleGetLeader</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleGetParameter.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleGetParameter</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleGetRouteId.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleGetRouteId</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleGetVehicleTypeId.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleGetVehicleTypeId</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleSetColor.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleSetColor</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleSetHighlight.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleSetHighlight</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleSetLane.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleSetLane</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleSetMoveToXY.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleSetMoveToXY</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleSetParameter.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleSetParameter</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleSetRemove.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleSetRemove</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleSetResume.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleSetResume</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleSetRouteById.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleSetRouteById</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleSetSlowDown.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleSetSlowDown</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleSetStop.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleSetStop</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleSetUpdateBestLanes.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleSetUpdateBestLanes</a>, <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleSubscribe.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">VehicleSubscribe</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractTraciCommand&lt;T&gt;</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">This class handles the whole construction of a traci command message and reads its responds. To
achieve this, each subclass needs to define the command, the variable and all parameters which are
required for the specific command.</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>
<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">&nbsp;</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>protected static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.TraciCommandResultReaderBuilder.html" title="class in org.eclipse.mosaic.fed.sumo.traci">AbstractTraciCommand.TraciCommandResultReaderBuilder</a></span></code>
<div class="block">Provides methods to configure readers in a builder-like manner.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.TraciCommandWriterBuilder.html" title="class in org.eclipse.mosaic.fed.sumo.traci">AbstractTraciCommand.TraciCommandWriterBuilder</a></span></code>&nbsp;</td>
</tr>
</table>
</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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#AbstractTraciCommand-org.eclipse.mosaic.fed.sumo.traci.SumoVersion-">AbstractTraciCommand</a></span>(<a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/SumoVersion.html" title="enum in org.eclipse.mosaic.fed.sumo.traci">SumoVersion</a>&nbsp;since)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#AbstractTraciCommand-org.eclipse.mosaic.fed.sumo.traci.TraciVersion-">AbstractTraciCommand</a></span>(<a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciVersion.html" title="enum in org.eclipse.mosaic.fed.sumo.traci">TraciVersion</a>&nbsp;since)</code>&nbsp;</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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 abstract <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html" title="type parameter in AbstractTraciCommand">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.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>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#execute-org.eclipse.mosaic.fed.sumo.traci.TraciConnection-java.lang.Object...-">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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;arguments)</code>
<div class="block">Call this method to execute the command with the given arguments.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html" title="type parameter in AbstractTraciCommand">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#executeAndReturn-org.eclipse.mosaic.fed.sumo.traci.TraciConnection-java.lang.Object...-">executeAndReturn</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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;arguments)</code>
<div class="block">Call this method to execute the command with the given arguments.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <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>&lt;<a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html" title="type parameter in AbstractTraciCommand">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#executeAndReturnList-org.eclipse.mosaic.fed.sumo.traci.TraciConnection-java.lang.Object...-">executeAndReturnList</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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;arguments)</code>
<div class="block">Call this method to execute the command with the given arguments.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.TraciCommandResultReaderBuilder.html" title="class in org.eclipse.mosaic.fed.sumo.traci">AbstractTraciCommand.TraciCommandResultReaderBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#read--">read</a></span>()</code>
<div class="block">Call this method in the constructor to define all readers for this command.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.TraciCommandWriterBuilder.html" title="class in org.eclipse.mosaic.fed.sumo.traci">AbstractTraciCommand.TraciCommandWriterBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#write--">write</a></span>()</code>
<div class="block">Call this method in the constructor to define all writers for this command.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&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="AbstractTraciCommand-org.eclipse.mosaic.fed.sumo.traci.SumoVersion-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AbstractTraciCommand</h4>
<pre>protected&nbsp;AbstractTraciCommand(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
<a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/SumoVersion.html" title="enum in org.eclipse.mosaic.fed.sumo.traci">SumoVersion</a>&nbsp;since)</pre>
</li>
</ul>
<a name="AbstractTraciCommand-org.eclipse.mosaic.fed.sumo.traci.TraciVersion-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractTraciCommand</h4>
<pre>protected&nbsp;AbstractTraciCommand(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
<a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciVersion.html" title="enum in org.eclipse.mosaic.fed.sumo.traci">TraciVersion</a>&nbsp;since)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="write--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>protected&nbsp;<a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.TraciCommandWriterBuilder.html" title="class in org.eclipse.mosaic.fed.sumo.traci">AbstractTraciCommand.TraciCommandWriterBuilder</a>&nbsp;write()</pre>
<div class="block">Call this method in the constructor to define all writers for this command.</div>
</li>
</ul>
<a name="read--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>protected&nbsp;<a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.TraciCommandResultReaderBuilder.html" title="class in org.eclipse.mosaic.fed.sumo.traci">AbstractTraciCommand.TraciCommandResultReaderBuilder</a>&nbsp;read()</pre>
<div class="block">Call this method in the constructor to define all readers for this command.</div>
</li>
</ul>
<a name="execute-org.eclipse.mosaic.fed.sumo.traci.TraciConnection-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>protected&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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;arguments)
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">Call this method to execute the command with the given arguments. The order of arguments must match
the order of parameter writers which have been defined in the constructor. No result is returned.</div>
<dl>
<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="executeAndReturnList-org.eclipse.mosaic.fed.sumo.traci.TraciConnection-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeAndReturnList</h4>
<pre>protected&nbsp;<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>&lt;<a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html" title="type parameter in AbstractTraciCommand">T</a>&gt;&nbsp;executeAndReturnList(<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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;arguments)
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">Call this method to execute the command with the given arguments. The order of arguments must match
the order of parameter writers which have been defined in the constructor. The response is expected to
return a list of results. For each of those results, all readers are called and the resulting objects are passed
to <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#constructResult-org.eclipse.mosaic.fed.sumo.traci.complex.Status-java.lang.Object...-"><code>constructResult(Status, Object...)</code></a>. All objects constructed by this method are added to the list which
eventually will be returned by this method.</div>
<dl>
<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="executeAndReturn-org.eclipse.mosaic.fed.sumo.traci.TraciConnection-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeAndReturn</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html" title="type parameter in AbstractTraciCommand">T</a>&gt;&nbsp;executeAndReturn(<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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;arguments)
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">Call this method to execute the command with the given arguments. The order of arguments must match
the order of parameter writers which have been defined in the constructor. For the response all configured
readers are called and the resulting objects are passed to <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html#constructResult-org.eclipse.mosaic.fed.sumo.traci.complex.Status-java.lang.Object...-"><code>constructResult(Status, Object...)</code></a>. The
object constructed by this method will be returned by this method.</div>
<dl>
<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 abstract&nbsp;<a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html" title="type parameter in AbstractTraciCommand">T</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">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="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/AbstractTraciCommand.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.TraciCommandResultReaderBuilder.html" title="class in org.eclipse.mosaic.fed.sumo.traci"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html" target="_top">Frames</a></li>
<li><a href="AbstractTraciCommand.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.class.summary">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>