|
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
- "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="de">
- <head>
- <!-- Generated by javadoc (1.8.0_242-release) on Sun Nov 15 16:26:40 CET 2020 -->
- <title>Vehicle</title>
- <meta content="2020-11-15" name="date">
- <link href="../../../stylesheet.css" rel="stylesheet" title="Style" type="text/css">
- <script src="../../../script.js" type="text/javascript"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="Vehicle";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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="../../../de/hems/trafficsim/package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../de/hems/trafficsim/Track.html"
- title="class in de.hems.trafficsim"><span class="typeNameLink">Prev Class</span></a>
- </li>
- <li><a href="../../../de/hems/trafficsim/VehicleTimeRecord.html"
- title="class in de.hems.trafficsim"><span class="typeNameLink">Next Class</span></a>
- </li>
- </ul>
- <ul class="navList">
- <li><a href="../../../index.html?de/hems/trafficsim/Vehicle.html" target="_top">Frames</a>
- </li>
- <li><a href="Vehicle.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">de.hems.trafficsim</div>
- <h2 class="title" title="Class Vehicle">Class Vehicle</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>de.hems.trafficsim.Vehicle</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <hr>
- <br>
- <pre>public class <span class="typeNameLabel">Vehicle</span>
- extends java.lang.Object</pre>
- <div class="block">Model class which represents a vehicle in the simulation.</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 border="0" cellpadding="3" cellspacing="0" class="memberSummary"
- 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>protected float</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a
- href="../../../de/hems/trafficsim/Vehicle.html#brakeProb">brakeProb</a></span></code>
- <div class="block">probability of the vehicle to brake without
- reason
- </div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>protected float</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a
- href="../../../de/hems/trafficsim/Vehicle.html#curVelocity">curVelocity</a></span></code>
- <div class="block">current velocity of the vehicle</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>protected int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a
- href="../../../de/hems/trafficsim/Vehicle.html#id">id</a></span></code>
- <div class="block">a number to index the vehicle</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>protected float</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a
- href="../../../de/hems/trafficsim/Vehicle.html#maxVelocity">maxVelocity</a></span></code>
- <div class="block">maximum velocity of the vehicle</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>protected float</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a
- href="../../../de/hems/trafficsim/Vehicle.html#position">position</a></span></code>
- <div class="block">current position of the vehicle on the
- track
- </div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>protected float</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a
- href="../../../de/hems/trafficsim/Vehicle.html#trackLength">trackLength</a></span></code>
- <div class="block">length of the track the vehicle is placed
- on
- </div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.summary">
- <!-- -->
- </a>
- <h3>Constructor Summary</h3>
- <table border="0" cellpadding="3" cellspacing="0" class="memberSummary"
- 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="../../../de/hems/trafficsim/Vehicle.html#Vehicle-int-int-float-float-float-">Vehicle</a></span>(int id,
- int position,
- float maxVelocity,
- float brakeProb,
- float trackLength)</code>
- <div class="block">Constructs a new vehicle.</div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table border="0" cellpadding="3" cellspacing="0" class="memberSummary"
- summary="Method Summary table, listing methods, and an explanation">
- <caption><span class="activeTableTab"
- id="t0"><span>All Methods</span><span class="tabEnd"> </span></span><span
- class="tableTab" id="t2"><span><a href="javascript:show(2);">Instance Methods</a></span><span
- class="tabEnd"> </span></span><span class="tableTab"
- id="t4"><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 class="altColor" id="i0">
- <td class="colFirst"><code>float</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a
- href="../../../de/hems/trafficsim/Vehicle.html#getCurVelocity--">getCurVelocity</a></span>()</code>
- <div class="block">Getter for curVelocity</div>
- </td>
- </tr>
- <tr class="rowColor" id="i1">
- <td class="colFirst"><code>float</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a
- href="../../../de/hems/trafficsim/Vehicle.html#getMaxVelocity--">getMaxVelocity</a></span>()</code>
- <div class="block">Getter for maxVelocity</div>
- </td>
- </tr>
- <tr class="altColor" id="i2">
- <td class="colFirst"><code>float</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a
- href="../../../de/hems/trafficsim/Vehicle.html#getPosition--">getPosition</a></span>()</code>
- <div class="block">Getter for position</div>
- </td>
- </tr>
- <tr class="rowColor" id="i3">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a
- href="../../../de/hems/trafficsim/Vehicle.html#setBrakeProb-float-">setBrakeProb</a></span>(float brakeProb)</code>
- <div class="block">Setter for brakeProb</div>
- </td>
- </tr>
- <tr class="altColor" id="i4">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a
- href="../../../de/hems/trafficsim/Vehicle.html#setMaxVelocity-float-">setMaxVelocity</a></span>(float maxVelocity)</code>
- <div class="block">Setter for maxVelocity</div>
- </td>
- </tr>
- <tr class="rowColor" id="i5">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a
- href="../../../de/hems/trafficsim/Vehicle.html#timeElapse--">timeElapse</a></span>()</code>
- <div class="block">Updates the position of the vehicle according
- to it's previously calculated speed.
- </div>
- </td>
- </tr>
- <tr class="altColor" id="i6">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a
- href="../../../de/hems/trafficsim/Vehicle.html#updateVelocity-float-">updateVelocity</a></span>(float distanceForerunner)</code>
- <div class="block">Calculates the new velocity of the vehicle
- based on the following rules:
-
- Increase by one if the vehicle is slower than it's maximum
- speed
- Random brake by one
- Break if the distance to the forerunner is less than it's
- speed
- </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.Object</h3>
- <code>clone, equals, finalize, getClass, hashCode, notify,
- notifyAll, toString, wait, wait, wait</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="id">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>id</h4>
- <pre>protected int id</pre>
- <div class="block">a number to index the vehicle</div>
- </li>
- </ul>
- <a name="position">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>position</h4>
- <pre>protected float position</pre>
- <div class="block">current position of the vehicle on the track
- </div>
- </li>
- </ul>
- <a name="curVelocity">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>curVelocity</h4>
- <pre>protected float curVelocity</pre>
- <div class="block">current velocity of the vehicle</div>
- </li>
- </ul>
- <a name="maxVelocity">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>maxVelocity</h4>
- <pre>protected float maxVelocity</pre>
- <div class="block">maximum velocity of the vehicle</div>
- </li>
- </ul>
- <a name="brakeProb">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>brakeProb</h4>
- <pre>protected float brakeProb</pre>
- <div class="block">probability of the vehicle to brake without
- reason
- </div>
- </li>
- </ul>
- <a name="trackLength">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>trackLength</h4>
- <pre>protected float trackLength</pre>
- <div class="block">length of the track the vehicle is placed on
- </div>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="Vehicle-int-int-float-float-float-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>Vehicle</h4>
- <pre>public Vehicle(int id,
- int position,
- float maxVelocity,
- float brakeProb,
- float trackLength)</pre>
- <div class="block">Constructs a new vehicle.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>id</code> - a number to index the vehicle</dd>
- <dd><code>position</code> - current position of the vehicle on
- the track
- </dd>
- <dd><code>maxVelocity</code> - maximum velocity of the vehicle
- </dd>
- <dd><code>brakeProb</code> - probability of the vehicle to brake
- without reason
- </dd>
- <dd><code>trackLength</code> - length of the track the vehicle
- is placed on
- </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="getPosition--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getPosition</h4>
- <pre>public float getPosition()</pre>
- <div class="block">Getter for position</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>position</dd>
- </dl>
- </li>
- </ul>
- <a name="getCurVelocity--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCurVelocity</h4>
- <pre>public float getCurVelocity()</pre>
- <div class="block">Getter for curVelocity</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>curVelocity</dd>
- </dl>
- </li>
- </ul>
- <a name="getMaxVelocity--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getMaxVelocity</h4>
- <pre>public float getMaxVelocity()</pre>
- <div class="block">Getter for maxVelocity</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>maxVelocity</dd>
- </dl>
- </li>
- </ul>
- <a name="setBrakeProb-float-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setBrakeProb</h4>
- <pre>public void setBrakeProb(float brakeProb)</pre>
- <div class="block">Setter for brakeProb</div>
- </li>
- </ul>
- <a name="setMaxVelocity-float-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setMaxVelocity</h4>
- <pre>public void setMaxVelocity(float maxVelocity)</pre>
- <div class="block">Setter for maxVelocity</div>
- </li>
- </ul>
- <a name="updateVelocity-float-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>updateVelocity</h4>
- <pre>public void updateVelocity(float distanceForerunner)</pre>
- <div class="block">Calculates the new velocity of the vehicle based
- on the following rules:
- <ol>
- <li>Increase by one if the vehicle is slower than it's
- maximum speed
- </li>
- <li>Random brake by one</li>
- <li>Break if the distance to the forerunner is less than
- it's speed
- </li>
- </ol>
- </div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>distanceForerunner</code> - distance to the forerunner
- of the vehicle
- </dd>
- </dl>
- </li>
- </ul>
- <a name="timeElapse--">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>timeElapse</h4>
- <pre>public void timeElapse()</pre>
- <div class="block">Updates the position of the vehicle according to
- it's previously calculated speed.
- </div>
- </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="../../../de/hems/trafficsim/package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../de/hems/trafficsim/Track.html"
- title="class in de.hems.trafficsim"><span class="typeNameLink">Prev Class</span></a>
- </li>
- <li><a href="../../../de/hems/trafficsim/VehicleTimeRecord.html"
- title="class in de.hems.trafficsim"><span class="typeNameLink">Next Class</span></a>
- </li>
- </ul>
- <ul class="navList">
- <li><a href="../../../index.html?de/hems/trafficsim/Vehicle.html" target="_top">Frames</a>
- </li>
- <li><a href="Vehicle.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 ======= -->
- </body>
- </html>
|