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.

569 lines
29KB

  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>Worker</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="Worker";
  17. }
  18. }
  19. catch(err) {
  20. }
  21. //-->
  22. var methods = {"i0":10,"i1":10,"i2":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/VehicleTimeRecord.html"
  53. title="class in de.hems.trafficsim"><span class="typeNameLink">Prev&nbsp;Class</span></a>
  54. </li>
  55. <li>Next&nbsp;Class</li>
  56. </ul>
  57. <ul class="navList">
  58. <li><a href="../../../index.html?de/hems/trafficsim/Worker.html" target="_top">Frames</a>
  59. </li>
  60. <li><a href="Worker.html" target="_top">No&nbsp;Frames</a></li>
  61. </ul>
  62. <ul class="navList" id="allclasses_navbar_top">
  63. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  64. </ul>
  65. <div>
  66. <script type="text/javascript"><!--
  67. allClassesLink = document.getElementById("allclasses_navbar_top");
  68. if(window==top) {
  69. allClassesLink.style.display = "block";
  70. }
  71. else {
  72. allClassesLink.style.display = "none";
  73. }
  74. //-->
  75. </script>
  76. </div>
  77. <div>
  78. <ul class="subNavList">
  79. <li>Summary:&nbsp;</li>
  80. <li><a href="#nested.classes.inherited.from.class.java.lang.Thread">Nested</a>&nbsp;|&nbsp;
  81. </li>
  82. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  83. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  84. <li><a href="#method.summary">Method</a></li>
  85. </ul>
  86. <ul class="subNavList">
  87. <li>Detail:&nbsp;</li>
  88. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  89. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  90. <li><a href="#method.detail">Method</a></li>
  91. </ul>
  92. </div>
  93. <a name="skip.navbar.top">
  94. <!-- -->
  95. </a></div>
  96. <!-- ========= END OF TOP NAVBAR ========= -->
  97. <!-- ======== START OF CLASS DATA ======== -->
  98. <div class="header">
  99. <div class="subTitle">de.hems.trafficsim</div>
  100. <h2 class="title" title="Class Worker">Class Worker</h2>
  101. </div>
  102. <div class="contentContainer">
  103. <ul class="inheritance">
  104. <li>java.lang.Object</li>
  105. <li>
  106. <ul class="inheritance">
  107. <li>java.lang.Thread</li>
  108. <li>
  109. <ul class="inheritance">
  110. <li>de.hems.trafficsim.Worker</li>
  111. </ul>
  112. </li>
  113. </ul>
  114. </li>
  115. </ul>
  116. <div class="description">
  117. <ul class="blockList">
  118. <li class="blockList">
  119. <dl>
  120. <dt>All Implemented Interfaces:</dt>
  121. <dd>java.lang.Runnable</dd>
  122. </dl>
  123. <hr>
  124. <br>
  125. <pre>public class <span class="typeNameLabel">Worker</span>
  126. extends java.lang.Thread</pre>
  127. <div class="block">Calculation thread, which runs the simulation itself and also
  128. updates the view with a set rate.
  129. </div>
  130. </li>
  131. </ul>
  132. </div>
  133. <div class="summary">
  134. <ul class="blockList">
  135. <li class="blockList">
  136. <!-- ======== NESTED CLASS SUMMARY ======== -->
  137. <ul class="blockList">
  138. <li class="blockList"><a name="nested.class.summary">
  139. <!-- -->
  140. </a>
  141. <h3>Nested Class Summary</h3>
  142. <ul class="blockList">
  143. <li class="blockList"><a
  144. name="nested.classes.inherited.from.class.java.lang.Thread">
  145. <!-- -->
  146. </a>
  147. <h3>Nested classes/interfaces inherited from class&nbsp;java.lang.Thread</h3>
  148. <code>java.lang.Thread.State,
  149. java.lang.Thread.UncaughtExceptionHandler</code></li>
  150. </ul>
  151. </li>
  152. </ul>
  153. <!-- =========== FIELD SUMMARY =========== -->
  154. <ul class="blockList">
  155. <li class="blockList"><a name="field.summary">
  156. <!-- -->
  157. </a>
  158. <h3>Field Summary</h3>
  159. <table border="0" cellpadding="3" cellspacing="0" class="memberSummary"
  160. summary="Field Summary table, listing fields, and an explanation">
  161. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
  162. <tr>
  163. <th class="colFirst" scope="col">Modifier and Type</th>
  164. <th class="colLast" scope="col">Field and Description</th>
  165. </tr>
  166. <tr class="altColor">
  167. <td class="colFirst"><code>protected int</code></td>
  168. <td class="colLast"><code><span class="memberNameLink"><a
  169. href="../../../de/hems/trafficsim/Worker.html#frameskip">frameskip</a></span></code>
  170. <div class="block">Amount of simulation steps between two frames
  171. in the view.
  172. </div>
  173. </td>
  174. </tr>
  175. <tr class="rowColor">
  176. <td class="colFirst"><code>protected <a
  177. href="../../../de/hems/trafficsim/MainActivity.html"
  178. title="class in de.hems.trafficsim">MainActivity</a></code>
  179. </td>
  180. <td class="colLast"><code><span class="memberNameLink"><a
  181. href="../../../de/hems/trafficsim/Worker.html#gui">gui</a></span></code>
  182. <div class="block">the MainActivity of the gui</div>
  183. </td>
  184. </tr>
  185. <tr class="altColor">
  186. <td class="colFirst"><code>protected <a
  187. href="../../../de/hems/trafficsim/Renderer.html"
  188. title="class in de.hems.trafficsim">Renderer</a></code></td>
  189. <td class="colLast"><code><span class="memberNameLink"><a
  190. href="../../../de/hems/trafficsim/Worker.html#renderer">renderer</a></span></code>
  191. <div class="block">the Renderer drawing the Track</div>
  192. </td>
  193. </tr>
  194. <tr class="rowColor">
  195. <td class="colFirst"><code>protected boolean</code></td>
  196. <td class="colLast"><code><span class="memberNameLink"><a
  197. href="../../../de/hems/trafficsim/Worker.html#stop">stop</a></span></code>
  198. <div class="block">Stop flag, indicating that the worker shall
  199. stop
  200. </div>
  201. </td>
  202. </tr>
  203. <tr class="altColor">
  204. <td class="colFirst"><code>protected <a
  205. href="../../../de/hems/trafficsim/Track.html"
  206. title="class in de.hems.trafficsim">Track</a></code></td>
  207. <td class="colLast"><code><span class="memberNameLink"><a
  208. href="../../../de/hems/trafficsim/Worker.html#track">track</a></span></code>
  209. <div class="block">the track to simulate</div>
  210. </td>
  211. </tr>
  212. </table>
  213. <ul class="blockList">
  214. <li class="blockList"><a
  215. name="fields.inherited.from.class.java.lang.Thread">
  216. <!-- -->
  217. </a>
  218. <h3>Fields inherited from class&nbsp;java.lang.Thread</h3>
  219. <code>MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY</code></li>
  220. </ul>
  221. </li>
  222. </ul>
  223. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  224. <ul class="blockList">
  225. <li class="blockList"><a name="constructor.summary">
  226. <!-- -->
  227. </a>
  228. <h3>Constructor Summary</h3>
  229. <table border="0" cellpadding="3" cellspacing="0" class="memberSummary"
  230. summary="Constructor Summary table, listing constructors, and an explanation">
  231. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span>
  232. </caption>
  233. <tr>
  234. <th class="colOne" scope="col">Constructor and Description</th>
  235. </tr>
  236. <tr class="altColor">
  237. <td class="colOne"><code><span class="memberNameLink"><a
  238. href="../../../de/hems/trafficsim/Worker.html#Worker-de.hems.trafficsim.Track-de.hems.trafficsim.MainActivity-de.hems.trafficsim.Renderer-int-">Worker</a></span>(<a
  239. href="../../../de/hems/trafficsim/Track.html"
  240. title="class in de.hems.trafficsim">Track</a>&nbsp;track,
  241. <a href="../../../de/hems/trafficsim/MainActivity.html"
  242. title="class in de.hems.trafficsim">MainActivity</a>&nbsp;gui,
  243. <a href="../../../de/hems/trafficsim/Renderer.html"
  244. title="class in de.hems.trafficsim">Renderer</a>&nbsp;renderer,
  245. int&nbsp;frameskip)</code>
  246. <div class="block">Construct a new worker.</div>
  247. </td>
  248. </tr>
  249. </table>
  250. </li>
  251. </ul>
  252. <!-- ========== METHOD SUMMARY =========== -->
  253. <ul class="blockList">
  254. <li class="blockList"><a name="method.summary">
  255. <!-- -->
  256. </a>
  257. <h3>Method Summary</h3>
  258. <table border="0" cellpadding="3" cellspacing="0" class="memberSummary"
  259. summary="Method Summary table, listing methods, and an explanation">
  260. <caption><span class="activeTableTab"
  261. id="t0"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span
  262. class="tableTab" id="t2"><span><a href="javascript:show(2);">Instance Methods</a></span><span
  263. class="tabEnd">&nbsp;</span></span><span class="tableTab"
  264. id="t4"><span><a
  265. href="javascript:show(8);">Concrete Methods</a></span><span
  266. class="tabEnd">&nbsp;</span></span></caption>
  267. <tr>
  268. <th class="colFirst" scope="col">Modifier and Type</th>
  269. <th class="colLast" scope="col">Method and Description</th>
  270. </tr>
  271. <tr class="altColor" id="i0">
  272. <td class="colFirst"><code>void</code></td>
  273. <td class="colLast"><code><span class="memberNameLink"><a
  274. href="../../../de/hems/trafficsim/Worker.html#run--">run</a></span>()</code>
  275. <div class="block">Method which is automatically executed when
  276. the thread is started.
  277. </div>
  278. </td>
  279. </tr>
  280. <tr class="rowColor" id="i1">
  281. <td class="colFirst"><code>void</code></td>
  282. <td class="colLast"><code><span class="memberNameLink"><a
  283. href="../../../de/hems/trafficsim/Worker.html#setFrameskip-int-">setFrameskip</a></span>(int&nbsp;frames)</code>
  284. <div class="block">Updates the amount of simulation steps
  285. between to view frames.
  286. </div>
  287. </td>
  288. </tr>
  289. <tr class="altColor" id="i2">
  290. <td class="colFirst"><code>void</code></td>
  291. <td class="colLast"><code><span class="memberNameLink"><a
  292. href="../../../de/hems/trafficsim/Worker.html#setStop-boolean-">setStop</a></span>(boolean&nbsp;stop)</code>
  293. <div class="block">Sets a flag that causes the worker to stop.
  294. </div>
  295. </td>
  296. </tr>
  297. </table>
  298. <ul class="blockList">
  299. <li class="blockList"><a
  300. name="methods.inherited.from.class.java.lang.Thread">
  301. <!-- -->
  302. </a>
  303. <h3>Methods inherited from class&nbsp;java.lang.Thread</h3>
  304. <code>activeCount, checkAccess, clone, countStackFrames,
  305. currentThread, destroy, dumpStack, enumerate, getAllStackTraces,
  306. getContextClassLoader, getDefaultUncaughtExceptionHandler,
  307. getId, getName, getPriority, getStackTrace, getState,
  308. getThreadGroup, getUncaughtExceptionHandler, holdsLock,
  309. interrupt, interrupted, isAlive, isDaemon, isInterrupted, join,
  310. join, join, resume, setContextClassLoader, setDaemon,
  311. setDefaultUncaughtExceptionHandler, setName, setPriority,
  312. setUncaughtExceptionHandler, sleep, sleep, start, stop, stop,
  313. suspend, toString, yield</code></li>
  314. </ul>
  315. <ul class="blockList">
  316. <li class="blockList"><a
  317. name="methods.inherited.from.class.java.lang.Object">
  318. <!-- -->
  319. </a>
  320. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  321. <code>equals, finalize, getClass, hashCode, notify, notifyAll, wait,
  322. wait, wait</code></li>
  323. </ul>
  324. </li>
  325. </ul>
  326. </li>
  327. </ul>
  328. </div>
  329. <div class="details">
  330. <ul class="blockList">
  331. <li class="blockList">
  332. <!-- ============ FIELD DETAIL =========== -->
  333. <ul class="blockList">
  334. <li class="blockList"><a name="field.detail">
  335. <!-- -->
  336. </a>
  337. <h3>Field Detail</h3>
  338. <a name="track">
  339. <!-- -->
  340. </a>
  341. <ul class="blockList">
  342. <li class="blockList">
  343. <h4>track</h4>
  344. <pre>protected&nbsp;<a href="../../../de/hems/trafficsim/Track.html"
  345. title="class in de.hems.trafficsim">Track</a> track</pre>
  346. <div class="block">the track to simulate</div>
  347. </li>
  348. </ul>
  349. <a name="stop">
  350. <!-- -->
  351. </a>
  352. <ul class="blockList">
  353. <li class="blockList">
  354. <h4>stop</h4>
  355. <pre>protected&nbsp;boolean stop</pre>
  356. <div class="block">Stop flag, indicating that the worker shall
  357. stop
  358. </div>
  359. </li>
  360. </ul>
  361. <a name="gui">
  362. <!-- -->
  363. </a>
  364. <ul class="blockList">
  365. <li class="blockList">
  366. <h4>gui</h4>
  367. <pre>protected&nbsp;<a
  368. href="../../../de/hems/trafficsim/MainActivity.html"
  369. title="class in de.hems.trafficsim">MainActivity</a> gui</pre>
  370. <div class="block">the MainActivity of the gui</div>
  371. </li>
  372. </ul>
  373. <a name="renderer">
  374. <!-- -->
  375. </a>
  376. <ul class="blockList">
  377. <li class="blockList">
  378. <h4>renderer</h4>
  379. <pre>protected&nbsp;<a
  380. href="../../../de/hems/trafficsim/Renderer.html"
  381. title="class in de.hems.trafficsim">Renderer</a> renderer</pre>
  382. <div class="block">the Renderer drawing the Track</div>
  383. </li>
  384. </ul>
  385. <a name="frameskip">
  386. <!-- -->
  387. </a>
  388. <ul class="blockListLast">
  389. <li class="blockList">
  390. <h4>frameskip</h4>
  391. <pre>protected&nbsp;int frameskip</pre>
  392. <div class="block">Amount of simulation steps between two frames in
  393. the view. Zero means
  394. that every simulation step is drawn.
  395. </div>
  396. </li>
  397. </ul>
  398. </li>
  399. </ul>
  400. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  401. <ul class="blockList">
  402. <li class="blockList"><a name="constructor.detail">
  403. <!-- -->
  404. </a>
  405. <h3>Constructor Detail</h3>
  406. <a name="Worker-de.hems.trafficsim.Track-de.hems.trafficsim.MainActivity-de.hems.trafficsim.Renderer-int-">
  407. <!-- -->
  408. </a>
  409. <ul class="blockListLast">
  410. <li class="blockList">
  411. <h4>Worker</h4>
  412. <pre>public&nbsp;Worker(<a
  413. href="../../../de/hems/trafficsim/Track.html"
  414. title="class in de.hems.trafficsim">Track</a>&nbsp;track,
  415. <a href="../../../de/hems/trafficsim/MainActivity.html"
  416. title="class in de.hems.trafficsim">MainActivity</a>&nbsp;gui,
  417. <a href="../../../de/hems/trafficsim/Renderer.html"
  418. title="class in de.hems.trafficsim">Renderer</a>&nbsp;renderer,
  419. int&nbsp;frameskip)</pre>
  420. <div class="block">Construct a new worker.</div>
  421. <dl>
  422. <dt><span class="paramLabel">Parameters:</span></dt>
  423. <dd><code>track</code> - the track to simulate</dd>
  424. <dd><code>gui</code> - the MainActivity of the gui</dd>
  425. <dd><code>renderer</code> - the Renderer drawing the Track</dd>
  426. <dd><code>frameskip</code> - Amount of simulation steps between
  427. two frames in the view. Zero means
  428. that every simulation step is drawn
  429. </dd>
  430. </dl>
  431. </li>
  432. </ul>
  433. </li>
  434. </ul>
  435. <!-- ============ METHOD DETAIL ========== -->
  436. <ul class="blockList">
  437. <li class="blockList"><a name="method.detail">
  438. <!-- -->
  439. </a>
  440. <h3>Method Detail</h3>
  441. <a name="setStop-boolean-">
  442. <!-- -->
  443. </a>
  444. <ul class="blockList">
  445. <li class="blockList">
  446. <h4>setStop</h4>
  447. <pre>public&nbsp;void&nbsp;setStop(boolean&nbsp;stop)</pre>
  448. <div class="block">Sets a flag that causes the worker to stop.</div>
  449. <dl>
  450. <dt><span class="paramLabel">Parameters:</span></dt>
  451. <dd><code>stop</code> - flag whether the thread shall stop</dd>
  452. </dl>
  453. </li>
  454. </ul>
  455. <a name="setFrameskip-int-">
  456. <!-- -->
  457. </a>
  458. <ul class="blockList">
  459. <li class="blockList">
  460. <h4>setFrameskip</h4>
  461. <pre>public&nbsp;void&nbsp;setFrameskip(int&nbsp;frames)</pre>
  462. <div class="block">Updates the amount of simulation steps between to
  463. view frames.
  464. </div>
  465. <dl>
  466. <dt><span class="paramLabel">Parameters:</span></dt>
  467. <dd><code>frames</code> - amount of steps</dd>
  468. </dl>
  469. </li>
  470. </ul>
  471. <a name="run--">
  472. <!-- -->
  473. </a>
  474. <ul class="blockListLast">
  475. <li class="blockList">
  476. <h4>run</h4>
  477. <pre>public&nbsp;void&nbsp;run()</pre>
  478. <div class="block">Method which is automatically executed when the
  479. thread is started. It alternates between
  480. updating the simulation and drawing a new frame in the view.
  481. </div>
  482. <dl>
  483. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  484. <dd><code>run</code>&nbsp;in interface&nbsp;<code>java.lang.Runnable</code>
  485. </dd>
  486. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  487. <dd><code>run</code>&nbsp;in
  488. class&nbsp;<code>java.lang.Thread</code></dd>
  489. </dl>
  490. </li>
  491. </ul>
  492. </li>
  493. </ul>
  494. </li>
  495. </ul>
  496. </div>
  497. </div>
  498. <!-- ========= END OF CLASS DATA ========= -->
  499. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  500. <div class="bottomNav"><a name="navbar.bottom">
  501. <!-- -->
  502. </a>
  503. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation
  504. links</a></div>
  505. <a name="navbar.bottom.firstrow">
  506. <!-- -->
  507. </a>
  508. <ul class="navList" title="Navigation">
  509. <li><a href="../../../de/hems/trafficsim/package-summary.html">Package</a></li>
  510. <li class="navBarCell1Rev">Class</li>
  511. <li><a href="package-tree.html">Tree</a></li>
  512. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  513. <li><a href="../../../index-files/index-1.html">Index</a></li>
  514. <li><a href="../../../help-doc.html">Help</a></li>
  515. </ul>
  516. </div>
  517. <div class="subNav">
  518. <ul class="navList">
  519. <li><a href="../../../de/hems/trafficsim/VehicleTimeRecord.html"
  520. title="class in de.hems.trafficsim"><span class="typeNameLink">Prev&nbsp;Class</span></a>
  521. </li>
  522. <li>Next&nbsp;Class</li>
  523. </ul>
  524. <ul class="navList">
  525. <li><a href="../../../index.html?de/hems/trafficsim/Worker.html" target="_top">Frames</a>
  526. </li>
  527. <li><a href="Worker.html" target="_top">No&nbsp;Frames</a></li>
  528. </ul>
  529. <ul class="navList" id="allclasses_navbar_bottom">
  530. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  531. </ul>
  532. <div>
  533. <script type="text/javascript"><!--
  534. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  535. if(window==top) {
  536. allClassesLink.style.display = "block";
  537. }
  538. else {
  539. allClassesLink.style.display = "none";
  540. }
  541. //-->
  542. </script>
  543. </div>
  544. <div>
  545. <ul class="subNavList">
  546. <li>Summary:&nbsp;</li>
  547. <li><a href="#nested.classes.inherited.from.class.java.lang.Thread">Nested</a>&nbsp;|&nbsp;
  548. </li>
  549. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  550. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  551. <li><a href="#method.summary">Method</a></li>
  552. </ul>
  553. <ul class="subNavList">
  554. <li>Detail:&nbsp;</li>
  555. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  556. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  557. <li><a href="#method.detail">Method</a></li>
  558. </ul>
  559. </div>
  560. <a name="skip.navbar.bottom">
  561. <!-- -->
  562. </a></div>
  563. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  564. </body>
  565. </html>