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>Session (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="Session (Genius Core Documentation)";
|
---|
16 | }
|
---|
17 | }
|
---|
18 | catch(err) {
|
---|
19 | }
|
---|
20 | //-->
|
---|
21 | var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10};
|
---|
22 | var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
---|
23 | var altColor = "altColor";
|
---|
24 | var rowColor = "rowColor";
|
---|
25 | var tableTab = "tableTab";
|
---|
26 | var 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/Session.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/session/Round.html" title="class in genius.core.session"><span class="typeNameLink">Prev Class</span></a></li>
|
---|
53 | <li><a href="../../../genius/core/session/SessionConfiguration.html" title="class in genius.core.session"><span class="typeNameLink">Next Class</span></a></li>
|
---|
54 | </ul>
|
---|
55 | <ul class="navList">
|
---|
56 | <li><a href="../../../index.html?genius/core/session/Session.html" target="_top">Frames</a></li>
|
---|
57 | <li><a href="Session.html" target="_top">No Frames</a></li>
|
---|
58 | </ul>
|
---|
59 | <ul class="navList" id="allclasses_navbar_top">
|
---|
60 | <li><a href="../../../allclasses-noframe.html">All 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: </li>
|
---|
77 | <li>Nested | </li>
|
---|
78 | <li>Field | </li>
|
---|
79 | <li><a href="#constructor.summary">Constr</a> | </li>
|
---|
80 | <li><a href="#method.summary">Method</a></li>
|
---|
81 | </ul>
|
---|
82 | <ul class="subNavList">
|
---|
83 | <li>Detail: </li>
|
---|
84 | <li>Field | </li>
|
---|
85 | <li><a href="#constructor.detail">Constr</a> | </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.session</div>
|
---|
96 | <h2 title="Class Session" class="title">Class Session</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.session.Session</li>
|
---|
104 | </ul>
|
---|
105 | </li>
|
---|
106 | </ul>
|
---|
107 | <div class="description">
|
---|
108 | <ul class="blockList">
|
---|
109 | <li class="blockList">
|
---|
110 | <hr>
|
---|
111 | <br>
|
---|
112 | <pre>public class <span class="typeNameLabel">Session</span>
|
---|
113 | extends java.lang.Object</pre>
|
---|
114 | <div class="block">Stores runtime info around a session. Mainly the rounds info. A
|
---|
115 | <a href="../../../genius/core/session/Session.html" title="class in genius.core.session"><code>Session</code></a> consists of <a href="../../../genius/core/session/Round.html" title="class in genius.core.session"><code>Round</code></a>s with in turn consists of
|
---|
116 | <a href="../../../genius/core/session/Turn.html" title="class in genius.core.session"><code>Turn</code></a>. From this session object some information about the current
|
---|
117 | negotiation can be extracted. Important is the
|
---|
118 | <a href="../../../genius/core/session/Session.html#startNewRound-genius.core.session.Round-"><code>startNewRound(Round)</code></a> method which is used to add a new round
|
---|
119 | to the session. At this moment (05-08-2014) adding new rounds to the session
|
---|
120 | is the responsibility of the <a href="../../../genius/core/session/SessionManager.html" title="class in genius.core.session"><code>SessionManager</code></a>.</div>
|
---|
121 | <dl>
|
---|
122 | <dt><span class="simpleTagLabel">Author:</span></dt>
|
---|
123 | <dd>David Festen</dd>
|
---|
124 | </dl>
|
---|
125 | </li>
|
---|
126 | </ul>
|
---|
127 | </div>
|
---|
128 | <div class="summary">
|
---|
129 | <ul class="blockList">
|
---|
130 | <li class="blockList">
|
---|
131 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
---|
132 | <ul class="blockList">
|
---|
133 | <li class="blockList"><a name="constructor.summary">
|
---|
134 | <!-- -->
|
---|
135 | </a>
|
---|
136 | <h3>Constructor Summary</h3>
|
---|
137 | <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
---|
138 | <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
---|
139 | <tr>
|
---|
140 | <th class="colOne" scope="col">Constructor and Description</th>
|
---|
141 | </tr>
|
---|
142 | <tr class="altColor">
|
---|
143 | <td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#Session-genius.core.Deadline-genius.core.parties.SessionsInfo-">Session</a></span>(<a href="../../../genius/core/Deadline.html" title="class in genius.core">Deadline</a> deadlines,
|
---|
144 | <a href="../../../genius/core/parties/SessionsInfo.html" title="class in genius.core.parties">SessionsInfo</a> info)</code>
|
---|
145 | <div class="block">Create a new instance of the session object.</div>
|
---|
146 | </td>
|
---|
147 | </tr>
|
---|
148 | </table>
|
---|
149 | </li>
|
---|
150 | </ul>
|
---|
151 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
152 | <ul class="blockList">
|
---|
153 | <li class="blockList"><a name="method.summary">
|
---|
154 | <!-- -->
|
---|
155 | </a>
|
---|
156 | <h3>Method Summary</h3>
|
---|
157 | <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
---|
158 | <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
---|
159 | <tr>
|
---|
160 | <th class="colFirst" scope="col">Modifier and Type</th>
|
---|
161 | <th class="colLast" scope="col">Method and Description</th>
|
---|
162 | </tr>
|
---|
163 | <tr id="i0" class="altColor">
|
---|
164 | <td class="colFirst"><code><a href="../../../genius/core/Deadline.html" title="class in genius.core">Deadline</a></code></td>
|
---|
165 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#getDeadlines--">getDeadlines</a></span>()</code>
|
---|
166 | <div class="block">Gets the deadline constraints</div>
|
---|
167 | </td>
|
---|
168 | </tr>
|
---|
169 | <tr id="i1" class="rowColor">
|
---|
170 | <td class="colFirst"><code><a href="../../../genius/core/parties/SessionsInfo.html" title="class in genius.core.parties">SessionsInfo</a></code></td>
|
---|
171 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#getInfo--">getInfo</a></span>()</code> </td>
|
---|
172 | </tr>
|
---|
173 | <tr id="i2" class="altColor">
|
---|
174 | <td class="colFirst"><code><a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a></code></td>
|
---|
175 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#getMostRecentAction--">getMostRecentAction</a></span>()</code>
|
---|
176 | <div class="block">Get the most recently executed action.</div>
|
---|
177 | </td>
|
---|
178 | </tr>
|
---|
179 | <tr id="i3" class="rowColor">
|
---|
180 | <td class="colFirst"><code><a href="../../../genius/core/session/Round.html" title="class in genius.core.session">Round</a></code></td>
|
---|
181 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#getMostRecentRound--">getMostRecentRound</a></span>()</code>
|
---|
182 | <div class="block">Get the most recent round.</div>
|
---|
183 | </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/session/Session.html#getRoundNumber--">getRoundNumber</a></span>()</code>
|
---|
188 | <div class="block">Get the current round number.</div>
|
---|
189 | </td>
|
---|
190 | </tr>
|
---|
191 | <tr id="i5" class="rowColor">
|
---|
192 | <td class="colFirst"><code>java.util.List<<a href="../../../genius/core/session/Round.html" title="class in genius.core.session">Round</a>></code></td>
|
---|
193 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#getRounds--">getRounds</a></span>()</code>
|
---|
194 | <div class="block">Gets the rounds currently in this session.</div>
|
---|
195 | </td>
|
---|
196 | </tr>
|
---|
197 | <tr id="i6" class="altColor">
|
---|
198 | <td class="colFirst"><code>long</code></td>
|
---|
199 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#getRuntimeInNanoSeconds--">getRuntimeInNanoSeconds</a></span>()</code> </td>
|
---|
200 | </tr>
|
---|
201 | <tr id="i7" class="rowColor">
|
---|
202 | <td class="colFirst"><code>double</code></td>
|
---|
203 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#getRuntimeInSeconds--">getRuntimeInSeconds</a></span>()</code> </td>
|
---|
204 | </tr>
|
---|
205 | <tr id="i8" class="altColor">
|
---|
206 | <td class="colFirst"><code><a href="../../../genius/core/timeline/Timeline.html" title="class in genius.core.timeline">Timeline</a></code></td>
|
---|
207 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#getTimeline--">getTimeline</a></span>()</code> </td>
|
---|
208 | </tr>
|
---|
209 | <tr id="i9" class="rowColor">
|
---|
210 | <td class="colFirst"><code>int</code></td>
|
---|
211 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#getTurnNumber--">getTurnNumber</a></span>()</code>
|
---|
212 | <div class="block">Get the current turn number within the current round.</div>
|
---|
213 | </td>
|
---|
214 | </tr>
|
---|
215 | <tr id="i10" class="altColor">
|
---|
216 | <td class="colFirst"><code>boolean</code></td>
|
---|
217 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#isDeadlineReached--">isDeadlineReached</a></span>()</code>
|
---|
218 | <div class="block">Check whether one of the deadlines is reached.</div>
|
---|
219 | </td>
|
---|
220 | </tr>
|
---|
221 | <tr id="i11" class="rowColor">
|
---|
222 | <td class="colFirst"><code>boolean</code></td>
|
---|
223 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#isFirstRound--">isFirstRound</a></span>()</code>
|
---|
224 | <div class="block">Check whether this is the first round (round 1).</div>
|
---|
225 | </td>
|
---|
226 | </tr>
|
---|
227 | <tr id="i12" class="altColor">
|
---|
228 | <td class="colFirst"><code>boolean</code></td>
|
---|
229 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#isTimerRunning--">isTimerRunning</a></span>()</code> </td>
|
---|
230 | </tr>
|
---|
231 | <tr id="i13" class="rowColor">
|
---|
232 | <td class="colFirst"><code>void</code></td>
|
---|
233 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#removeLastRound--">removeLastRound</a></span>()</code>
|
---|
234 | <div class="block">Removes the last (supposedly incomplete) round, if there is a last round</div>
|
---|
235 | </td>
|
---|
236 | </tr>
|
---|
237 | <tr id="i14" class="altColor">
|
---|
238 | <td class="colFirst"><code>void</code></td>
|
---|
239 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#setRuntimeInNanoSeconds-long-">setRuntimeInNanoSeconds</a></span>(long nanoSeconds)</code> </td>
|
---|
240 | </tr>
|
---|
241 | <tr id="i15" class="rowColor">
|
---|
242 | <td class="colFirst"><code>void</code></td>
|
---|
243 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#setRuntimeInSeconds-double-">setRuntimeInSeconds</a></span>(double seconds)</code> </td>
|
---|
244 | </tr>
|
---|
245 | <tr id="i16" class="altColor">
|
---|
246 | <td class="colFirst"><code>void</code></td>
|
---|
247 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#setTimeline-genius.core.timeline.Timeline-">setTimeline</a></span>(<a href="../../../genius/core/timeline/Timeline.html" title="class in genius.core.timeline">Timeline</a> timeline)</code> </td>
|
---|
248 | </tr>
|
---|
249 | <tr id="i17" class="rowColor">
|
---|
250 | <td class="colFirst"><code>void</code></td>
|
---|
251 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#startNewRound-genius.core.session.Round-">startNewRound</a></span>(<a href="../../../genius/core/session/Round.html" title="class in genius.core.session">Round</a> round)</code>
|
---|
252 | <div class="block">Add a round to this session.</div>
|
---|
253 | </td>
|
---|
254 | </tr>
|
---|
255 | <tr id="i18" class="altColor">
|
---|
256 | <td class="colFirst"><code>void</code></td>
|
---|
257 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#startTimer--">startTimer</a></span>()</code>
|
---|
258 | <div class="block">Updates the timestamp of this <a href="../../../genius/core/session/Session.html" title="class in genius.core.session"><code>Session</code></a>.</div>
|
---|
259 | </td>
|
---|
260 | </tr>
|
---|
261 | <tr id="i19" class="rowColor">
|
---|
262 | <td class="colFirst"><code>void</code></td>
|
---|
263 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/Session.html#stopTimer--">stopTimer</a></span>()</code>
|
---|
264 | <div class="block">Updates the timestamp of this <a href="../../../genius/core/session/Session.html" title="class in genius.core.session"><code>Session</code></a>.</div>
|
---|
265 | </td>
|
---|
266 | </tr>
|
---|
267 | </table>
|
---|
268 | <ul class="blockList">
|
---|
269 | <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
---|
270 | <!-- -->
|
---|
271 | </a>
|
---|
272 | <h3>Methods inherited from class java.lang.Object</h3>
|
---|
273 | <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
---|
274 | </ul>
|
---|
275 | </li>
|
---|
276 | </ul>
|
---|
277 | </li>
|
---|
278 | </ul>
|
---|
279 | </div>
|
---|
280 | <div class="details">
|
---|
281 | <ul class="blockList">
|
---|
282 | <li class="blockList">
|
---|
283 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
284 | <ul class="blockList">
|
---|
285 | <li class="blockList"><a name="constructor.detail">
|
---|
286 | <!-- -->
|
---|
287 | </a>
|
---|
288 | <h3>Constructor Detail</h3>
|
---|
289 | <a name="Session-genius.core.Deadline-genius.core.parties.SessionsInfo-">
|
---|
290 | <!-- -->
|
---|
291 | </a>
|
---|
292 | <ul class="blockListLast">
|
---|
293 | <li class="blockList">
|
---|
294 | <h4>Session</h4>
|
---|
295 | <pre>public Session(<a href="../../../genius/core/Deadline.html" title="class in genius.core">Deadline</a> deadlines,
|
---|
296 | <a href="../../../genius/core/parties/SessionsInfo.html" title="class in genius.core.parties">SessionsInfo</a> info)</pre>
|
---|
297 | <div class="block">Create a new instance of the session object. This should normally only
|
---|
298 | happen once every session. See also the class documentation of
|
---|
299 | <a href="../../../genius/core/session/Session.html" title="class in genius.core.session"><code>Session</code></a>. This also creates a timeline that starts running the
|
---|
300 | moment Session is created.</div>
|
---|
301 | <dl>
|
---|
302 | <dt><span class="paramLabel">Parameters:</span></dt>
|
---|
303 | <dd><code>deadlines</code> - Map of deadline constraints</dd>
|
---|
304 | <dd><code>info</code> - the global <a href="../../../genius/core/parties/SessionsInfo.html" title="class in genius.core.parties"><code>SessionsInfo</code></a></dd>
|
---|
305 | </dl>
|
---|
306 | </li>
|
---|
307 | </ul>
|
---|
308 | </li>
|
---|
309 | </ul>
|
---|
310 | <!-- ============ METHOD DETAIL ========== -->
|
---|
311 | <ul class="blockList">
|
---|
312 | <li class="blockList"><a name="method.detail">
|
---|
313 | <!-- -->
|
---|
314 | </a>
|
---|
315 | <h3>Method Detail</h3>
|
---|
316 | <a name="getDeadlines--">
|
---|
317 | <!-- -->
|
---|
318 | </a>
|
---|
319 | <ul class="blockList">
|
---|
320 | <li class="blockList">
|
---|
321 | <h4>getDeadlines</h4>
|
---|
322 | <pre>public <a href="../../../genius/core/Deadline.html" title="class in genius.core">Deadline</a> getDeadlines()</pre>
|
---|
323 | <div class="block">Gets the deadline constraints</div>
|
---|
324 | <dl>
|
---|
325 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
326 | <dd>a map of deadline types and values</dd>
|
---|
327 | </dl>
|
---|
328 | </li>
|
---|
329 | </ul>
|
---|
330 | <a name="startTimer--">
|
---|
331 | <!-- -->
|
---|
332 | </a>
|
---|
333 | <ul class="blockList">
|
---|
334 | <li class="blockList">
|
---|
335 | <h4>startTimer</h4>
|
---|
336 | <pre>public void startTimer()</pre>
|
---|
337 | <div class="block">Updates the timestamp of this <a href="../../../genius/core/session/Session.html" title="class in genius.core.session"><code>Session</code></a>. Use just before starting
|
---|
338 | the negotiation for most accurate timing. Timing is used in for example
|
---|
339 | time deadline constraints. But might also be used in log messages as well
|
---|
340 | as statistics.</div>
|
---|
341 | </li>
|
---|
342 | </ul>
|
---|
343 | <a name="stopTimer--">
|
---|
344 | <!-- -->
|
---|
345 | </a>
|
---|
346 | <ul class="blockList">
|
---|
347 | <li class="blockList">
|
---|
348 | <h4>stopTimer</h4>
|
---|
349 | <pre>public void stopTimer()</pre>
|
---|
350 | <div class="block">Updates the timestamp of this <a href="../../../genius/core/session/Session.html" title="class in genius.core.session"><code>Session</code></a>. Use just after finish the
|
---|
351 | negotiation for most accurate timing. Timing is used in for example time
|
---|
352 | deadline constraints. But might also be used in log messages as well as
|
---|
353 | statistics. If you need to manually set it, consider using the
|
---|
354 | <a href="../../../genius/core/session/Session.html#setRuntimeInNanoSeconds-long-"><code>setRuntimeInNanoSeconds(long)</code></a> function.</div>
|
---|
355 | </li>
|
---|
356 | </ul>
|
---|
357 | <a name="getRounds--">
|
---|
358 | <!-- -->
|
---|
359 | </a>
|
---|
360 | <ul class="blockList">
|
---|
361 | <li class="blockList">
|
---|
362 | <h4>getRounds</h4>
|
---|
363 | <pre>public java.util.List<<a href="../../../genius/core/session/Round.html" title="class in genius.core.session">Round</a>> getRounds()</pre>
|
---|
364 | <div class="block">Gets the rounds currently in this session. When
|
---|
365 | <a href="../../../genius/core/session/Session.html#startNewRound-genius.core.session.Round-"><code>startNewRound(Round)</code></a> is called a new round will be added. Each
|
---|
366 | round already includes all its <a href="../../../genius/core/session/Turn.html" title="class in genius.core.session"><code>Turn</code></a>s, but some turns might not
|
---|
367 | yet been done.</div>
|
---|
368 | <dl>
|
---|
369 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
370 | <dd>list of rounds. Can be empty.</dd>
|
---|
371 | </dl>
|
---|
372 | </li>
|
---|
373 | </ul>
|
---|
374 | <a name="getMostRecentRound--">
|
---|
375 | <!-- -->
|
---|
376 | </a>
|
---|
377 | <ul class="blockList">
|
---|
378 | <li class="blockList">
|
---|
379 | <h4>getMostRecentRound</h4>
|
---|
380 | <pre>public <a href="../../../genius/core/session/Round.html" title="class in genius.core.session">Round</a> getMostRecentRound()</pre>
|
---|
381 | <div class="block">Get the most recent round.</div>
|
---|
382 | <dl>
|
---|
383 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
384 | <dd>The last round of the <a href="../../../genius/core/session/Session.html#getRounds--"><code>getRounds()</code></a> method, or null if no
|
---|
385 | round has been done yet.</dd>
|
---|
386 | </dl>
|
---|
387 | </li>
|
---|
388 | </ul>
|
---|
389 | <a name="startNewRound-genius.core.session.Round-">
|
---|
390 | <!-- -->
|
---|
391 | </a>
|
---|
392 | <ul class="blockList">
|
---|
393 | <li class="blockList">
|
---|
394 | <h4>startNewRound</h4>
|
---|
395 | <pre>public void startNewRound(<a href="../../../genius/core/session/Round.html" title="class in genius.core.session">Round</a> round)</pre>
|
---|
396 | <div class="block">Add a round to this session. Make sure it contains all the turns
|
---|
397 | necessary to execute the rounds. Normally the new round will be created
|
---|
398 | by using
|
---|
399 | <a href="../../../genius/core/protocol/MultilateralProtocol.html#getRoundStructure-java.util.List-genius.core.session.Session-"><code>MultilateralProtocol.getRoundStructure(java.util.List, Session)</code></a></div>
|
---|
400 | <dl>
|
---|
401 | <dt><span class="paramLabel">Parameters:</span></dt>
|
---|
402 | <dd><code>round</code> - The round to add to this session.</dd>
|
---|
403 | </dl>
|
---|
404 | </li>
|
---|
405 | </ul>
|
---|
406 | <a name="getRoundNumber--">
|
---|
407 | <!-- -->
|
---|
408 | </a>
|
---|
409 | <ul class="blockList">
|
---|
410 | <li class="blockList">
|
---|
411 | <h4>getRoundNumber</h4>
|
---|
412 | <pre>public int getRoundNumber()</pre>
|
---|
413 | <div class="block">Get the current round number. one-based (meaning first round is round 1)</div>
|
---|
414 | <dl>
|
---|
415 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
416 | <dd>Integer representing the round number</dd>
|
---|
417 | </dl>
|
---|
418 | </li>
|
---|
419 | </ul>
|
---|
420 | <a name="getTurnNumber--">
|
---|
421 | <!-- -->
|
---|
422 | </a>
|
---|
423 | <ul class="blockList">
|
---|
424 | <li class="blockList">
|
---|
425 | <h4>getTurnNumber</h4>
|
---|
426 | <pre>public int getTurnNumber()</pre>
|
---|
427 | <div class="block">Get the current turn number within the current round.</div>
|
---|
428 | <dl>
|
---|
429 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
430 | <dd>current turn within the round. 0 if no actions have been done yet
|
---|
431 | or if we are not even in a round.</dd>
|
---|
432 | </dl>
|
---|
433 | </li>
|
---|
434 | </ul>
|
---|
435 | <a name="isFirstRound--">
|
---|
436 | <!-- -->
|
---|
437 | </a>
|
---|
438 | <ul class="blockList">
|
---|
439 | <li class="blockList">
|
---|
440 | <h4>isFirstRound</h4>
|
---|
441 | <pre>public boolean isFirstRound()</pre>
|
---|
442 | <div class="block">Check whether this is the first round (round 1).</div>
|
---|
443 | <dl>
|
---|
444 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
445 | <dd>true if <a href="../../../genius/core/session/Session.html#getRoundNumber--"><code>getRoundNumber()</code></a> equals 1</dd>
|
---|
446 | </dl>
|
---|
447 | </li>
|
---|
448 | </ul>
|
---|
449 | <a name="removeLastRound--">
|
---|
450 | <!-- -->
|
---|
451 | </a>
|
---|
452 | <ul class="blockList">
|
---|
453 | <li class="blockList">
|
---|
454 | <h4>removeLastRound</h4>
|
---|
455 | <pre>public void removeLastRound()</pre>
|
---|
456 | <div class="block">Removes the last (supposedly incomplete) round, if there is a last round</div>
|
---|
457 | </li>
|
---|
458 | </ul>
|
---|
459 | <a name="getMostRecentAction--">
|
---|
460 | <!-- -->
|
---|
461 | </a>
|
---|
462 | <ul class="blockList">
|
---|
463 | <li class="blockList">
|
---|
464 | <h4>getMostRecentAction</h4>
|
---|
465 | <pre>public <a href="../../../genius/core/actions/Action.html" title="interface in genius.core.actions">Action</a> getMostRecentAction()</pre>
|
---|
466 | <div class="block">Get the most recently executed action.</div>
|
---|
467 | <dl>
|
---|
468 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
469 | <dd>The most recent action of the most recent round. Null if no
|
---|
470 | action has been done yet.</dd>
|
---|
471 | </dl>
|
---|
472 | </li>
|
---|
473 | </ul>
|
---|
474 | <a name="isDeadlineReached--">
|
---|
475 | <!-- -->
|
---|
476 | </a>
|
---|
477 | <ul class="blockList">
|
---|
478 | <li class="blockList">
|
---|
479 | <h4>isDeadlineReached</h4>
|
---|
480 | <pre>public boolean isDeadlineReached()</pre>
|
---|
481 | <div class="block">Check whether one of the deadlines is reached.</div>
|
---|
482 | <dl>
|
---|
483 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
484 | <dd>true iff the deadline is reached. True if the runtime/round
|
---|
485 | number is bigger than the actual deadline.</dd>
|
---|
486 | </dl>
|
---|
487 | </li>
|
---|
488 | </ul>
|
---|
489 | <a name="getRuntimeInNanoSeconds--">
|
---|
490 | <!-- -->
|
---|
491 | </a>
|
---|
492 | <ul class="blockList">
|
---|
493 | <li class="blockList">
|
---|
494 | <h4>getRuntimeInNanoSeconds</h4>
|
---|
495 | <pre>public long getRuntimeInNanoSeconds()</pre>
|
---|
496 | </li>
|
---|
497 | </ul>
|
---|
498 | <a name="getRuntimeInSeconds--">
|
---|
499 | <!-- -->
|
---|
500 | </a>
|
---|
501 | <ul class="blockList">
|
---|
502 | <li class="blockList">
|
---|
503 | <h4>getRuntimeInSeconds</h4>
|
---|
504 | <pre>public double getRuntimeInSeconds()</pre>
|
---|
505 | </li>
|
---|
506 | </ul>
|
---|
507 | <a name="setRuntimeInNanoSeconds-long-">
|
---|
508 | <!-- -->
|
---|
509 | </a>
|
---|
510 | <ul class="blockList">
|
---|
511 | <li class="blockList">
|
---|
512 | <h4>setRuntimeInNanoSeconds</h4>
|
---|
513 | <pre>public void setRuntimeInNanoSeconds(long nanoSeconds)</pre>
|
---|
514 | </li>
|
---|
515 | </ul>
|
---|
516 | <a name="setRuntimeInSeconds-double-">
|
---|
517 | <!-- -->
|
---|
518 | </a>
|
---|
519 | <ul class="blockList">
|
---|
520 | <li class="blockList">
|
---|
521 | <h4>setRuntimeInSeconds</h4>
|
---|
522 | <pre>public void setRuntimeInSeconds(double seconds)</pre>
|
---|
523 | </li>
|
---|
524 | </ul>
|
---|
525 | <a name="isTimerRunning--">
|
---|
526 | <!-- -->
|
---|
527 | </a>
|
---|
528 | <ul class="blockList">
|
---|
529 | <li class="blockList">
|
---|
530 | <h4>isTimerRunning</h4>
|
---|
531 | <pre>public boolean isTimerRunning()</pre>
|
---|
532 | </li>
|
---|
533 | </ul>
|
---|
534 | <a name="getTimeline--">
|
---|
535 | <!-- -->
|
---|
536 | </a>
|
---|
537 | <ul class="blockList">
|
---|
538 | <li class="blockList">
|
---|
539 | <h4>getTimeline</h4>
|
---|
540 | <pre>public <a href="../../../genius/core/timeline/Timeline.html" title="class in genius.core.timeline">Timeline</a> getTimeline()</pre>
|
---|
541 | </li>
|
---|
542 | </ul>
|
---|
543 | <a name="setTimeline-genius.core.timeline.Timeline-">
|
---|
544 | <!-- -->
|
---|
545 | </a>
|
---|
546 | <ul class="blockList">
|
---|
547 | <li class="blockList">
|
---|
548 | <h4>setTimeline</h4>
|
---|
549 | <pre>public void setTimeline(<a href="../../../genius/core/timeline/Timeline.html" title="class in genius.core.timeline">Timeline</a> timeline)</pre>
|
---|
550 | </li>
|
---|
551 | </ul>
|
---|
552 | <a name="getInfo--">
|
---|
553 | <!-- -->
|
---|
554 | </a>
|
---|
555 | <ul class="blockListLast">
|
---|
556 | <li class="blockList">
|
---|
557 | <h4>getInfo</h4>
|
---|
558 | <pre>public <a href="../../../genius/core/parties/SessionsInfo.html" title="class in genius.core.parties">SessionsInfo</a> getInfo()</pre>
|
---|
559 | <dl>
|
---|
560 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
561 | <dd>SessionsInfo containing all information that is fixed for all
|
---|
562 | sessions in the tournament/negotiation</dd>
|
---|
563 | </dl>
|
---|
564 | </li>
|
---|
565 | </ul>
|
---|
566 | </li>
|
---|
567 | </ul>
|
---|
568 | </li>
|
---|
569 | </ul>
|
---|
570 | </div>
|
---|
571 | </div>
|
---|
572 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
573 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
574 | <div class="bottomNav"><a name="navbar.bottom">
|
---|
575 | <!-- -->
|
---|
576 | </a>
|
---|
577 | <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
---|
578 | <a name="navbar.bottom.firstrow">
|
---|
579 | <!-- -->
|
---|
580 | </a>
|
---|
581 | <ul class="navList" title="Navigation">
|
---|
582 | <li><a href="../../../overview-summary.html">Overview</a></li>
|
---|
583 | <li><a href="package-summary.html">Package</a></li>
|
---|
584 | <li class="navBarCell1Rev">Class</li>
|
---|
585 | <li><a href="class-use/Session.html">Use</a></li>
|
---|
586 | <li><a href="package-tree.html">Tree</a></li>
|
---|
587 | <li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
---|
588 | <li><a href="../../../index-all.html">Index</a></li>
|
---|
589 | <li><a href="../../../help-doc.html">Help</a></li>
|
---|
590 | </ul>
|
---|
591 | </div>
|
---|
592 | <div class="subNav">
|
---|
593 | <ul class="navList">
|
---|
594 | <li><a href="../../../genius/core/session/Round.html" title="class in genius.core.session"><span class="typeNameLink">Prev Class</span></a></li>
|
---|
595 | <li><a href="../../../genius/core/session/SessionConfiguration.html" title="class in genius.core.session"><span class="typeNameLink">Next Class</span></a></li>
|
---|
596 | </ul>
|
---|
597 | <ul class="navList">
|
---|
598 | <li><a href="../../../index.html?genius/core/session/Session.html" target="_top">Frames</a></li>
|
---|
599 | <li><a href="Session.html" target="_top">No Frames</a></li>
|
---|
600 | </ul>
|
---|
601 | <ul class="navList" id="allclasses_navbar_bottom">
|
---|
602 | <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
---|
603 | </ul>
|
---|
604 | <div>
|
---|
605 | <script type="text/javascript"><!--
|
---|
606 | allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
---|
607 | if(window==top) {
|
---|
608 | allClassesLink.style.display = "block";
|
---|
609 | }
|
---|
610 | else {
|
---|
611 | allClassesLink.style.display = "none";
|
---|
612 | }
|
---|
613 | //-->
|
---|
614 | </script>
|
---|
615 | </div>
|
---|
616 | <div>
|
---|
617 | <ul class="subNavList">
|
---|
618 | <li>Summary: </li>
|
---|
619 | <li>Nested | </li>
|
---|
620 | <li>Field | </li>
|
---|
621 | <li><a href="#constructor.summary">Constr</a> | </li>
|
---|
622 | <li><a href="#method.summary">Method</a></li>
|
---|
623 | </ul>
|
---|
624 | <ul class="subNavList">
|
---|
625 | <li>Detail: </li>
|
---|
626 | <li>Field | </li>
|
---|
627 | <li><a href="#constructor.detail">Constr</a> | </li>
|
---|
628 | <li><a href="#method.detail">Method</a></li>
|
---|
629 | </ul>
|
---|
630 | </div>
|
---|
631 | <a name="skip.navbar.bottom">
|
---|
632 | <!-- -->
|
---|
633 | </a></div>
|
---|
634 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
635 | </body>
|
---|
636 | </html>
|
---|