TrafficSim/doc/apidoc/de/hems/trafficsim/Worker.html
2020-11-15 16:34:32 +01:00

569 lines
29 KiB
HTML

<!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>Worker</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="Worker";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":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/VehicleTimeRecord.html"
title="class in de.hems.trafficsim"><span class="typeNameLink">Prev&nbsp;Class</span></a>
</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?de/hems/trafficsim/Worker.html" target="_top">Frames</a>
</li>
<li><a href="Worker.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.java.lang.Thread">Nested</a>&nbsp;|&nbsp;
</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 Worker">Class Worker</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Thread</li>
<li>
<ul class="inheritance">
<li>de.hems.trafficsim.Worker</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Runnable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Worker</span>
extends java.lang.Thread</pre>
<div class="block">Calculation thread, which runs the simulation itself and also
updates the view with a set rate.
</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.java.lang.Thread">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;java.lang.Thread</h3>
<code>java.lang.Thread.State,
java.lang.Thread.UncaughtExceptionHandler</code></li>
</ul>
</li>
</ul>
<!-- =========== 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">&nbsp;</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 int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../de/hems/trafficsim/Worker.html#frameskip">frameskip</a></span></code>
<div class="block">Amount of simulation steps between two frames
in the view.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a
href="../../../de/hems/trafficsim/MainActivity.html"
title="class in de.hems.trafficsim">MainActivity</a></code>
</td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../de/hems/trafficsim/Worker.html#gui">gui</a></span></code>
<div class="block">the MainActivity of the gui</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a
href="../../../de/hems/trafficsim/Renderer.html"
title="class in de.hems.trafficsim">Renderer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../de/hems/trafficsim/Worker.html#renderer">renderer</a></span></code>
<div class="block">the Renderer drawing the Track</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../de/hems/trafficsim/Worker.html#stop">stop</a></span></code>
<div class="block">Stop flag, indicating that the worker shall
stop
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a
href="../../../de/hems/trafficsim/Track.html"
title="class in de.hems.trafficsim">Track</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../de/hems/trafficsim/Worker.html#track">track</a></span></code>
<div class="block">the track to simulate</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a
name="fields.inherited.from.class.java.lang.Thread">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;java.lang.Thread</h3>
<code>MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY</code></li>
</ul>
</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">&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="../../../de/hems/trafficsim/Worker.html#Worker-de.hems.trafficsim.Track-de.hems.trafficsim.MainActivity-de.hems.trafficsim.Renderer-int-">Worker</a></span>(<a
href="../../../de/hems/trafficsim/Track.html"
title="class in de.hems.trafficsim">Track</a>&nbsp;track,
<a href="../../../de/hems/trafficsim/MainActivity.html"
title="class in de.hems.trafficsim">MainActivity</a>&nbsp;gui,
<a href="../../../de/hems/trafficsim/Renderer.html"
title="class in de.hems.trafficsim">Renderer</a>&nbsp;renderer,
int&nbsp;frameskip)</code>
<div class="block">Construct a new worker.</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">&nbsp;</span></span><span
class="tableTab" id="t2"><span><a href="javascript:show(2);">Instance Methods</a></span><span
class="tabEnd">&nbsp;</span></span><span class="tableTab"
id="t4"><span><a
href="javascript:show(8);">Concrete Methods</a></span><span
class="tabEnd">&nbsp;</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../de/hems/trafficsim/Worker.html#run--">run</a></span>()</code>
<div class="block">Method which is automatically executed when
the thread is started.
</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../de/hems/trafficsim/Worker.html#setFrameskip-int-">setFrameskip</a></span>(int&nbsp;frames)</code>
<div class="block">Updates the amount of simulation steps
between to view frames.
</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a
href="../../../de/hems/trafficsim/Worker.html#setStop-boolean-">setStop</a></span>(boolean&nbsp;stop)</code>
<div class="block">Sets a flag that causes the worker to stop.
</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a
name="methods.inherited.from.class.java.lang.Thread">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Thread</h3>
<code>activeCount, checkAccess, clone, countStackFrames,
currentThread, destroy, dumpStack, enumerate, getAllStackTraces,
getContextClassLoader, getDefaultUncaughtExceptionHandler,
getId, getName, getPriority, getStackTrace, getState,
getThreadGroup, getUncaughtExceptionHandler, holdsLock,
interrupt, interrupted, isAlive, isDaemon, isInterrupted, join,
join, join, resume, setContextClassLoader, setDaemon,
setDefaultUncaughtExceptionHandler, setName, setPriority,
setUncaughtExceptionHandler, sleep, sleep, start, stop, stop,
suspend, toString, yield</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.Object</h3>
<code>equals, finalize, getClass, hashCode, notify, notifyAll, 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="track">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>track</h4>
<pre>protected&nbsp;<a href="../../../de/hems/trafficsim/Track.html"
title="class in de.hems.trafficsim">Track</a> track</pre>
<div class="block">the track to simulate</div>
</li>
</ul>
<a name="stop">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>protected&nbsp;boolean stop</pre>
<div class="block">Stop flag, indicating that the worker shall
stop
</div>
</li>
</ul>
<a name="gui">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>gui</h4>
<pre>protected&nbsp;<a
href="../../../de/hems/trafficsim/MainActivity.html"
title="class in de.hems.trafficsim">MainActivity</a> gui</pre>
<div class="block">the MainActivity of the gui</div>
</li>
</ul>
<a name="renderer">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>renderer</h4>
<pre>protected&nbsp;<a
href="../../../de/hems/trafficsim/Renderer.html"
title="class in de.hems.trafficsim">Renderer</a> renderer</pre>
<div class="block">the Renderer drawing the Track</div>
</li>
</ul>
<a name="frameskip">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>frameskip</h4>
<pre>protected&nbsp;int frameskip</pre>
<div class="block">Amount of simulation steps between two frames in
the view. Zero means
that every simulation step is drawn.
</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Worker-de.hems.trafficsim.Track-de.hems.trafficsim.MainActivity-de.hems.trafficsim.Renderer-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Worker</h4>
<pre>public&nbsp;Worker(<a
href="../../../de/hems/trafficsim/Track.html"
title="class in de.hems.trafficsim">Track</a>&nbsp;track,
<a href="../../../de/hems/trafficsim/MainActivity.html"
title="class in de.hems.trafficsim">MainActivity</a>&nbsp;gui,
<a href="../../../de/hems/trafficsim/Renderer.html"
title="class in de.hems.trafficsim">Renderer</a>&nbsp;renderer,
int&nbsp;frameskip)</pre>
<div class="block">Construct a new worker.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>track</code> - the track to simulate</dd>
<dd><code>gui</code> - the MainActivity of the gui</dd>
<dd><code>renderer</code> - the Renderer drawing the Track</dd>
<dd><code>frameskip</code> - Amount of simulation steps between
two frames in the view. Zero means
that every simulation step is drawn
</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="setStop-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStop</h4>
<pre>public&nbsp;void&nbsp;setStop(boolean&nbsp;stop)</pre>
<div class="block">Sets a flag that causes the worker to stop.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stop</code> - flag whether the thread shall stop</dd>
</dl>
</li>
</ul>
<a name="setFrameskip-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFrameskip</h4>
<pre>public&nbsp;void&nbsp;setFrameskip(int&nbsp;frames)</pre>
<div class="block">Updates the amount of simulation steps between to
view frames.
</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>frames</code> - amount of steps</dd>
</dl>
</li>
</ul>
<a name="run--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;void&nbsp;run()</pre>
<div class="block">Method which is automatically executed when the
thread is started. It alternates between
updating the simulation and drawing a new frame in the view.
</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>run</code>&nbsp;in interface&nbsp;<code>java.lang.Runnable</code>
</dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>run</code>&nbsp;in
class&nbsp;<code>java.lang.Thread</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation
links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../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/VehicleTimeRecord.html"
title="class in de.hems.trafficsim"><span class="typeNameLink">Prev&nbsp;Class</span></a>
</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?de/hems/trafficsim/Worker.html" target="_top">Frames</a>
</li>
<li><a href="Worker.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.java.lang.Thread">Nested</a>&nbsp;|&nbsp;
</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>