source: javadoc/genius/core/Deadline.html@ 1

Last change on this file since 1 was 1, checked in by Wouter Pasman, 7 years ago

Initial import : Genius 9.0.0

File size: 14.1 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
5<!-- Generated by javadoc (1.8.0_112) on Thu Jun 21 12:05:56 CEST 2018 -->
6<title>Deadline (Genius Core Documentation)</title>
7<meta name="date" content="2018-06-21">
8<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
9<script type="text/javascript" src="../../script.js"></script>
10</head>
11<body>
12<script type="text/javascript"><!--
13 try {
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="Deadline (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23var altColor = "altColor";
24var rowColor = "rowColor";
25var tableTab = "tableTab";
26var activeTableTab = "activeTableTab";
27</script>
28<noscript>
29<div>JavaScript is disabled on your browser.</div>
30</noscript>
31<!-- ========= START OF TOP NAVBAR ======= -->
32<div class="topNav"><a name="navbar.top">
33<!-- -->
34</a>
35<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36<a name="navbar.top.firstrow">
37<!-- -->
38</a>
39<ul class="navList" title="Navigation">
40<li><a href="../../overview-summary.html">Overview</a></li>
41<li><a href="package-summary.html">Package</a></li>
42<li class="navBarCell1Rev">Class</li>
43<li><a href="class-use/Deadline.html">Use</a></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-all.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="../../genius/core/BidIterator.html" title="class in genius.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../genius/core/DeadlineType.html" title="enum in genius.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../index.html?genius/core/Deadline.html" target="_top">Frames</a></li>
57<li><a href="Deadline.html" target="_top">No&nbsp;Frames</a></li>
58</ul>
59<ul class="navList" id="allclasses_navbar_top">
60<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
61</ul>
62<div>
63<script type="text/javascript"><!--
64 allClassesLink = document.getElementById("allclasses_navbar_top");
65 if(window==top) {
66 allClassesLink.style.display = "block";
67 }
68 else {
69 allClassesLink.style.display = "none";
70 }
71 //-->
72</script>
73</div>
74<div>
75<ul class="subNavList">
76<li>Summary:&nbsp;</li>
77<li>Nested&nbsp;|&nbsp;</li>
78<li>Field&nbsp;|&nbsp;</li>
79<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
80<li><a href="#method.summary">Method</a></li>
81</ul>
82<ul class="subNavList">
83<li>Detail:&nbsp;</li>
84<li>Field&nbsp;|&nbsp;</li>
85<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
86<li><a href="#method.detail">Method</a></li>
87</ul>
88</div>
89<a name="skip.navbar.top">
90<!-- -->
91</a></div>
92<!-- ========= END OF TOP NAVBAR ========= -->
93<!-- ======== START OF CLASS DATA ======== -->
94<div class="header">
95<div class="subTitle">genius.core</div>
96<h2 title="Class Deadline" class="title">Class Deadline</h2>
97</div>
98<div class="contentContainer">
99<ul class="inheritance">
100<li>java.lang.Object</li>
101<li>
102<ul class="inheritance">
103<li>genius.core.Deadline</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<dl>
111<dt>All Implemented Interfaces:</dt>
112<dd>java.io.Serializable</dd>
113</dl>
114<hr>
115<br>
116<pre>public class <span class="typeNameLabel">Deadline</span>
117extends java.lang.Object
118implements java.io.Serializable</pre>
119<div class="block">Contains the deadline - either rounds based or time based.
120 <p>
121 Deadline is a final object and can be serialized to xml. Immutable.</div>
122<dl>
123<dt><span class="simpleTagLabel">Author:</span></dt>
124<dd>W.Pasman</dd>
125<dt><span class="seeLabel">See Also:</span></dt>
126<dd><a href="../../serialized-form.html#genius.core.Deadline">Serialized Form</a></dd>
127</dl>
128</li>
129</ul>
130</div>
131<div class="summary">
132<ul class="blockList">
133<li class="blockList">
134<!-- ======== CONSTRUCTOR SUMMARY ======== -->
135<ul class="blockList">
136<li class="blockList"><a name="constructor.summary">
137<!-- -->
138</a>
139<h3>Constructor Summary</h3>
140<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
141<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
142<tr>
143<th class="colOne" scope="col">Constructor and Description</th>
144</tr>
145<tr class="altColor">
146<td class="colOne"><code><span class="memberNameLink"><a href="../../genius/core/Deadline.html#Deadline--">Deadline</a></span>()</code>
147<div class="block">Create default value.</div>
148</td>
149</tr>
150<tr class="rowColor">
151<td class="colOne"><code><span class="memberNameLink"><a href="../../genius/core/Deadline.html#Deadline-int-genius.core.DeadlineType-">Deadline</a></span>(int&nbsp;val,
152 <a href="../../genius/core/DeadlineType.html" title="enum in genius.core">DeadlineType</a>&nbsp;tp)</code>&nbsp;</td>
153</tr>
154</table>
155</li>
156</ul>
157<!-- ========== METHOD SUMMARY =========== -->
158<ul class="blockList">
159<li class="blockList"><a name="method.summary">
160<!-- -->
161</a>
162<h3>Method Summary</h3>
163<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
164<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
165<tr>
166<th class="colFirst" scope="col">Modifier and Type</th>
167<th class="colLast" scope="col">Method and Description</th>
168</tr>
169<tr id="i0" class="altColor">
170<td class="colFirst"><code>boolean</code></td>
171<td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/Deadline.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
172</tr>
173<tr id="i1" class="rowColor">
174<td class="colFirst"><code>java.lang.Integer</code></td>
175<td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/Deadline.html#getDefaultTimeout--">getDefaultTimeout</a></span>()</code>&nbsp;</td>
176</tr>
177<tr id="i2" class="altColor">
178<td class="colFirst"><code>int</code></td>
179<td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/Deadline.html#getTimeOrDefaultTimeout--">getTimeOrDefaultTimeout</a></span>()</code>&nbsp;</td>
180</tr>
181<tr id="i3" class="rowColor">
182<td class="colFirst"><code><a href="../../genius/core/DeadlineType.html" title="enum in genius.core">DeadlineType</a></code></td>
183<td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/Deadline.html#getType--">getType</a></span>()</code>&nbsp;</td>
184</tr>
185<tr id="i4" class="altColor">
186<td class="colFirst"><code>int</code></td>
187<td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/Deadline.html#getValue--">getValue</a></span>()</code>&nbsp;</td>
188</tr>
189<tr id="i5" class="rowColor">
190<td class="colFirst"><code>int</code></td>
191<td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/Deadline.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
192</tr>
193<tr id="i6" class="altColor">
194<td class="colFirst"><code>java.lang.String</code></td>
195<td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/Deadline.html#toString--">toString</a></span>()</code>&nbsp;</td>
196</tr>
197<tr id="i7" class="rowColor">
198<td class="colFirst"><code>java.lang.String</code></td>
199<td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/Deadline.html#valueString--">valueString</a></span>()</code>&nbsp;</td>
200</tr>
201</table>
202<ul class="blockList">
203<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
204<!-- -->
205</a>
206<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
207<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
208</ul>
209</li>
210</ul>
211</li>
212</ul>
213</div>
214<div class="details">
215<ul class="blockList">
216<li class="blockList">
217<!-- ========= CONSTRUCTOR DETAIL ======== -->
218<ul class="blockList">
219<li class="blockList"><a name="constructor.detail">
220<!-- -->
221</a>
222<h3>Constructor Detail</h3>
223<a name="Deadline--">
224<!-- -->
225</a>
226<ul class="blockList">
227<li class="blockList">
228<h4>Deadline</h4>
229<pre>public&nbsp;Deadline()</pre>
230<div class="block">Create default value.</div>
231</li>
232</ul>
233<a name="Deadline-int-genius.core.DeadlineType-">
234<!-- -->
235</a>
236<ul class="blockListLast">
237<li class="blockList">
238<h4>Deadline</h4>
239<pre>public&nbsp;Deadline(int&nbsp;val,
240 <a href="../../genius/core/DeadlineType.html" title="enum in genius.core">DeadlineType</a>&nbsp;tp)</pre>
241</li>
242</ul>
243</li>
244</ul>
245<!-- ============ METHOD DETAIL ========== -->
246<ul class="blockList">
247<li class="blockList"><a name="method.detail">
248<!-- -->
249</a>
250<h3>Method Detail</h3>
251<a name="getValue--">
252<!-- -->
253</a>
254<ul class="blockList">
255<li class="blockList">
256<h4>getValue</h4>
257<pre>public&nbsp;int&nbsp;getValue()</pre>
258<dl>
259<dt><span class="returnLabel">Returns:</span></dt>
260<dd>the total value of the deadline (seconds or rounds)</dd>
261</dl>
262</li>
263</ul>
264<a name="getType--">
265<!-- -->
266</a>
267<ul class="blockList">
268<li class="blockList">
269<h4>getType</h4>
270<pre>public&nbsp;<a href="../../genius/core/DeadlineType.html" title="enum in genius.core">DeadlineType</a>&nbsp;getType()</pre>
271<dl>
272<dt><span class="returnLabel">Returns:</span></dt>
273<dd>the <a href="../../genius/core/DeadlineType.html" title="enum in genius.core"><code>DeadlineType</code></a> of this deadline</dd>
274</dl>
275</li>
276</ul>
277<a name="getDefaultTimeout--">
278<!-- -->
279</a>
280<ul class="blockList">
281<li class="blockList">
282<h4>getDefaultTimeout</h4>
283<pre>public&nbsp;java.lang.Integer&nbsp;getDefaultTimeout()</pre>
284<dl>
285<dt><span class="returnLabel">Returns:</span></dt>
286<dd>the default time-out for function calls in the agents</dd>
287</dl>
288</li>
289</ul>
290<a name="toString--">
291<!-- -->
292</a>
293<ul class="blockList">
294<li class="blockList">
295<h4>toString</h4>
296<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
297<dl>
298<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
299<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
300</dl>
301</li>
302</ul>
303<a name="valueString--">
304<!-- -->
305</a>
306<ul class="blockList">
307<li class="blockList">
308<h4>valueString</h4>
309<pre>public&nbsp;java.lang.String&nbsp;valueString()</pre>
310<dl>
311<dt><span class="returnLabel">Returns:</span></dt>
312<dd>just the value of this deadline, eg "10s".</dd>
313</dl>
314</li>
315</ul>
316<a name="getTimeOrDefaultTimeout--">
317<!-- -->
318</a>
319<ul class="blockList">
320<li class="blockList">
321<h4>getTimeOrDefaultTimeout</h4>
322<pre>public&nbsp;int&nbsp;getTimeOrDefaultTimeout()</pre>
323<dl>
324<dt><span class="returnLabel">Returns:</span></dt>
325<dd>the time, or a default time time-out. This is needed to determine
326 the time-out for code execution with <a href="../../genius/core/DeadlineType.html#ROUND"><code>DeadlineType.ROUND</code></a>
327 deadlines.</dd>
328</dl>
329</li>
330</ul>
331<a name="hashCode--">
332<!-- -->
333</a>
334<ul class="blockList">
335<li class="blockList">
336<h4>hashCode</h4>
337<pre>public&nbsp;int&nbsp;hashCode()</pre>
338<dl>
339<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
340<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
341</dl>
342</li>
343</ul>
344<a name="equals-java.lang.Object-">
345<!-- -->
346</a>
347<ul class="blockListLast">
348<li class="blockList">
349<h4>equals</h4>
350<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
351<dl>
352<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
353<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
354</dl>
355</li>
356</ul>
357</li>
358</ul>
359</li>
360</ul>
361</div>
362</div>
363<!-- ========= END OF CLASS DATA ========= -->
364<!-- ======= START OF BOTTOM NAVBAR ====== -->
365<div class="bottomNav"><a name="navbar.bottom">
366<!-- -->
367</a>
368<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
369<a name="navbar.bottom.firstrow">
370<!-- -->
371</a>
372<ul class="navList" title="Navigation">
373<li><a href="../../overview-summary.html">Overview</a></li>
374<li><a href="package-summary.html">Package</a></li>
375<li class="navBarCell1Rev">Class</li>
376<li><a href="class-use/Deadline.html">Use</a></li>
377<li><a href="package-tree.html">Tree</a></li>
378<li><a href="../../deprecated-list.html">Deprecated</a></li>
379<li><a href="../../index-all.html">Index</a></li>
380<li><a href="../../help-doc.html">Help</a></li>
381</ul>
382</div>
383<div class="subNav">
384<ul class="navList">
385<li><a href="../../genius/core/BidIterator.html" title="class in genius.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
386<li><a href="../../genius/core/DeadlineType.html" title="enum in genius.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
387</ul>
388<ul class="navList">
389<li><a href="../../index.html?genius/core/Deadline.html" target="_top">Frames</a></li>
390<li><a href="Deadline.html" target="_top">No&nbsp;Frames</a></li>
391</ul>
392<ul class="navList" id="allclasses_navbar_bottom">
393<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
394</ul>
395<div>
396<script type="text/javascript"><!--
397 allClassesLink = document.getElementById("allclasses_navbar_bottom");
398 if(window==top) {
399 allClassesLink.style.display = "block";
400 }
401 else {
402 allClassesLink.style.display = "none";
403 }
404 //-->
405</script>
406</div>
407<div>
408<ul class="subNavList">
409<li>Summary:&nbsp;</li>
410<li>Nested&nbsp;|&nbsp;</li>
411<li>Field&nbsp;|&nbsp;</li>
412<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
413<li><a href="#method.summary">Method</a></li>
414</ul>
415<ul class="subNavList">
416<li>Detail:&nbsp;</li>
417<li>Field&nbsp;|&nbsp;</li>
418<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
419<li><a href="#method.detail">Method</a></li>
420</ul>
421</div>
422<a name="skip.navbar.bottom">
423<!-- -->
424</a></div>
425<!-- ======== END OF BOTTOM NAVBAR ======= -->
426</body>
427</html>
Note: See TracBrowser for help on using the repository browser.