You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1012 lines
54KB

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
  2. "http://www.w3.org/TR/html4/loose.dtd">
  3. <!-- NewPage -->
  4. <html lang="de">
  5. <head>
  6. <!-- Generated by javadoc (1.8.0_242-release) on Sun Nov 15 16:26:40 CET 2020 -->
  7. <title>Track</title>
  8. <meta content="2020-11-15" name="date">
  9. <link href="../../../stylesheet.css" rel="stylesheet" title="Style" type="text/css">
  10. <script src="../../../script.js" type="text/javascript"></script>
  11. </head>
  12. <body>
  13. <script type="text/javascript"><!--
  14. try {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="Track";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. 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,"i12":10,"i13":10,"i14":10,"i15":10};
  23. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  24. var altColor = "altColor";
  25. var rowColor = "rowColor";
  26. var tableTab = "tableTab";
  27. var activeTableTab = "activeTableTab";
  28. </script>
  29. <noscript>
  30. <div>JavaScript is disabled on your browser.</div>
  31. </noscript>
  32. <!-- ========= START OF TOP NAVBAR ======= -->
  33. <div class="topNav"><a name="navbar.top">
  34. <!-- -->
  35. </a>
  36. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation
  37. links</a></div>
  38. <a name="navbar.top.firstrow">
  39. <!-- -->
  40. </a>
  41. <ul class="navList" title="Navigation">
  42. <li><a href="../../../de/hems/trafficsim/package-summary.html">Package</a></li>
  43. <li class="navBarCell1Rev">Class</li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../index-files/index-1.html">Index</a></li>
  47. <li><a href="../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../de/hems/trafficsim/TimeRecordView.html"
  53. title="class in de.hems.trafficsim"><span class="typeNameLink">Prev&nbsp;Class</span></a>
  54. </li>
  55. <li><a href="../../../de/hems/trafficsim/Vehicle.html"
  56. title="class in de.hems.trafficsim"><span class="typeNameLink">Next&nbsp;Class</span></a>
  57. </li>
  58. </ul>
  59. <ul class="navList">
  60. <li><a href="../../../index.html?de/hems/trafficsim/Track.html" target="_top">Frames</a>
  61. </li>
  62. <li><a href="Track.html" target="_top">No&nbsp;Frames</a></li>
  63. </ul>
  64. <ul class="navList" id="allclasses_navbar_top">
  65. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  66. </ul>
  67. <div>
  68. <script type="text/javascript"><!--
  69. allClassesLink = document.getElementById("allclasses_navbar_top");
  70. if(window==top) {
  71. allClassesLink.style.display = "block";
  72. }
  73. else {
  74. allClassesLink.style.display = "none";
  75. }
  76. //-->
  77. </script>
  78. </div>
  79. <div>
  80. <ul class="subNavList">
  81. <li>Summary:&nbsp;</li>
  82. <li>Nested&nbsp;|&nbsp;</li>
  83. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  84. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  85. <li><a href="#method.summary">Method</a></li>
  86. </ul>
  87. <ul class="subNavList">
  88. <li>Detail:&nbsp;</li>
  89. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  90. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  91. <li><a href="#method.detail">Method</a></li>
  92. </ul>
  93. </div>
  94. <a name="skip.navbar.top">
  95. <!-- -->
  96. </a></div>
  97. <!-- ========= END OF TOP NAVBAR ========= -->
  98. <!-- ======== START OF CLASS DATA ======== -->
  99. <div class="header">
  100. <div class="subTitle">de.hems.trafficsim</div>
  101. <h2 class="title" title="Class Track">Class Track</h2>
  102. </div>
  103. <div class="contentContainer">
  104. <ul class="inheritance">
  105. <li>java.lang.Object</li>
  106. <li>
  107. <ul class="inheritance">
  108. <li>java.util.Observable</li>
  109. <li>
  110. <ul class="inheritance">
  111. <li>de.hems.trafficsim.Track</li>
  112. </ul>
  113. </li>
  114. </ul>
  115. </li>
  116. </ul>
  117. <div class="description">
  118. <ul class="blockList">
  119. <li class="blockList">
  120. <hr>
  121. <br>
  122. <pre>public class <span class="typeNameLabel">Track</span>
  123. extends java.util.Observable</pre>
  124. <div class="block">Main model class of TrafficSim. Represents a round course
  125. containing vehicles.
  126. </div>
  127. </li>
  128. </ul>
  129. </div>
  130. <div class="summary">
  131. <ul class="blockList">
  132. <li class="blockList">
  133. <!-- =========== FIELD SUMMARY =========== -->
  134. <ul class="blockList">
  135. <li class="blockList"><a name="field.summary">
  136. <!-- -->
  137. </a>
  138. <h3>Field Summary</h3>
  139. <table border="0" cellpadding="3" cellspacing="0" class="memberSummary"
  140. summary="Field Summary table, listing fields, and an explanation">
  141. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
  142. <tr>
  143. <th class="colFirst" scope="col">Modifier and Type</th>
  144. <th class="colLast" scope="col">Field and Description</th>
  145. </tr>
  146. <tr class="altColor">
  147. <td class="colFirst"><code>protected float</code></td>
  148. <td class="colLast"><code><span class="memberNameLink"><a
  149. href="../../../de/hems/trafficsim/Track.html#brakeProb">brakeProb</a></span></code>
  150. <div class="block">currently configured brake probability for
  151. all vehicles
  152. </div>
  153. </td>
  154. </tr>
  155. <tr class="rowColor">
  156. <td class="colFirst"><code>protected float</code></td>
  157. <td class="colLast"><code><span class="memberNameLink"><a
  158. href="../../../de/hems/trafficsim/Track.html#delayedAvg">delayedAvg</a></span></code>
  159. <div class="block">average over all velocities in the
  160. simulation, ignoring the first ten steps
  161. </div>
  162. </td>
  163. </tr>
  164. <tr class="altColor">
  165. <td class="colFirst"><code>protected int</code></td>
  166. <td class="colLast"><code><span class="memberNameLink"><a
  167. href="../../../de/hems/trafficsim/Track.html#historyLength">historyLength</a></span></code>
  168. <div class="block">length of the history kept</div>
  169. </td>
  170. </tr>
  171. <tr class="rowColor">
  172. <td class="colFirst"><code>protected float</code></td>
  173. <td class="colLast"><code><span class="memberNameLink"><a
  174. href="../../../de/hems/trafficsim/Track.html#lastAvg">lastAvg</a></span></code>
  175. <div class="block">average over all velocities in the last
  176. step
  177. </div>
  178. </td>
  179. </tr>
  180. <tr class="altColor">
  181. <td class="colFirst"><code>protected
  182. java.util.concurrent.Semaphore</code></td>
  183. <td class="colLast"><code><span class="memberNameLink"><a
  184. href="../../../de/hems/trafficsim/Track.html#listSemaphore">listSemaphore</a></span></code>
  185. <div class="block">semaphore protecting the vtrlist</div>
  186. </td>
  187. </tr>
  188. <tr class="rowColor">
  189. <td class="colFirst"><code>protected float</code></td>
  190. <td class="colLast"><code><span class="memberNameLink"><a
  191. href="../../../de/hems/trafficsim/Track.html#maxVelocity">maxVelocity</a></span></code>
  192. <div class="block">currently configured max velocity for all
  193. vehicles
  194. </div>
  195. </td>
  196. </tr>
  197. <tr class="altColor">
  198. <td class="colFirst"><code>protected float</code></td>
  199. <td class="colLast"><code><span class="memberNameLink"><a
  200. href="../../../de/hems/trafficsim/Track.html#overallAvg">overallAvg</a></span></code>
  201. <div class="block">average over all velocities in the
  202. simulation
  203. </div>
  204. </td>
  205. </tr>
  206. <tr class="rowColor">
  207. <td class="colFirst"><code>protected long</code></td>
  208. <td class="colLast"><code><span class="memberNameLink"><a
  209. href="../../../de/hems/trafficsim/Track.html#steps">steps</a></span></code>
  210. <div class="block">counter for executed simulation steps</div>
  211. </td>
  212. </tr>
  213. <tr class="altColor">
  214. <td class="colFirst"><code>protected float</code></td>
  215. <td class="colLast"><code><span class="memberNameLink"><a
  216. href="../../../de/hems/trafficsim/Track.html#sumAvgMemory">sumAvgMemory</a></span></code>
  217. <div class="block">sum of all vehicle speeds during the
  218. simulation, used for average calculation
  219. </div>
  220. </td>
  221. </tr>
  222. <tr class="rowColor">
  223. <td class="colFirst"><code>protected float</code></td>
  224. <td class="colLast"><code><span class="memberNameLink"><a
  225. href="../../../de/hems/trafficsim/Track.html#sumDelAvgMemory">sumDelAvgMemory</a></span></code>
  226. <div class="block">sum of all vehicle speeds during the
  227. simulation ignoring the first ten steps,
  228. used for average calculation
  229. </div>
  230. </td>
  231. </tr>
  232. <tr class="altColor">
  233. <td class="colFirst"><code>protected float</code></td>
  234. <td class="colLast"><code><span class="memberNameLink"><a
  235. href="../../../de/hems/trafficsim/Track.html#trackLength">trackLength</a></span></code>
  236. <div class="block">length of the track</div>
  237. </td>
  238. </tr>
  239. <tr class="rowColor">
  240. <td class="colFirst"><code>protected java.util.List&lt;<a
  241. href="../../../de/hems/trafficsim/Vehicle.html"
  242. title="class in de.hems.trafficsim">Vehicle</a>&gt;</code>
  243. </td>
  244. <td class="colLast"><code><span class="memberNameLink"><a
  245. href="../../../de/hems/trafficsim/Track.html#vehicles">vehicles</a></span></code>
  246. <div class="block">list a vehicles on the track</div>
  247. </td>
  248. </tr>
  249. <tr class="altColor">
  250. <td class="colFirst"><code>protected java.util.List&lt;java.util.List&lt;<a
  251. href="../../../de/hems/trafficsim/VehicleTimeRecord.html"
  252. title="class in de.hems.trafficsim">VehicleTimeRecord</a>&gt;&gt;</code>
  253. </td>
  254. <td class="colLast"><code><span class="memberNameLink"><a
  255. href="../../../de/hems/trafficsim/Track.html#vtrList">vtrList</a></span></code>
  256. <div class="block">list of resulting time records of the
  257. simulation
  258. </div>
  259. </td>
  260. </tr>
  261. <tr class="rowColor">
  262. <td class="colFirst"><code>protected int</code></td>
  263. <td class="colLast"><code><span class="memberNameLink"><a
  264. href="../../../de/hems/trafficsim/Track.html#waitTime">waitTime</a></span></code>
  265. <div class="block">current configured wait time between two
  266. simulation steps
  267. </div>
  268. </td>
  269. </tr>
  270. </table>
  271. </li>
  272. </ul>
  273. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  274. <ul class="blockList">
  275. <li class="blockList"><a name="constructor.summary">
  276. <!-- -->
  277. </a>
  278. <h3>Constructor Summary</h3>
  279. <table border="0" cellpadding="3" cellspacing="0" class="memberSummary"
  280. summary="Constructor Summary table, listing constructors, and an explanation">
  281. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span>
  282. </caption>
  283. <tr>
  284. <th class="colOne" scope="col">Constructor and Description</th>
  285. </tr>
  286. <tr class="altColor">
  287. <td class="colOne"><code><span class="memberNameLink"><a
  288. href="../../../de/hems/trafficsim/Track.html#Track-int-float-float-float-int-int-">Track</a></span>(int&nbsp;numberVehicles,
  289. float&nbsp;trackLength,
  290. float&nbsp;brakeProb,
  291. float&nbsp;maxVelocity,
  292. int&nbsp;waitTime,
  293. int&nbsp;historyLength)</code>
  294. <div class="block">Constructor for a new Track.</div>
  295. </td>
  296. </tr>
  297. </table>
  298. </li>
  299. </ul>
  300. <!-- ========== METHOD SUMMARY =========== -->
  301. <ul class="blockList">
  302. <li class="blockList"><a name="method.summary">
  303. <!-- -->
  304. </a>
  305. <h3>Method Summary</h3>
  306. <table border="0" cellpadding="3" cellspacing="0" class="memberSummary"
  307. summary="Method Summary table, listing methods, and an explanation">
  308. <caption><span class="activeTableTab"
  309. id="t0"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span
  310. class="tableTab" id="t2"><span><a href="javascript:show(2);">Instance Methods</a></span><span
  311. class="tabEnd">&nbsp;</span></span><span class="tableTab"
  312. id="t4"><span><a
  313. href="javascript:show(8);">Concrete Methods</a></span><span
  314. class="tabEnd">&nbsp;</span></span></caption>
  315. <tr>
  316. <th class="colFirst" scope="col">Modifier and Type</th>
  317. <th class="colLast" scope="col">Method and Description</th>
  318. </tr>
  319. <tr class="altColor" id="i0">
  320. <td class="colFirst"><code>float</code></td>
  321. <td class="colLast"><code><span class="memberNameLink"><a
  322. href="../../../de/hems/trafficsim/Track.html#avg_step-int-">avg_step</a></span>(int&nbsp;step)</code>
  323. <div class="block">Returns the average velocity of the given
  324. simulation step.
  325. </div>
  326. </td>
  327. </tr>
  328. <tr class="rowColor" id="i1">
  329. <td class="colFirst"><code>protected java.util.List&lt;<a
  330. href="../../../de/hems/trafficsim/Vehicle.html"
  331. title="class in de.hems.trafficsim">Vehicle</a>&gt;</code>
  332. </td>
  333. <td class="colLast"><code><span class="memberNameLink"><a
  334. href="../../../de/hems/trafficsim/Track.html#createVehiclesList-int-">createVehiclesList</a></span>(int&nbsp;numberVehicles)</code>
  335. <div class="block">Utility function to add vehicles to the
  336. Track.
  337. </div>
  338. </td>
  339. </tr>
  340. <tr class="altColor" id="i2">
  341. <td class="colFirst"><code>float</code></td>
  342. <td class="colLast"><code><span class="memberNameLink"><a
  343. href="../../../de/hems/trafficsim/Track.html#getDelayedAvg--">getDelayedAvg</a></span>()</code>
  344. <div class="block">Getter for delayedAvg</div>
  345. </td>
  346. </tr>
  347. <tr class="rowColor" id="i3">
  348. <td class="colFirst"><code>int</code></td>
  349. <td class="colLast"><code><span class="memberNameLink"><a
  350. href="../../../de/hems/trafficsim/Track.html#getHistoryLength--">getHistoryLength</a></span>()</code>
  351. <div class="block">Getter for historyLength</div>
  352. </td>
  353. </tr>
  354. <tr class="altColor" id="i4">
  355. <td class="colFirst"><code>float</code></td>
  356. <td class="colLast"><code><span class="memberNameLink"><a
  357. href="../../../de/hems/trafficsim/Track.html#getLastAvg--">getLastAvg</a></span>()</code>
  358. <div class="block">Getter for lastAvg</div>
  359. </td>
  360. </tr>
  361. <tr class="rowColor" id="i5">
  362. <td class="colFirst"><code>java.util.concurrent.Semaphore</code>
  363. </td>
  364. <td class="colLast"><code><span class="memberNameLink"><a
  365. href="../../../de/hems/trafficsim/Track.html#getListSemaphore--">getListSemaphore</a></span>()</code>
  366. <div class="block">Getter for listSemaphore</div>
  367. </td>
  368. </tr>
  369. <tr class="altColor" id="i6">
  370. <td class="colFirst"><code>float</code></td>
  371. <td class="colLast"><code><span class="memberNameLink"><a
  372. href="../../../de/hems/trafficsim/Track.html#getOverallAvg--">getOverallAvg</a></span>()</code>
  373. <div class="block">Getter for overallAvg</div>
  374. </td>
  375. </tr>
  376. <tr class="rowColor" id="i7">
  377. <td class="colFirst"><code>long</code></td>
  378. <td class="colLast"><code><span class="memberNameLink"><a
  379. href="../../../de/hems/trafficsim/Track.html#getSteps--">getSteps</a></span>()</code>
  380. <div class="block">Getter for steps</div>
  381. </td>
  382. </tr>
  383. <tr class="altColor" id="i8">
  384. <td class="colFirst"><code>float</code></td>
  385. <td class="colLast"><code><span class="memberNameLink"><a
  386. href="../../../de/hems/trafficsim/Track.html#getTrackLength--">getTrackLength</a></span>()</code>
  387. <div class="block">Getter for trackLength</div>
  388. </td>
  389. </tr>
  390. <tr class="rowColor" id="i9">
  391. <td class="colFirst"><code>java.util.List&lt;<a
  392. href="../../../de/hems/trafficsim/Vehicle.html"
  393. title="class in de.hems.trafficsim">Vehicle</a>&gt;</code>
  394. </td>
  395. <td class="colLast"><code><span class="memberNameLink"><a
  396. href="../../../de/hems/trafficsim/Track.html#getVehicles--">getVehicles</a></span>()</code>
  397. <div class="block">Getter for vehicles</div>
  398. </td>
  399. </tr>
  400. <tr class="altColor" id="i10">
  401. <td class="colFirst"><code>java.util.List&lt;java.util.List&lt;<a
  402. href="../../../de/hems/trafficsim/VehicleTimeRecord.html"
  403. title="class in de.hems.trafficsim">VehicleTimeRecord</a>&gt;&gt;</code>
  404. </td>
  405. <td class="colLast"><code><span class="memberNameLink"><a
  406. href="../../../de/hems/trafficsim/Track.html#getVtrList--">getVtrList</a></span>()</code>
  407. <div class="block">Getter for vtrList</div>
  408. </td>
  409. </tr>
  410. <tr class="rowColor" id="i11">
  411. <td class="colFirst"><code>void</code></td>
  412. <td class="colLast"><code><span class="memberNameLink"><a
  413. href="../../../de/hems/trafficsim/Track.html#setBrakeProb-float-">setBrakeProb</a></span>(float&nbsp;brakeProb)</code>
  414. <div class="block">Update the brake probability of all
  415. vehicles.
  416. </div>
  417. </td>
  418. </tr>
  419. <tr class="altColor" id="i12">
  420. <td class="colFirst"><code>void</code></td>
  421. <td class="colLast"><code><span class="memberNameLink"><a
  422. href="../../../de/hems/trafficsim/Track.html#setMaxVelocity-float-">setMaxVelocity</a></span>(float&nbsp;maxVelocity)</code>
  423. <div class="block">Update the maximum velocity of all
  424. vehicles.
  425. </div>
  426. </td>
  427. </tr>
  428. <tr class="rowColor" id="i13">
  429. <td class="colFirst"><code>void</code></td>
  430. <td class="colLast"><code><span class="memberNameLink"><a
  431. href="../../../de/hems/trafficsim/Track.html#setWaitTime-int-">setWaitTime</a></span>(int&nbsp;waitTime)</code>
  432. <div class="block">Update the wait time of the simulation.</div>
  433. </td>
  434. </tr>
  435. <tr class="altColor" id="i14">
  436. <td class="colFirst"><code>void</code></td>
  437. <td class="colLast"><code><span class="memberNameLink"><a
  438. href="../../../de/hems/trafficsim/Track.html#timeElapse--">timeElapse</a></span>()</code>
  439. <div class="block">Calculates on simulation step ahead and then
  440. waits for the configured wait time.
  441. </div>
  442. </td>
  443. </tr>
  444. <tr class="rowColor" id="i15">
  445. <td class="colFirst"><code>protected void</code></td>
  446. <td class="colLast"><code><span class="memberNameLink"><a
  447. href="../../../de/hems/trafficsim/Track.html#update_avg--">update_avg</a></span>()</code>
  448. <div class="block">Utility function which updates the averages
  449. values with the results from the last simulation
  450. step.
  451. </div>
  452. </td>
  453. </tr>
  454. </table>
  455. <ul class="blockList">
  456. <li class="blockList"><a
  457. name="methods.inherited.from.class.java.util.Observable">
  458. <!-- -->
  459. </a>
  460. <h3>Methods inherited from class&nbsp;java.util.Observable</h3>
  461. <code>addObserver, clearChanged, countObservers, deleteObserver,
  462. deleteObservers, hasChanged, notifyObservers, notifyObservers,
  463. setChanged</code></li>
  464. </ul>
  465. <ul class="blockList">
  466. <li class="blockList"><a
  467. name="methods.inherited.from.class.java.lang.Object">
  468. <!-- -->
  469. </a>
  470. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  471. <code>clone, equals, finalize, getClass, hashCode, notify,
  472. notifyAll, toString, wait, wait, wait</code></li>
  473. </ul>
  474. </li>
  475. </ul>
  476. </li>
  477. </ul>
  478. </div>
  479. <div class="details">
  480. <ul class="blockList">
  481. <li class="blockList">
  482. <!-- ============ FIELD DETAIL =========== -->
  483. <ul class="blockList">
  484. <li class="blockList"><a name="field.detail">
  485. <!-- -->
  486. </a>
  487. <h3>Field Detail</h3>
  488. <a name="vehicles">
  489. <!-- -->
  490. </a>
  491. <ul class="blockList">
  492. <li class="blockList">
  493. <h4>vehicles</h4>
  494. <pre>protected&nbsp;java.util.List&lt;<a
  495. href="../../../de/hems/trafficsim/Vehicle.html"
  496. title="class in de.hems.trafficsim">Vehicle</a>&gt; vehicles</pre>
  497. <div class="block">list a vehicles on the track</div>
  498. </li>
  499. </ul>
  500. <a name="vtrList">
  501. <!-- -->
  502. </a>
  503. <ul class="blockList">
  504. <li class="blockList">
  505. <h4>vtrList</h4>
  506. <pre>protected&nbsp;java.util.List&lt;java.util.List&lt;<a
  507. href="../../../de/hems/trafficsim/VehicleTimeRecord.html"
  508. title="class in de.hems.trafficsim">VehicleTimeRecord</a>&gt;&gt; vtrList</pre>
  509. <div class="block">list of resulting time records of the
  510. simulation
  511. </div>
  512. </li>
  513. </ul>
  514. <a name="trackLength">
  515. <!-- -->
  516. </a>
  517. <ul class="blockList">
  518. <li class="blockList">
  519. <h4>trackLength</h4>
  520. <pre>protected&nbsp;float trackLength</pre>
  521. <div class="block">length of the track</div>
  522. </li>
  523. </ul>
  524. <a name="sumAvgMemory">
  525. <!-- -->
  526. </a>
  527. <ul class="blockList">
  528. <li class="blockList">
  529. <h4>sumAvgMemory</h4>
  530. <pre>protected&nbsp;float sumAvgMemory</pre>
  531. <div class="block">sum of all vehicle speeds during the simulation,
  532. used for average calculation
  533. </div>
  534. </li>
  535. </ul>
  536. <a name="sumDelAvgMemory">
  537. <!-- -->
  538. </a>
  539. <ul class="blockList">
  540. <li class="blockList">
  541. <h4>sumDelAvgMemory</h4>
  542. <pre>protected&nbsp;float sumDelAvgMemory</pre>
  543. <div class="block">sum of all vehicle speeds during the simulation
  544. ignoring the first ten steps,
  545. used for average calculation
  546. </div>
  547. </li>
  548. </ul>
  549. <a name="historyLength">
  550. <!-- -->
  551. </a>
  552. <ul class="blockList">
  553. <li class="blockList">
  554. <h4>historyLength</h4>
  555. <pre>protected&nbsp;int historyLength</pre>
  556. <div class="block">length of the history kept</div>
  557. </li>
  558. </ul>
  559. <a name="overallAvg">
  560. <!-- -->
  561. </a>
  562. <ul class="blockList">
  563. <li class="blockList">
  564. <h4>overallAvg</h4>
  565. <pre>protected&nbsp;float overallAvg</pre>
  566. <div class="block">average over all velocities in the simulation
  567. </div>
  568. </li>
  569. </ul>
  570. <a name="delayedAvg">
  571. <!-- -->
  572. </a>
  573. <ul class="blockList">
  574. <li class="blockList">
  575. <h4>delayedAvg</h4>
  576. <pre>protected&nbsp;float delayedAvg</pre>
  577. <div class="block">average over all velocities in the simulation,
  578. ignoring the first ten steps
  579. </div>
  580. </li>
  581. </ul>
  582. <a name="lastAvg">
  583. <!-- -->
  584. </a>
  585. <ul class="blockList">
  586. <li class="blockList">
  587. <h4>lastAvg</h4>
  588. <pre>protected&nbsp;float lastAvg</pre>
  589. <div class="block">average over all velocities in the last step
  590. </div>
  591. </li>
  592. </ul>
  593. <a name="waitTime">
  594. <!-- -->
  595. </a>
  596. <ul class="blockList">
  597. <li class="blockList">
  598. <h4>waitTime</h4>
  599. <pre>protected&nbsp;int waitTime</pre>
  600. <div class="block">current configured wait time between two
  601. simulation steps
  602. </div>
  603. </li>
  604. </ul>
  605. <a name="maxVelocity">
  606. <!-- -->
  607. </a>
  608. <ul class="blockList">
  609. <li class="blockList">
  610. <h4>maxVelocity</h4>
  611. <pre>protected&nbsp;float maxVelocity</pre>
  612. <div class="block">currently configured max velocity for all
  613. vehicles
  614. </div>
  615. </li>
  616. </ul>
  617. <a name="brakeProb">
  618. <!-- -->
  619. </a>
  620. <ul class="blockList">
  621. <li class="blockList">
  622. <h4>brakeProb</h4>
  623. <pre>protected&nbsp;float brakeProb</pre>
  624. <div class="block">currently configured brake probability for all
  625. vehicles
  626. </div>
  627. </li>
  628. </ul>
  629. <a name="steps">
  630. <!-- -->
  631. </a>
  632. <ul class="blockList">
  633. <li class="blockList">
  634. <h4>steps</h4>
  635. <pre>protected&nbsp;long steps</pre>
  636. <div class="block">counter for executed simulation steps</div>
  637. </li>
  638. </ul>
  639. <a name="listSemaphore">
  640. <!-- -->
  641. </a>
  642. <ul class="blockListLast">
  643. <li class="blockList">
  644. <h4>listSemaphore</h4>
  645. <pre>protected&nbsp;java.util.concurrent.Semaphore listSemaphore</pre>
  646. <div class="block">semaphore protecting the vtrlist</div>
  647. </li>
  648. </ul>
  649. </li>
  650. </ul>
  651. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  652. <ul class="blockList">
  653. <li class="blockList"><a name="constructor.detail">
  654. <!-- -->
  655. </a>
  656. <h3>Constructor Detail</h3>
  657. <a name="Track-int-float-float-float-int-int-">
  658. <!-- -->
  659. </a>
  660. <ul class="blockListLast">
  661. <li class="blockList">
  662. <h4>Track</h4>
  663. <pre>public&nbsp;Track(int&nbsp;numberVehicles,
  664. float&nbsp;trackLength,
  665. float&nbsp;brakeProb,
  666. float&nbsp;maxVelocity,
  667. int&nbsp;waitTime,
  668. int&nbsp;historyLength)</pre>
  669. <div class="block">Constructor for a new Track.</div>
  670. <dl>
  671. <dt><span class="paramLabel">Parameters:</span></dt>
  672. <dd><code>numberVehicles</code> - number of vehicles on the
  673. Track
  674. </dd>
  675. <dd><code>trackLength</code> - length of the new Track</dd>
  676. <dd><code>brakeProb</code> - probability of a vehicle to
  677. suddenly brake without reason
  678. </dd>
  679. <dd><code>maxVelocity</code> - maxmimum velocity of the vehicles
  680. </dd>
  681. <dd><code>waitTime</code> - time between two simulation steps to
  682. slow down the simulation artificially
  683. </dd>
  684. <dd><code>historyLength</code> - length of the history to keep
  685. </dd>
  686. </dl>
  687. </li>
  688. </ul>
  689. </li>
  690. </ul>
  691. <!-- ============ METHOD DETAIL ========== -->
  692. <ul class="blockList">
  693. <li class="blockList"><a name="method.detail">
  694. <!-- -->
  695. </a>
  696. <h3>Method Detail</h3>
  697. <a name="getVtrList--">
  698. <!-- -->
  699. </a>
  700. <ul class="blockList">
  701. <li class="blockList">
  702. <h4>getVtrList</h4>
  703. <pre>public&nbsp;java.util.List&lt;java.util.List&lt;<a
  704. href="../../../de/hems/trafficsim/VehicleTimeRecord.html"
  705. title="class in de.hems.trafficsim">VehicleTimeRecord</a>&gt;&gt;&nbsp;getVtrList()</pre>
  706. <div class="block">Getter for vtrList</div>
  707. <dl>
  708. <dt><span class="returnLabel">Returns:</span></dt>
  709. <dd>vtrList</dd>
  710. </dl>
  711. </li>
  712. </ul>
  713. <a name="getOverallAvg--">
  714. <!-- -->
  715. </a>
  716. <ul class="blockList">
  717. <li class="blockList">
  718. <h4>getOverallAvg</h4>
  719. <pre>public&nbsp;float&nbsp;getOverallAvg()</pre>
  720. <div class="block">Getter for overallAvg</div>
  721. <dl>
  722. <dt><span class="returnLabel">Returns:</span></dt>
  723. <dd>overallAvg</dd>
  724. </dl>
  725. </li>
  726. </ul>
  727. <a name="getLastAvg--">
  728. <!-- -->
  729. </a>
  730. <ul class="blockList">
  731. <li class="blockList">
  732. <h4>getLastAvg</h4>
  733. <pre>public&nbsp;float&nbsp;getLastAvg()</pre>
  734. <div class="block">Getter for lastAvg</div>
  735. <dl>
  736. <dt><span class="returnLabel">Returns:</span></dt>
  737. <dd>lastAvg</dd>
  738. </dl>
  739. </li>
  740. </ul>
  741. <a name="getDelayedAvg--">
  742. <!-- -->
  743. </a>
  744. <ul class="blockList">
  745. <li class="blockList">
  746. <h4>getDelayedAvg</h4>
  747. <pre>public&nbsp;float&nbsp;getDelayedAvg()</pre>
  748. <div class="block">Getter for delayedAvg</div>
  749. <dl>
  750. <dt><span class="returnLabel">Returns:</span></dt>
  751. <dd>delayedAvg</dd>
  752. </dl>
  753. </li>
  754. </ul>
  755. <a name="getVehicles--">
  756. <!-- -->
  757. </a>
  758. <ul class="blockList">
  759. <li class="blockList">
  760. <h4>getVehicles</h4>
  761. <pre>public&nbsp;java.util.List&lt;<a
  762. href="../../../de/hems/trafficsim/Vehicle.html"
  763. title="class in de.hems.trafficsim">Vehicle</a>&gt;&nbsp;getVehicles()</pre>
  764. <div class="block">Getter for vehicles</div>
  765. <dl>
  766. <dt><span class="returnLabel">Returns:</span></dt>
  767. <dd>vehicles</dd>
  768. </dl>
  769. </li>
  770. </ul>
  771. <a name="getTrackLength--">
  772. <!-- -->
  773. </a>
  774. <ul class="blockList">
  775. <li class="blockList">
  776. <h4>getTrackLength</h4>
  777. <pre>public&nbsp;float&nbsp;getTrackLength()</pre>
  778. <div class="block">Getter for trackLength</div>
  779. <dl>
  780. <dt><span class="returnLabel">Returns:</span></dt>
  781. <dd>trackLength</dd>
  782. </dl>
  783. </li>
  784. </ul>
  785. <a name="getSteps--">
  786. <!-- -->
  787. </a>
  788. <ul class="blockList">
  789. <li class="blockList">
  790. <h4>getSteps</h4>
  791. <pre>public&nbsp;long&nbsp;getSteps()</pre>
  792. <div class="block">Getter for steps</div>
  793. <dl>
  794. <dt><span class="returnLabel">Returns:</span></dt>
  795. <dd>steps</dd>
  796. </dl>
  797. </li>
  798. </ul>
  799. <a name="getListSemaphore--">
  800. <!-- -->
  801. </a>
  802. <ul class="blockList">
  803. <li class="blockList">
  804. <h4>getListSemaphore</h4>
  805. <pre>public&nbsp;java.util.concurrent.Semaphore&nbsp;getListSemaphore()</pre>
  806. <div class="block">Getter for listSemaphore</div>
  807. <dl>
  808. <dt><span class="returnLabel">Returns:</span></dt>
  809. <dd>listSemaphore</dd>
  810. </dl>
  811. </li>
  812. </ul>
  813. <a name="getHistoryLength--">
  814. <!-- -->
  815. </a>
  816. <ul class="blockList">
  817. <li class="blockList">
  818. <h4>getHistoryLength</h4>
  819. <pre>public&nbsp;int&nbsp;getHistoryLength()</pre>
  820. <div class="block">Getter for historyLength</div>
  821. <dl>
  822. <dt><span class="returnLabel">Returns:</span></dt>
  823. <dd>historyLength</dd>
  824. </dl>
  825. </li>
  826. </ul>
  827. <a name="createVehiclesList-int-">
  828. <!-- -->
  829. </a>
  830. <ul class="blockList">
  831. <li class="blockList">
  832. <h4>createVehiclesList</h4>
  833. <pre>protected&nbsp;java.util.List&lt;<a
  834. href="../../../de/hems/trafficsim/Vehicle.html"
  835. title="class in de.hems.trafficsim">Vehicle</a>&gt;&nbsp;createVehiclesList(int&nbsp;numberVehicles)</pre>
  836. <div class="block">Utility function to add vehicles to the Track.
  837. </div>
  838. <dl>
  839. <dt><span class="paramLabel">Parameters:</span></dt>
  840. <dd><code>numberVehicles</code> - number of vehicles to add</dd>
  841. <dt><span class="returnLabel">Returns:</span></dt>
  842. <dd>filled list with vehicles</dd>
  843. </dl>
  844. </li>
  845. </ul>
  846. <a name="setWaitTime-int-">
  847. <!-- -->
  848. </a>
  849. <ul class="blockList">
  850. <li class="blockList">
  851. <h4>setWaitTime</h4>
  852. <pre>public&nbsp;void&nbsp;setWaitTime(int&nbsp;waitTime)</pre>
  853. <div class="block">Update the wait time of the simulation.</div>
  854. <dl>
  855. <dt><span class="paramLabel">Parameters:</span></dt>
  856. <dd><code>waitTime</code> - new wait time in ms</dd>
  857. </dl>
  858. </li>
  859. </ul>
  860. <a name="setBrakeProb-float-">
  861. <!-- -->
  862. </a>
  863. <ul class="blockList">
  864. <li class="blockList">
  865. <h4>setBrakeProb</h4>
  866. <pre>public&nbsp;void&nbsp;setBrakeProb(float&nbsp;brakeProb)</pre>
  867. <div class="block">Update the brake probability of all vehicles.
  868. </div>
  869. <dl>
  870. <dt><span class="paramLabel">Parameters:</span></dt>
  871. <dd><code>brakeProb</code> - new brake probability</dd>
  872. </dl>
  873. </li>
  874. </ul>
  875. <a name="setMaxVelocity-float-">
  876. <!-- -->
  877. </a>
  878. <ul class="blockList">
  879. <li class="blockList">
  880. <h4>setMaxVelocity</h4>
  881. <pre>public&nbsp;void&nbsp;setMaxVelocity(float&nbsp;maxVelocity)</pre>
  882. <div class="block">Update the maximum velocity of all vehicles.
  883. </div>
  884. <dl>
  885. <dt><span class="paramLabel">Parameters:</span></dt>
  886. <dd><code>maxVelocity</code> - new maximum velocity</dd>
  887. </dl>
  888. </li>
  889. </ul>
  890. <a name="timeElapse--">
  891. <!-- -->
  892. </a>
  893. <ul class="blockList">
  894. <li class="blockList">
  895. <h4>timeElapse</h4>
  896. <pre>public&nbsp;void&nbsp;timeElapse()</pre>
  897. <div class="block">Calculates on simulation step ahead and then
  898. waits for the configured wait time.
  899. </div>
  900. </li>
  901. </ul>
  902. <a name="avg_step-int-">
  903. <!-- -->
  904. </a>
  905. <ul class="blockList">
  906. <li class="blockList">
  907. <h4>avg_step</h4>
  908. <pre>public&nbsp;float&nbsp;avg_step(int&nbsp;step)</pre>
  909. <div class="block">Returns the average velocity of the given
  910. simulation step.
  911. </div>
  912. <dl>
  913. <dt><span class="paramLabel">Parameters:</span></dt>
  914. <dd><code>step</code> - index of the step in the history list
  915. </dd>
  916. <dt><span class="returnLabel">Returns:</span></dt>
  917. <dd>average velocity</dd>
  918. </dl>
  919. </li>
  920. </ul>
  921. <a name="update_avg--">
  922. <!-- -->
  923. </a>
  924. <ul class="blockListLast">
  925. <li class="blockList">
  926. <h4>update_avg</h4>
  927. <pre>protected&nbsp;void&nbsp;update_avg()</pre>
  928. <div class="block">Utility function which updates the averages
  929. values with the results from the last simulation
  930. step.
  931. </div>
  932. </li>
  933. </ul>
  934. </li>
  935. </ul>
  936. </li>
  937. </ul>
  938. </div>
  939. </div>
  940. <!-- ========= END OF CLASS DATA ========= -->
  941. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  942. <div class="bottomNav"><a name="navbar.bottom">
  943. <!-- -->
  944. </a>
  945. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation
  946. links</a></div>
  947. <a name="navbar.bottom.firstrow">
  948. <!-- -->
  949. </a>
  950. <ul class="navList" title="Navigation">
  951. <li><a href="../../../de/hems/trafficsim/package-summary.html">Package</a></li>
  952. <li class="navBarCell1Rev">Class</li>
  953. <li><a href="package-tree.html">Tree</a></li>
  954. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  955. <li><a href="../../../index-files/index-1.html">Index</a></li>
  956. <li><a href="../../../help-doc.html">Help</a></li>
  957. </ul>
  958. </div>
  959. <div class="subNav">
  960. <ul class="navList">
  961. <li><a href="../../../de/hems/trafficsim/TimeRecordView.html"
  962. title="class in de.hems.trafficsim"><span class="typeNameLink">Prev&nbsp;Class</span></a>
  963. </li>
  964. <li><a href="../../../de/hems/trafficsim/Vehicle.html"
  965. title="class in de.hems.trafficsim"><span class="typeNameLink">Next&nbsp;Class</span></a>
  966. </li>
  967. </ul>
  968. <ul class="navList">
  969. <li><a href="../../../index.html?de/hems/trafficsim/Track.html" target="_top">Frames</a>
  970. </li>
  971. <li><a href="Track.html" target="_top">No&nbsp;Frames</a></li>
  972. </ul>
  973. <ul class="navList" id="allclasses_navbar_bottom">
  974. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  975. </ul>
  976. <div>
  977. <script type="text/javascript"><!--
  978. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  979. if(window==top) {
  980. allClassesLink.style.display = "block";
  981. }
  982. else {
  983. allClassesLink.style.display = "none";
  984. }
  985. //-->
  986. </script>
  987. </div>
  988. <div>
  989. <ul class="subNavList">
  990. <li>Summary:&nbsp;</li>
  991. <li>Nested&nbsp;|&nbsp;</li>
  992. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  993. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  994. <li><a href="#method.summary">Method</a></li>
  995. </ul>
  996. <ul class="subNavList">
  997. <li>Detail:&nbsp;</li>
  998. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  999. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  1000. <li><a href="#method.detail">Method</a></li>
  1001. </ul>
  1002. </div>
  1003. <a name="skip.navbar.bottom">
  1004. <!-- -->
  1005. </a></div>
  1006. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  1007. </body>
  1008. </html>