blob: ad0d4c79aa43ce7179331cd026773c77cf365fd7 [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>VehicleSetSpeedFactor (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="VehicleSetSpeedFactor (Eclipse MOSAIC Parent 20.0 API)";
}
}
catch(err) {
}
//-->
</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/VehicleSetSpeedFactor.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/VehicleSetSpeed.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/VehicleSetSpeedMode.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/VehicleSetSpeedFactor.html" target="_top">Frames</a></li>
<li><a href="VehicleSetSpeedFactor.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="#methods.inherited.from.class.org.eclipse.mosaic.fed.sumo.traci.commands.AbstractVehicleSetSingleDoubleValue">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>Method</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 VehicleSetSpeedFactor" class="title">Class VehicleSetSpeedFactor</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><a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/AbstractVehicleSetSingleDoubleValue.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">org.eclipse.mosaic.fed.sumo.traci.commands.AbstractVehicleSetSingleDoubleValue</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.mosaic.fed.sumo.traci.commands.VehicleSetSpeedFactor</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">VehicleSetSpeedFactor</span>
extends <a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/AbstractVehicleSetSingleDoubleValue.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">AbstractVehicleSetSingleDoubleValue</a></pre>
<div class="block">This class represents the traci command which allows to set the speed factor for the vehicle.
The speed factor is the parameter that describes how far the vehicle can exceed the maximum permitted speed.
A factor VAR_SPEED_FACTOR = 1 is the maximum permitted speed and a factor VAR_SPEED_FACTOR = 1,1 stands
for the possible exceeding of the maximum permitted speed by 10 percent.</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/VehicleSetSpeedFactor.html#VehicleSetSpeedFactor--">VehicleSetSpeedFactor</a></span>()</code>
<div class="block">Creates a new <a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleSetSpeedFactor.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands"><code>VehicleSetSpeedFactor</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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.mosaic.fed.sumo.traci.commands.AbstractVehicleSetSingleDoubleValue">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.mosaic.fed.sumo.traci.commands.<a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/AbstractVehicleSetSingleDoubleValue.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands">AbstractVehicleSetSingleDoubleValue</a></h3>
<code><a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/AbstractVehicleSetSingleDoubleValue.html#constructResult-org.eclipse.mosaic.fed.sumo.traci.complex.Status-java.lang.Object...-">constructResult</a>, <a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/AbstractVehicleSetSingleDoubleValue.html#execute-org.eclipse.mosaic.fed.sumo.traci.TraciConnection-java.lang.String-double-">execute</a></code></li>
</ul>
<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="VehicleSetSpeedFactor--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>VehicleSetSpeedFactor</h4>
<pre>public&nbsp;VehicleSetSpeedFactor()</pre>
<div class="block">Creates a new <a href="../../../../../../../org/eclipse/mosaic/fed/sumo/traci/commands/VehicleSetSpeedFactor.html" title="class in org.eclipse.mosaic.fed.sumo.traci.commands"><code>VehicleSetSpeedFactor</code></a> object.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://sumo.dlr.de/docs/TraCI/Change_Vehicle_State.html">Vehicle State Change</a></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/VehicleSetSpeedFactor.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/VehicleSetSpeed.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/VehicleSetSpeedMode.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/VehicleSetSpeedFactor.html" target="_top">Frames</a></li>
<li><a href="VehicleSetSpeedFactor.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="#methods.inherited.from.class.org.eclipse.mosaic.fed.sumo.traci.commands.AbstractVehicleSetSingleDoubleValue">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>Method</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>