Files
2012-10-22 23:08:52 +02:00

489 lines
17 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="pl">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Mon Oct 22 23:08:21 CEST 2012 -->
<title>Runner</title>
<meta name="date" content="2012-10-22">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Runner";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../BiathlonSymulation/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Runner.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-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="../BiathlonSymulation/Run.html" title="class in BiathlonSymulation"><span class="strong">Prev Class</span></a></li>
<li><a href="../BiathlonSymulation/RunnerGenerator.html" title="class in BiathlonSymulation"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?BiathlonSymulation/Runner.html" target="_top">Frames</a></li>
<li><a href="Runner.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:&nbsp;</li>
<li>Nested&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">BiathlonSymulation</div>
<h2 title="Class Runner" class="title">Class Runner</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>desmoj.core.simulator.NamedObject</li>
<li>
<ul class="inheritance">
<li>desmoj.core.simulator.ModelComponent</li>
<li>
<ul class="inheritance">
<li>desmoj.core.simulator.Schedulable</li>
<li>
<ul class="inheritance">
<li>desmoj.core.simulator.Entity</li>
<li>
<ul class="inheritance">
<li>desmoj.core.simulator.SimProcess</li>
<li>
<ul class="inheritance">
<li>BiathlonSymulation.Runner</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">Runner</span>
extends desmoj.core.simulator.SimProcess</pre>
<div class="block">This class represents the runner in the Run model.</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 class="overviewSummary" border="0" cellpadding="3" cellspacing="0" 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>double</code></td>
<td class="colLast"><code><strong><a href="../BiathlonSymulation/Runner.html#hold_time">hold_time</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../BiathlonSymulation/Run.html" title="class in BiathlonSymulation">Run</a></code></td>
<td class="colLast"><code><strong><a href="../BiathlonSymulation/Runner.html#model">model</a></strong></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../BiathlonSymulation/Runner.html#Runner(desmoj.core.simulator.Model, java.lang.String, boolean, int, double, double)">Runner</a></strong>(desmoj.core.simulator.Model&nbsp;owner,
java.lang.String&nbsp;name,
boolean&nbsp;showInTrace,
int&nbsp;number,
double&nbsp;speed,
double&nbsp;accuracy)</code>
<div class="block">Constructor of the runner process
Used to create a new runner.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</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">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../BiathlonSymulation/Runner.html#getAccuracy()">getAccuracy</a></strong>()</code>
<div class="block">returns this runner average accuracy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../BiathlonSymulation/Runner.html#getNumber()">getNumber</a></strong>()</code>
<div class="block">returns this runner number.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../BiathlonSymulation/Runner.html#getSpeed()">getSpeed</a></strong>()</code>
<div class="block">returns this runner average speed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../BiathlonSymulation/Runner.html#getStage()">getStage</a></strong>()</code>
<div class="block">returns this runner current stage.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../BiathlonSymulation/Runner.html#incStage()">incStage</a></strong>()</code>
<div class="block">Increment this runner stage.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../BiathlonSymulation/Runner.html#lifeCycle()">lifeCycle</a></strong>()</code>
<div class="block">Describes this runner's life cycle:</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../BiathlonSymulation/Runner.html#sendMessage(java.lang.String)">sendMessage</a></strong>(java.lang.String&nbsp;msg)</code>
<div class="block">Sends message to this runner trace file.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_desmoj.core.simulator.SimProcess">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;desmoj.core.simulator.SimProcess</h3>
<code>activate, activate, activate, activate, activateAfter, activateBefore, cancelInterruptDelayed, canCooperate, clearInterruptCode, cooperate, getInterruptCode, getInterruptException, getMaster, getRealTimeConstraint, getSchedulingPriority, getSlaveWaitQueue, getSupervisor, hold, hold, hold, hold, interrupt, interrupt, interruptDelayed, interruptDelayed, isBlocked, isComponent, isDelayedInterruptScheduled, isInterrupted, isTerminated, obtainResources, passivate, prepareTransport, reActivate, resetMaster, returnAllResources, returnResources, setBlocked, setRealTimeConstraint, setSchedulingPriority, setSlaveWaitQueue</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_desmoj.core.simulator.Entity">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;desmoj.core.simulator.Entity</h3>
<code>getIdentNumber, getPriority, getQueue, getQueueingPriority, getQueues, getScheduledEvents, isEqual, isLarger, isLargerOrEqual, isNotEqual, isQueued, isSimProcess, isSmaller, isSmallerOrEqual, schedule, schedule, schedule, schedule, schedule, schedule, schedule, scheduleAfter, scheduleAfter, scheduleAfter, scheduleBefore, scheduleBefore, scheduleBefore, setPriority, setQueuingPriority</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_desmoj.core.simulator.Schedulable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;desmoj.core.simulator.Schedulable</h3>
<code>cancel, isCurrent, isScheduled, rename, reSchedule, reSchedule, reSchedule, scheduledAt, scheduledNext</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_desmoj.core.simulator.ModelComponent">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;desmoj.core.simulator.ModelComponent</h3>
<code>current, currentEntity, currentEntityAll, currentEvent, currentModel, currentSimProcess, currentTime, debugIsOn, debugOff, debugOn, epsilon, getModel, isExperimentCompatible, isModelCompatible, presentTime, sendDebugNote, sendMessage, sendTraceNote, sendWarning, skipTraceNote, skipTraceNote, traceIsOn, traceOff, traceOn</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_desmoj.core.simulator.NamedObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;desmoj.core.simulator.NamedObject</h3>
<code>getName, getQuotedName, toString</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, 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="hold_time">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hold_time</h4>
<pre>public&nbsp;double hold_time</pre>
</li>
</ul>
<a name="model">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>model</h4>
<pre>public&nbsp;<a href="../BiathlonSymulation/Run.html" title="class in BiathlonSymulation">Run</a> model</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Runner(desmoj.core.simulator.Model, java.lang.String, boolean, int, double, double)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Runner</h4>
<pre>public&nbsp;Runner(desmoj.core.simulator.Model&nbsp;owner,
java.lang.String&nbsp;name,
boolean&nbsp;showInTrace,
int&nbsp;number,
double&nbsp;speed,
double&nbsp;accuracy)</pre>
<div class="block">Constructor of the runner process
Used to create a new runner.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>owner</code> - the model this process belongs to</dd><dd><code>name</code> - this runner's name</dd><dd><code>showInTrace</code> - flag to indicate if this process shall produce
output for the trace</dd><dd><code>number</code> - this runner number.</dd><dd><code>speed</code> - this runner average speed.</dd><dd><code>accuracy</code> - ths runner average accuracy.</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="getNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumber</h4>
<pre>public&nbsp;int&nbsp;getNumber()</pre>
<div class="block">returns this runner number.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>this runner number as int.</dd></dl>
</li>
</ul>
<a name="getSpeed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSpeed</h4>
<pre>public&nbsp;double&nbsp;getSpeed()</pre>
<div class="block">returns this runner average speed.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>this runner avarage speed as double.</dd></dl>
</li>
</ul>
<a name="getAccuracy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAccuracy</h4>
<pre>public&nbsp;double&nbsp;getAccuracy()</pre>
<div class="block">returns this runner average accuracy.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>this runner avarage accuracy as double.</dd></dl>
</li>
</ul>
<a name="getStage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStage</h4>
<pre>public&nbsp;int&nbsp;getStage()</pre>
<div class="block">returns this runner current stage.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>this runner current stage as int.</dd></dl>
</li>
</ul>
<a name="incStage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>incStage</h4>
<pre>public&nbsp;void&nbsp;incStage()</pre>
<div class="block">Increment this runner stage.</div>
</li>
</ul>
<a name="sendMessage(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sendMessage</h4>
<pre>public&nbsp;void&nbsp;sendMessage(java.lang.String&nbsp;msg)</pre>
<div class="block">Sends message to this runner trace file.</div>
</li>
</ul>
<a name="lifeCycle()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>lifeCycle</h4>
<pre>public&nbsp;void&nbsp;lifeCycle()</pre>
<div class="block">Describes this runner's life cycle:</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>lifeCycle</code>&nbsp;in class&nbsp;<code>desmoj.core.simulator.SimProcess</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../BiathlonSymulation/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Runner.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-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="../BiathlonSymulation/Run.html" title="class in BiathlonSymulation"><span class="strong">Prev Class</span></a></li>
<li><a href="../BiathlonSymulation/RunnerGenerator.html" title="class in BiathlonSymulation"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?BiathlonSymulation/Runner.html" target="_top">Frames</a></li>
<li><a href="Runner.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:&nbsp;</li>
<li>Nested&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>