| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_262) on Wed Mar 10 21:50:12 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TraciClient (Eclipse MOSAIC Parent 21.0 API)</title> |
| <meta name="date" content="2021-03-10"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="TraciClient (Eclipse MOSAIC Parent 21.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}; |
| 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/TraciClient.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/SumoVersion.html" title="enum in org.eclipse.mosaic.fed.sumo.traci"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciCommandException.html" title="class in org.eclipse.mosaic.fed.sumo.traci"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/mosaic/fed/sumo/traci/TraciClient.html" target="_top">Frames</a></li> |
| <li><a href="TraciClient.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><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.fed.sumo.traci</div> |
| <h2 title="Class TraciClient" class="title">Class TraciClient</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.TraciClient</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html" title="interface in org.eclipse.mosaic.fed.sumo.traci">TraciConnection</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">TraciClient</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> |
| implements <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html" title="interface in org.eclipse.mosaic.fed.sumo.traci">TraciConnection</a></pre> |
| <div class="block">Implementation of a TraCI client.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== 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="../../../../../../org/eclipse/mosaic/lib/util/objects/IdTransformer.html" title="interface in org.eclipse.mosaic.lib.util.objects">IdTransformer</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html#VEHICLE_ID_TRANSFORMER">VEHICLE_ID_TRANSFORMER</a></span></code> |
| <div class="block">Defines the <a href="../../../../../../org/eclipse/mosaic/lib/util/objects/IdTransformer.html" title="interface in org.eclipse.mosaic.lib.util.objects"><code>IdTransformer</code></a> which transforms the vehicle IDs if required.</div> |
| </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"> </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/TraciClient.html#TraciClient-org.eclipse.mosaic.fed.sumo.config.CSumo-java.net.Socket-">TraciClient</a></span>(<a href="../../../../../../org/eclipse/mosaic/fed/sumo/config/CSumo.html" title="class in org.eclipse.mosaic.fed.sumo.config">CSumo</a> sumoConfiguration, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a> sumoServerSocket)</code> |
| <div class="block">Constructor for <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html" title="class in org.eclipse.mosaic.fed.sumo.traci"><code>TraciClient</code></a> uses a default <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/CommandRegister.html" title="class in org.eclipse.mosaic.fed.sumo.traci"><code>CommandRegister</code></a> if none has been given.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html#TraciClient-org.eclipse.mosaic.fed.sumo.config.CSumo-java.net.Socket-org.eclipse.mosaic.fed.sumo.traci.CommandRegister-">TraciClient</a></span>(<a href="../../../../../../org/eclipse/mosaic/fed/sumo/config/CSumo.html" title="class in org.eclipse.mosaic.fed.sumo.config">CSumo</a> sumoConfiguration, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a> sumoServerSocket, |
| <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/CommandRegister.html" title="class in org.eclipse.mosaic.fed.sumo.traci">CommandRegister</a> commandRegister)</code> |
| <div class="block">Creates a new <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html" title="class in org.eclipse.mosaic.fed.sumo.traci"><code>TraciClient</code></a> object with the specified SUMO configuration file, the SUMO server socket |
| and the command register.</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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html#close--">close</a></span>()</code> |
| <div class="block">Requests to close the simulation and determines all socket connections to |
| the SUMO.</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/TraciClient.html#emergencyExit-java.lang.Throwable-">emergencyExit</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> e)</code> |
| <div class="block">Call this method if the traci-connection should be closed immediately.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/CommandRegister.html" title="class in org.eclipse.mosaic.fed.sumo.traci">CommandRegister</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html#getCommandRegister--">getCommandRegister</a></span>()</code> |
| <div class="block">Getter for the command register.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/SumoVersion.html" title="enum in org.eclipse.mosaic.fed.sumo.traci">SumoVersion</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html#getCurrentVersion--">getCurrentVersion</a></span>()</code> |
| <div class="block">Getter for the currently running SUMO version.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataInputStream.html?is-external=true" title="class or interface in java.io">DataInputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html#getIn--">getIn</a></span>()</code> |
| <div class="block">Getter for the input stream.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataOutputStream.html?is-external=true" title="class or interface in java.io">DataOutputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html#getOut--">getOut</a></span>()</code> |
| <div class="block">Getter for the output stream.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/facades/TraciPoiFacade.html" title="class in org.eclipse.mosaic.fed.sumo.traci.facades">TraciPoiFacade</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html#getPoiControl--">getPoiControl</a></span>()</code> |
| <div class="block">Returns a facade which offers methods to add POIs to the SUMO GUI and change its properties.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/facades/TraciRouteFacade.html" title="class in org.eclipse.mosaic.fed.sumo.traci.facades">TraciRouteFacade</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html#getRouteControl--">getRouteControl</a></span>()</code> |
| <div class="block">Returns a facade which offers methods to control routes taken by vehicles in the simulation.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/facades/TraciSimulationFacade.html" title="class in org.eclipse.mosaic.fed.sumo.traci.facades">TraciSimulationFacade</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html#getSimulationControl--">getSimulationControl</a></span>()</code> |
| <div class="block">Returns a facade which offers methods to control the simulation.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/facades/TraciTrafficLightFacade.html" title="class in org.eclipse.mosaic.fed.sumo.traci.facades">TraciTrafficLightFacade</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html#getTrafficLightControl--">getTrafficLightControl</a></span>()</code> |
| <div class="block">Returns a facade which offers methods to control traffic lights in the simulation.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/facades/TraciVehicleFacade.html" title="class in org.eclipse.mosaic.fed.sumo.traci.facades">TraciVehicleFacade</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html#getVehicleControl--">getVehicleControl</a></span>()</code> |
| <div class="block">Returns a facade which offers methods to control the vehicles in the simulation.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/mosaic/lib/objects/traffic/SumoTraciResult.html" title="class in org.eclipse.mosaic.lib.objects.traffic">SumoTraciResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html#writeByteArrayMessage-java.lang.String-byte:A-">writeByteArrayMessage</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> msgId, |
| byte[] msg)</code> |
| <div class="block">Sends a custom byte array to the traci channel.</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 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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="VEHICLE_ID_TRANSFORMER"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>VEHICLE_ID_TRANSFORMER</h4> |
| <pre>public static final <a href="../../../../../../org/eclipse/mosaic/lib/util/objects/IdTransformer.html" title="interface in org.eclipse.mosaic.lib.util.objects">IdTransformer</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>> VEHICLE_ID_TRANSFORMER</pre> |
| <div class="block">Defines the <a href="../../../../../../org/eclipse/mosaic/lib/util/objects/IdTransformer.html" title="interface in org.eclipse.mosaic.lib.util.objects"><code>IdTransformer</code></a> which transforms the vehicle IDs if required. Every |
| <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/AbstractTraciCommand.html" title="class in org.eclipse.mosaic.fed.sumo.traci"><code>AbstractTraciCommand</code></a> which reads or writes a vehicle ID, uses this transformer. Per default |
| no transformation is done, i.e. passing the vehicle IDs as is. However, for other scenarios |
| a custom transformer may be defined here, which converts the vehicle IDs known by SUMO to |
| vehicle IDs known by the consumer (e.g. MOSAIC) of this TraciClient.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TraciClient-org.eclipse.mosaic.fed.sumo.config.CSumo-java.net.Socket-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TraciClient</h4> |
| <pre>public TraciClient(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a> |
| <a href="../../../../../../org/eclipse/mosaic/fed/sumo/config/CSumo.html" title="class in org.eclipse.mosaic.fed.sumo.config">CSumo</a> sumoConfiguration, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a> |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a> sumoServerSocket) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Constructor for <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html" title="class in org.eclipse.mosaic.fed.sumo.traci"><code>TraciClient</code></a> uses a default <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/CommandRegister.html" title="class in org.eclipse.mosaic.fed.sumo.traci"><code>CommandRegister</code></a> if none has been given.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sumoConfiguration</code> - SUMO configuration file.</dd> |
| <dd><code>sumoServerSocket</code> - SUMO server socket.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Error while reading or writing.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="TraciClient-org.eclipse.mosaic.fed.sumo.config.CSumo-java.net.Socket-org.eclipse.mosaic.fed.sumo.traci.CommandRegister-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TraciClient</h4> |
| <pre>public TraciClient(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a> |
| <a href="../../../../../../org/eclipse/mosaic/fed/sumo/config/CSumo.html" title="class in org.eclipse.mosaic.fed.sumo.config">CSumo</a> sumoConfiguration, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a> |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a> sumoServerSocket, |
| <a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a> |
| <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/CommandRegister.html" title="class in org.eclipse.mosaic.fed.sumo.traci">CommandRegister</a> commandRegister) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Creates a new <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciClient.html" title="class in org.eclipse.mosaic.fed.sumo.traci"><code>TraciClient</code></a> object with the specified SUMO configuration file, the SUMO server socket |
| and the command register.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sumoConfiguration</code> - SUMO configuration file.</dd> |
| <dd><code>sumoServerSocket</code> - SUMO server socket.</dd> |
| <dd><code>commandRegister</code> - Command register.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Error while reading or writing.</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="getSimulationControl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSimulationControl</h4> |
| <pre>public <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/facades/TraciSimulationFacade.html" title="class in org.eclipse.mosaic.fed.sumo.traci.facades">TraciSimulationFacade</a> getSimulationControl()</pre> |
| <div class="block">Returns a facade which offers methods to control the simulation.</div> |
| </li> |
| </ul> |
| <a name="getVehicleControl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVehicleControl</h4> |
| <pre>public <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/facades/TraciVehicleFacade.html" title="class in org.eclipse.mosaic.fed.sumo.traci.facades">TraciVehicleFacade</a> getVehicleControl()</pre> |
| <div class="block">Returns a facade which offers methods to control the vehicles in the simulation.</div> |
| </li> |
| </ul> |
| <a name="getTrafficLightControl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrafficLightControl</h4> |
| <pre>public <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/facades/TraciTrafficLightFacade.html" title="class in org.eclipse.mosaic.fed.sumo.traci.facades">TraciTrafficLightFacade</a> getTrafficLightControl()</pre> |
| <div class="block">Returns a facade which offers methods to control traffic lights in the simulation.</div> |
| </li> |
| </ul> |
| <a name="getRouteControl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRouteControl</h4> |
| <pre>public <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/facades/TraciRouteFacade.html" title="class in org.eclipse.mosaic.fed.sumo.traci.facades">TraciRouteFacade</a> getRouteControl()</pre> |
| <div class="block">Returns a facade which offers methods to control routes taken by vehicles in the simulation.</div> |
| </li> |
| </ul> |
| <a name="getPoiControl--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPoiControl</h4> |
| <pre>public <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/facades/TraciPoiFacade.html" title="class in org.eclipse.mosaic.fed.sumo.traci.facades">TraciPoiFacade</a> getPoiControl()</pre> |
| <div class="block">Returns a facade which offers methods to add POIs to the SUMO GUI and change its properties.</div> |
| </li> |
| </ul> |
| <a name="writeByteArrayMessage-java.lang.String-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeByteArrayMessage</h4> |
| <pre>public <a href="../../../../../../org/eclipse/mosaic/lib/objects/traffic/SumoTraciResult.html" title="class in org.eclipse.mosaic.lib.objects.traffic">SumoTraciResult</a> writeByteArrayMessage(<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> msgId, |
| byte[] msg) |
| throws <a href="../../../../../../org/eclipse/mosaic/rti/api/InternalFederateException.html" title="class in org.eclipse.mosaic.rti.api">InternalFederateException</a></pre> |
| <div class="block">Sends a custom byte array to the traci channel.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>msgId</code> - the laneId of the byte array message which is included in the result</dd> |
| <dd><code>msg</code> - the bytes to be sent. this should only contain the command, the header information will be added automatically.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an object containing the response of TraCI (without header information)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block">Requests to close the simulation and determines all socket connections to |
| the SUMO.</div> |
| </li> |
| </ul> |
| <a name="getCurrentVersion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrentVersion</h4> |
| <pre>public <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/SumoVersion.html" title="enum in org.eclipse.mosaic.fed.sumo.traci">SumoVersion</a> getCurrentVersion()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html#getCurrentVersion--">TraciConnection</a></code></span></div> |
| <div class="block">Getter for the currently running SUMO version.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html#getCurrentVersion--">getCurrentVersion</a></code> in interface <code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html" title="interface in org.eclipse.mosaic.fed.sumo.traci">TraciConnection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the SUMO Version of the TraCI server.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIn--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIn</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataInputStream.html?is-external=true" title="class or interface in java.io">DataInputStream</a> getIn()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html#getIn--">TraciConnection</a></code></span></div> |
| <div class="block">Getter for the input stream.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html#getIn--">getIn</a></code> in interface <code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html" title="interface in org.eclipse.mosaic.fed.sumo.traci">TraciConnection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the input stream from the server for reading.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOut--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOut</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataOutputStream.html?is-external=true" title="class or interface in java.io">DataOutputStream</a> getOut()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html#getOut--">TraciConnection</a></code></span></div> |
| <div class="block">Getter for the output stream.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html#getOut--">getOut</a></code> in interface <code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html" title="interface in org.eclipse.mosaic.fed.sumo.traci">TraciConnection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the output stream towards the server for writing.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCommandRegister--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCommandRegister</h4> |
| <pre>public <a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/CommandRegister.html" title="class in org.eclipse.mosaic.fed.sumo.traci">CommandRegister</a> getCommandRegister()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html#getCommandRegister--">TraciConnection</a></code></span></div> |
| <div class="block">Getter for the command register.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html#getCommandRegister--">getCommandRegister</a></code> in interface <code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html" title="interface in org.eclipse.mosaic.fed.sumo.traci">TraciConnection</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the register where command instances are stored.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="emergencyExit-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>emergencyExit</h4> |
| <pre>public void emergencyExit(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> e)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html#emergencyExit-java.lang.Throwable-">TraciConnection</a></code></span></div> |
| <div class="block">Call this method if the traci-connection should be closed immediately.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html#emergencyExit-java.lang.Throwable-">emergencyExit</a></code> in interface <code><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciConnection.html" title="interface in org.eclipse.mosaic.fed.sumo.traci">TraciConnection</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/TraciClient.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/SumoVersion.html" title="enum in org.eclipse.mosaic.fed.sumo.traci"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/eclipse/mosaic/fed/sumo/traci/TraciCommandException.html" title="class in org.eclipse.mosaic.fed.sumo.traci"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/mosaic/fed/sumo/traci/TraciClient.html" target="_top">Frames</a></li> |
| <li><a href="TraciClient.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><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–2021 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p> |
| </body> |
| </html> |