source: javadoc/genius/core/timeline/Timeline.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: 17.3 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:58 CEST 2018 -->
6<title>Timeline (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="Timeline (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":6,"i1":6,"i2":6,"i3":10,"i4":10,"i5":10};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Timeline.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/timeline/DiscreteTimeline.html" title="class in genius.core.timeline"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/timeline/Timeline.Type.html" title="enum in genius.core.timeline"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/timeline/Timeline.html" target="_top">Frames</a></li>
57<li><a href="Timeline.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
78<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.timeline</div>
96<h2 title="Class Timeline" class="title">Class Timeline</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.timeline.Timeline</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><a href="../../../genius/core/timeline/TimeLineInfo.html" title="interface in genius.core.timeline">TimeLineInfo</a>, java.io.Serializable</dd>
113</dl>
114<dl>
115<dt>Direct Known Subclasses:</dt>
116<dd><a href="../../../genius/core/timeline/ContinuousTimeline.html" title="class in genius.core.timeline">ContinuousTimeline</a>, <a href="../../../genius/core/timeline/DiscreteTimeline.html" title="class in genius.core.timeline">DiscreteTimeline</a></dd>
117</dl>
118<hr>
119<br>
120<pre>public abstract class <span class="typeNameLabel">Timeline</span>
121extends java.lang.Object
122implements <a href="../../../genius/core/timeline/TimeLineInfo.html" title="interface in genius.core.timeline">TimeLineInfo</a></pre>
123<div class="block">A time line, running from t = 0 (start) to t = 1 (deadline).</div>
124<dl>
125<dt><span class="seeLabel">See Also:</span></dt>
126<dd><a href="../../../serialized-form.html#genius.core.timeline.Timeline">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<!-- ======== NESTED CLASS SUMMARY ======== -->
135<ul class="blockList">
136<li class="blockList"><a name="nested.class.summary">
137<!-- -->
138</a>
139<h3>Nested Class Summary</h3>
140<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
141<caption><span>Nested Classes</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">Class and Description</th>
145</tr>
146<tr class="altColor">
147<td class="colFirst"><code>static class&nbsp;</code></td>
148<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/timeline/Timeline.Type.html" title="enum in genius.core.timeline">Timeline.Type</a></span></code>
149<div class="block">In a time-based protocol, time passes within a round.</div>
150</td>
151</tr>
152</table>
153</li>
154</ul>
155<!-- =========== FIELD SUMMARY =========== -->
156<ul class="blockList">
157<li class="blockList"><a name="field.summary">
158<!-- -->
159</a>
160<h3>Field Summary</h3>
161<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
162<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
163<tr>
164<th class="colFirst" scope="col">Modifier and Type</th>
165<th class="colLast" scope="col">Field and Description</th>
166</tr>
167<tr class="altColor">
168<td class="colFirst"><code>protected boolean</code></td>
169<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/timeline/Timeline.html#hasDeadline">hasDeadline</a></span></code>&nbsp;</td>
170</tr>
171<tr class="rowColor">
172<td class="colFirst"><code>protected boolean</code></td>
173<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/timeline/Timeline.html#paused">paused</a></span></code>&nbsp;</td>
174</tr>
175</table>
176</li>
177</ul>
178<!-- ======== CONSTRUCTOR SUMMARY ======== -->
179<ul class="blockList">
180<li class="blockList"><a name="constructor.summary">
181<!-- -->
182</a>
183<h3>Constructor Summary</h3>
184<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
185<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
186<tr>
187<th class="colOne" scope="col">Constructor and Description</th>
188</tr>
189<tr class="altColor">
190<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/timeline/Timeline.html#Timeline--">Timeline</a></span>()</code>&nbsp;</td>
191</tr>
192</table>
193</li>
194</ul>
195<!-- ========== METHOD SUMMARY =========== -->
196<ul class="blockList">
197<li class="blockList"><a name="method.summary">
198<!-- -->
199</a>
200<h3>Method Summary</h3>
201<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
202<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>
203<tr>
204<th class="colFirst" scope="col">Modifier and Type</th>
205<th class="colLast" scope="col">Method and Description</th>
206</tr>
207<tr id="i0" class="altColor">
208<td class="colFirst"><code>abstract double</code></td>
209<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/timeline/Timeline.html#getCurrentTime--">getCurrentTime</a></span>()</code>&nbsp;</td>
210</tr>
211<tr id="i1" class="rowColor">
212<td class="colFirst"><code>abstract double</code></td>
213<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/timeline/Timeline.html#getTime--">getTime</a></span>()</code>
214<div class="block">Gets the time, running from t = 0 (start) to t = 1 (deadline).</div>
215</td>
216</tr>
217<tr id="i2" class="altColor">
218<td class="colFirst"><code>abstract double</code></td>
219<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/timeline/Timeline.html#getTotalTime--">getTotalTime</a></span>()</code>&nbsp;</td>
220</tr>
221<tr id="i3" class="rowColor">
222<td class="colFirst"><code><a href="../../../genius/core/timeline/Timeline.Type.html" title="enum in genius.core.timeline">Timeline.Type</a></code></td>
223<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/timeline/Timeline.html#getType--">getType</a></span>()</code>
224<div class="block">In a time-based protocol, time passes within a round.</div>
225</td>
226</tr>
227<tr id="i4" class="altColor">
228<td class="colFirst"><code>boolean</code></td>
229<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/timeline/Timeline.html#isDeadlineReached--">isDeadlineReached</a></span>()</code>&nbsp;</td>
230</tr>
231<tr id="i5" class="rowColor">
232<td class="colFirst"><code>boolean</code></td>
233<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/timeline/Timeline.html#isPaused--">isPaused</a></span>()</code>&nbsp;</td>
234</tr>
235</table>
236<ul class="blockList">
237<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
238<!-- -->
239</a>
240<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
241<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
242</ul>
243</li>
244</ul>
245</li>
246</ul>
247</div>
248<div class="details">
249<ul class="blockList">
250<li class="blockList">
251<!-- ============ FIELD DETAIL =========== -->
252<ul class="blockList">
253<li class="blockList"><a name="field.detail">
254<!-- -->
255</a>
256<h3>Field Detail</h3>
257<a name="hasDeadline">
258<!-- -->
259</a>
260<ul class="blockList">
261<li class="blockList">
262<h4>hasDeadline</h4>
263<pre>protected&nbsp;boolean hasDeadline</pre>
264</li>
265</ul>
266<a name="paused">
267<!-- -->
268</a>
269<ul class="blockListLast">
270<li class="blockList">
271<h4>paused</h4>
272<pre>protected&nbsp;boolean paused</pre>
273</li>
274</ul>
275</li>
276</ul>
277<!-- ========= CONSTRUCTOR DETAIL ======== -->
278<ul class="blockList">
279<li class="blockList"><a name="constructor.detail">
280<!-- -->
281</a>
282<h3>Constructor Detail</h3>
283<a name="Timeline--">
284<!-- -->
285</a>
286<ul class="blockListLast">
287<li class="blockList">
288<h4>Timeline</h4>
289<pre>public&nbsp;Timeline()</pre>
290</li>
291</ul>
292</li>
293</ul>
294<!-- ============ METHOD DETAIL ========== -->
295<ul class="blockList">
296<li class="blockList"><a name="method.detail">
297<!-- -->
298</a>
299<h3>Method Detail</h3>
300<a name="getTime--">
301<!-- -->
302</a>
303<ul class="blockList">
304<li class="blockList">
305<h4>getTime</h4>
306<pre>public abstract&nbsp;double&nbsp;getTime()</pre>
307<div class="block">Gets the time, running from t = 0 (start) to t = 1 (deadline). The time
308 is normalized, so agents need not be concerned with the actual internal
309 clock.</div>
310<dl>
311<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
312<dd><code><a href="../../../genius/core/timeline/TimeLineInfo.html#getTime--">getTime</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/timeline/TimeLineInfo.html" title="interface in genius.core.timeline">TimeLineInfo</a></code></dd>
313<dt><span class="returnLabel">Returns:</span></dt>
314<dd>current time in the interval [0, 1].</dd>
315</dl>
316</li>
317</ul>
318<a name="getTotalTime--">
319<!-- -->
320</a>
321<ul class="blockList">
322<li class="blockList">
323<h4>getTotalTime</h4>
324<pre>public abstract&nbsp;double&nbsp;getTotalTime()</pre>
325<dl>
326<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
327<dd><code><a href="../../../genius/core/timeline/TimeLineInfo.html#getTotalTime--">getTotalTime</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/timeline/TimeLineInfo.html" title="interface in genius.core.timeline">TimeLineInfo</a></code></dd>
328<dt><span class="returnLabel">Returns:</span></dt>
329<dd>amount of time in seconds, or amount of rounds depending on
330 timeline type.</dd>
331</dl>
332</li>
333</ul>
334<a name="getCurrentTime--">
335<!-- -->
336</a>
337<ul class="blockList">
338<li class="blockList">
339<h4>getCurrentTime</h4>
340<pre>public abstract&nbsp;double&nbsp;getCurrentTime()</pre>
341<dl>
342<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
343<dd><code><a href="../../../genius/core/timeline/TimeLineInfo.html#getCurrentTime--">getCurrentTime</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/timeline/TimeLineInfo.html" title="interface in genius.core.timeline">TimeLineInfo</a></code></dd>
344<dt><span class="returnLabel">Returns:</span></dt>
345<dd>amount of seconds passed, or amount of rounds passed depending on
346 the timeline type.</dd>
347</dl>
348</li>
349</ul>
350<a name="isDeadlineReached--">
351<!-- -->
352</a>
353<ul class="blockList">
354<li class="blockList">
355<h4>isDeadlineReached</h4>
356<pre>public&nbsp;boolean&nbsp;isDeadlineReached()</pre>
357<dl>
358<dt><span class="returnLabel">Returns:</span></dt>
359<dd>true if deadline is reached.</dd>
360</dl>
361</li>
362</ul>
363<a name="getType--">
364<!-- -->
365</a>
366<ul class="blockList">
367<li class="blockList">
368<h4>getType</h4>
369<pre>public&nbsp;<a href="../../../genius/core/timeline/Timeline.Type.html" title="enum in genius.core.timeline">Timeline.Type</a>&nbsp;getType()</pre>
370<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../genius/core/timeline/TimeLineInfo.html#getType--">TimeLineInfo</a></code></span></div>
371<div class="block">In a time-based protocol, time passes within a round. In contrast, in a
372 rounds-based protocol time only passes when the action is presented.</div>
373<dl>
374<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
375<dd><code><a href="../../../genius/core/timeline/TimeLineInfo.html#getType--">getType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/timeline/TimeLineInfo.html" title="interface in genius.core.timeline">TimeLineInfo</a></code></dd>
376<dt><span class="returnLabel">Returns:</span></dt>
377<dd>type of time: Type.Time or Type.Rounds.</dd>
378</dl>
379</li>
380</ul>
381<a name="isPaused--">
382<!-- -->
383</a>
384<ul class="blockListLast">
385<li class="blockList">
386<h4>isPaused</h4>
387<pre>public&nbsp;boolean&nbsp;isPaused()</pre>
388<dl>
389<dt><span class="returnLabel">Returns:</span></dt>
390<dd>true if timeline is paused.</dd>
391</dl>
392</li>
393</ul>
394</li>
395</ul>
396</li>
397</ul>
398</div>
399</div>
400<!-- ========= END OF CLASS DATA ========= -->
401<!-- ======= START OF BOTTOM NAVBAR ====== -->
402<div class="bottomNav"><a name="navbar.bottom">
403<!-- -->
404</a>
405<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
406<a name="navbar.bottom.firstrow">
407<!-- -->
408</a>
409<ul class="navList" title="Navigation">
410<li><a href="../../../overview-summary.html">Overview</a></li>
411<li><a href="package-summary.html">Package</a></li>
412<li class="navBarCell1Rev">Class</li>
413<li><a href="class-use/Timeline.html">Use</a></li>
414<li><a href="package-tree.html">Tree</a></li>
415<li><a href="../../../deprecated-list.html">Deprecated</a></li>
416<li><a href="../../../index-all.html">Index</a></li>
417<li><a href="../../../help-doc.html">Help</a></li>
418</ul>
419</div>
420<div class="subNav">
421<ul class="navList">
422<li><a href="../../../genius/core/timeline/DiscreteTimeline.html" title="class in genius.core.timeline"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
423<li><a href="../../../genius/core/timeline/Timeline.Type.html" title="enum in genius.core.timeline"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
424</ul>
425<ul class="navList">
426<li><a href="../../../index.html?genius/core/timeline/Timeline.html" target="_top">Frames</a></li>
427<li><a href="Timeline.html" target="_top">No&nbsp;Frames</a></li>
428</ul>
429<ul class="navList" id="allclasses_navbar_bottom">
430<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
431</ul>
432<div>
433<script type="text/javascript"><!--
434 allClassesLink = document.getElementById("allclasses_navbar_bottom");
435 if(window==top) {
436 allClassesLink.style.display = "block";
437 }
438 else {
439 allClassesLink.style.display = "none";
440 }
441 //-->
442</script>
443</div>
444<div>
445<ul class="subNavList">
446<li>Summary:&nbsp;</li>
447<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
448<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
449<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
450<li><a href="#method.summary">Method</a></li>
451</ul>
452<ul class="subNavList">
453<li>Detail:&nbsp;</li>
454<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
455<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
456<li><a href="#method.detail">Method</a></li>
457</ul>
458</div>
459<a name="skip.navbar.bottom">
460<!-- -->
461</a></div>
462<!-- ======== END OF BOTTOM NAVBAR ======= -->
463</body>
464</html>
Note: See TracBrowser for help on using the repository browser.