source: javadoc/genius/core/timeline/TimeLineInfo.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: 10.2 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>TimeLineInfo (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="TimeLineInfo (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/TimeLineInfo.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/Timeline.Type.html" title="enum in genius.core.timeline"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li>Next&nbsp;Class</li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/timeline/TimeLineInfo.html" target="_top">Frames</a></li>
57<li><a href="TimeLineInfo.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>Constr&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>Constr&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="Interface TimeLineInfo" class="title">Interface TimeLineInfo</h2>
97</div>
98<div class="contentContainer">
99<div class="description">
100<ul class="blockList">
101<li class="blockList">
102<dl>
103<dt>All Superinterfaces:</dt>
104<dd>java.io.Serializable</dd>
105</dl>
106<dl>
107<dt>All Known Implementing Classes:</dt>
108<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>, <a href="../../../genius/core/PausableContinuousTimeline.html" title="class in genius.core">PausableContinuousTimeline</a>, <a href="../../../genius/core/timeline/Timeline.html" title="class in genius.core.timeline">Timeline</a></dd>
109</dl>
110<hr>
111<br>
112<pre>public interface <span class="typeNameLabel">TimeLineInfo</span>
113extends java.io.Serializable</pre>
114<div class="block">read-only access to the actual timeline information. The returned information
115 should be up to date at all times and automatically updated.</div>
116<dl>
117<dt><span class="simpleTagLabel">Author:</span></dt>
118<dd>W.Pasman</dd>
119</dl>
120</li>
121</ul>
122</div>
123<div class="summary">
124<ul class="blockList">
125<li class="blockList">
126<!-- ========== METHOD SUMMARY =========== -->
127<ul class="blockList">
128<li class="blockList"><a name="method.summary">
129<!-- -->
130</a>
131<h3>Method Summary</h3>
132<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
133<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></caption>
134<tr>
135<th class="colFirst" scope="col">Modifier and Type</th>
136<th class="colLast" scope="col">Method and Description</th>
137</tr>
138<tr id="i0" class="altColor">
139<td class="colFirst"><code>double</code></td>
140<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/timeline/TimeLineInfo.html#getCurrentTime--">getCurrentTime</a></span>()</code>&nbsp;</td>
141</tr>
142<tr id="i1" class="rowColor">
143<td class="colFirst"><code>double</code></td>
144<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/timeline/TimeLineInfo.html#getTime--">getTime</a></span>()</code>
145<div class="block">Gets the time, running from t = 0 (start) to t = 1 (deadline).</div>
146</td>
147</tr>
148<tr id="i2" class="altColor">
149<td class="colFirst"><code>double</code></td>
150<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/timeline/TimeLineInfo.html#getTotalTime--">getTotalTime</a></span>()</code>&nbsp;</td>
151</tr>
152<tr id="i3" class="rowColor">
153<td class="colFirst"><code><a href="../../../genius/core/timeline/Timeline.Type.html" title="enum in genius.core.timeline">Timeline.Type</a></code></td>
154<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/timeline/TimeLineInfo.html#getType--">getType</a></span>()</code>
155<div class="block">In a time-based protocol, time passes within a round.</div>
156</td>
157</tr>
158</table>
159</li>
160</ul>
161</li>
162</ul>
163</div>
164<div class="details">
165<ul class="blockList">
166<li class="blockList">
167<!-- ============ METHOD DETAIL ========== -->
168<ul class="blockList">
169<li class="blockList"><a name="method.detail">
170<!-- -->
171</a>
172<h3>Method Detail</h3>
173<a name="getType--">
174<!-- -->
175</a>
176<ul class="blockList">
177<li class="blockList">
178<h4>getType</h4>
179<pre><a href="../../../genius/core/timeline/Timeline.Type.html" title="enum in genius.core.timeline">Timeline.Type</a>&nbsp;getType()</pre>
180<div class="block">In a time-based protocol, time passes within a round. In contrast, in a
181 rounds-based protocol time only passes when the action is presented.</div>
182</li>
183</ul>
184<a name="getTime--">
185<!-- -->
186</a>
187<ul class="blockList">
188<li class="blockList">
189<h4>getTime</h4>
190<pre>double&nbsp;getTime()</pre>
191<div class="block">Gets the time, running from t = 0 (start) to t = 1 (deadline). The time
192 is normalized, so agents need not be concerned with the actual internal
193 clock.</div>
194<dl>
195<dt><span class="returnLabel">Returns:</span></dt>
196<dd>current time in the interval [0, 1].</dd>
197</dl>
198</li>
199</ul>
200<a name="getTotalTime--">
201<!-- -->
202</a>
203<ul class="blockList">
204<li class="blockList">
205<h4>getTotalTime</h4>
206<pre>double&nbsp;getTotalTime()</pre>
207<dl>
208<dt><span class="returnLabel">Returns:</span></dt>
209<dd>amount of time in seconds, or amount of rounds depending on
210 timeline type.</dd>
211</dl>
212</li>
213</ul>
214<a name="getCurrentTime--">
215<!-- -->
216</a>
217<ul class="blockListLast">
218<li class="blockList">
219<h4>getCurrentTime</h4>
220<pre>double&nbsp;getCurrentTime()</pre>
221<dl>
222<dt><span class="returnLabel">Returns:</span></dt>
223<dd>amount of seconds passed, or amount of rounds passed depending on
224 the timeline type.</dd>
225</dl>
226</li>
227</ul>
228</li>
229</ul>
230</li>
231</ul>
232</div>
233</div>
234<!-- ========= END OF CLASS DATA ========= -->
235<!-- ======= START OF BOTTOM NAVBAR ====== -->
236<div class="bottomNav"><a name="navbar.bottom">
237<!-- -->
238</a>
239<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
240<a name="navbar.bottom.firstrow">
241<!-- -->
242</a>
243<ul class="navList" title="Navigation">
244<li><a href="../../../overview-summary.html">Overview</a></li>
245<li><a href="package-summary.html">Package</a></li>
246<li class="navBarCell1Rev">Class</li>
247<li><a href="class-use/TimeLineInfo.html">Use</a></li>
248<li><a href="package-tree.html">Tree</a></li>
249<li><a href="../../../deprecated-list.html">Deprecated</a></li>
250<li><a href="../../../index-all.html">Index</a></li>
251<li><a href="../../../help-doc.html">Help</a></li>
252</ul>
253</div>
254<div class="subNav">
255<ul class="navList">
256<li><a href="../../../genius/core/timeline/Timeline.Type.html" title="enum in genius.core.timeline"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
257<li>Next&nbsp;Class</li>
258</ul>
259<ul class="navList">
260<li><a href="../../../index.html?genius/core/timeline/TimeLineInfo.html" target="_top">Frames</a></li>
261<li><a href="TimeLineInfo.html" target="_top">No&nbsp;Frames</a></li>
262</ul>
263<ul class="navList" id="allclasses_navbar_bottom">
264<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
265</ul>
266<div>
267<script type="text/javascript"><!--
268 allClassesLink = document.getElementById("allclasses_navbar_bottom");
269 if(window==top) {
270 allClassesLink.style.display = "block";
271 }
272 else {
273 allClassesLink.style.display = "none";
274 }
275 //-->
276</script>
277</div>
278<div>
279<ul class="subNavList">
280<li>Summary:&nbsp;</li>
281<li>Nested&nbsp;|&nbsp;</li>
282<li>Field&nbsp;|&nbsp;</li>
283<li>Constr&nbsp;|&nbsp;</li>
284<li><a href="#method.summary">Method</a></li>
285</ul>
286<ul class="subNavList">
287<li>Detail:&nbsp;</li>
288<li>Field&nbsp;|&nbsp;</li>
289<li>Constr&nbsp;|&nbsp;</li>
290<li><a href="#method.detail">Method</a></li>
291</ul>
292</div>
293<a name="skip.navbar.bottom">
294<!-- -->
295</a></div>
296<!-- ======== END OF BOTTOM NAVBAR ======= -->
297</body>
298</html>
Note: See TracBrowser for help on using the repository browser.