1 <!-- This comment will put IE 6, 7 and 8 in quirks mode -->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <title>Chess Clock: TurnInformation Class Reference</title>
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="search/search.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javaScript" src="search/search.js"></script>
10 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
12 <body onload='searchBox.OnSelectItem(0);'>
13 <!-- Generated by Doxygen 1.6.3 -->
14 <script type="text/javascript"><!--
15 var searchBox = new SearchBox("searchBox", "search",false,'Search');
17 <div class="navigation" id="top">
20 <li><a href="index.html"><span>Main Page</span></a></li>
21 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
22 <li><a href="files.html"><span>Files</span></a></li>
24 <div id="MSearchBox" class="MSearchBoxInactive">
25 <img id="MSearchSelect" src="search/search.png"
26 onmouseover="return searchBox.OnSearchSelectShow()"
27 onmouseout="return searchBox.OnSearchSelectHide()"
29 <input type="text" id="MSearchField" value="Search" accesskey="S"
30 onfocus="searchBox.OnSearchFieldFocus(true)"
31 onblur="searchBox.OnSearchFieldFocus(false)"
32 onkeyup="searchBox.OnSearchFieldChange(event)"/>
33 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
40 <li><a href="annotated.html"><span>Class List</span></a></li>
41 <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
42 <li><a href="functions.html"><span>Class Members</span></a></li>
46 <div class="contents">
47 <h1>TurnInformation Class Reference</h1><!-- doxytag: class="TurnInformation" -->
48 <p>Turn information class.
49 <a href="#_details">More...</a></p>
51 <p><code>#include <<a class="el" href="turninformation_8h_source.html">turninformation.h</a>></code></p>
53 <p><a href="class_turn_information-members.html">List of all members.</a></p>
54 <table border="0" cellpadding="0" cellspacing="0">
55 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
56 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#a0126f181e93c7fa7b6d53b46be79247d">TurnInformation</a> (int turnId, bool white)</td></tr>
57 <tr><td class="mdescLeft"> </td><td class="mdescRight">Turn information object. <a href="#a0126f181e93c7fa7b6d53b46be79247d"></a><br/></td></tr>
58 <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#ad9802d9ccc6849b3bc1aedf87d2f0926">getTurnId</a> () const </td></tr>
59 <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#a04e622dacea74dbc558b1a4260bff9a6">getDuration</a> () const </td></tr>
60 <tr><td class="mdescLeft"> </td><td class="mdescRight">Duration of turn. <a href="#a04e622dacea74dbc558b1a4260bff9a6"></a><br/></td></tr>
61 <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#ae2d37b598c7fb0fb5882e44559f662cb">getPaused</a> () const </td></tr>
62 <tr><td class="mdescLeft"> </td><td class="mdescRight">Duration of pauses during this turn. <a href="#ae2d37b598c7fb0fb5882e44559f662cb"></a><br/></td></tr>
63 <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#acca895a029b03caa72115aed776e3070">getTimeAfter</a> () const </td></tr>
64 <tr><td class="mdescLeft"> </td><td class="mdescRight">Time available for this player after this turn. <a href="#acca895a029b03caa72115aed776e3070"></a><br/></td></tr>
65 <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#adfe335e110744566aee521c4784f08a0">isWhiteTurn</a> () const </td></tr>
66 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#a355359f883ab74e549b5e439ea7e827e">addTime</a> (int msecs)</td></tr>
67 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#ab8d3aa0183f400b64b217d39e920bb69">addPause</a> (int msecs)</td></tr>
68 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#a8820646aa51dd407d909fa08b55d52c5">turnReady</a> (int msecs)</td></tr>
69 <tr><td class="mdescLeft"> </td><td class="mdescRight">Mark turn ready. <a href="#a8820646aa51dd407d909fa08b55d52c5"></a><br/></td></tr>
70 <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
71 <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#a77d4475ceb0b529835ffe09cb3974cfa">turnId_</a></td></tr>
72 <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#a659fbb28b8b241ce857c93e99c6c0005">duration_</a></td></tr>
73 <tr><td class="mdescLeft"> </td><td class="mdescRight">id of turn <a href="#a659fbb28b8b241ce857c93e99c6c0005"></a><br/></td></tr>
74 <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#a045f9d3fb6faea111cb6bc1e798ca40d">paused_</a></td></tr>
75 <tr><td class="mdescLeft"> </td><td class="mdescRight">duration of turn in msecs <a href="#a045f9d3fb6faea111cb6bc1e798ca40d"></a><br/></td></tr>
76 <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#a5516d055dd81c55b75567247b8293cde">timeAfter_</a></td></tr>
77 <tr><td class="mdescLeft"> </td><td class="mdescRight">duration of pauses in msecs <a href="#a5516d055dd81c55b75567247b8293cde"></a><br/></td></tr>
78 <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#a8e0a6eb69455755152da7705e46e1f48">turnReady_</a></td></tr>
79 <tr><td class="mdescLeft"> </td><td class="mdescRight">time available after this turn in msecs <a href="#a8e0a6eb69455755152da7705e46e1f48"></a><br/></td></tr>
80 <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_turn_information.html#a884138dea5d094e2772ee2d87e2cdbe4">white_</a></td></tr>
81 <tr><td class="mdescLeft"> </td><td class="mdescRight">turn is ready and locked <a href="#a884138dea5d094e2772ee2d87e2cdbe4"></a><br/></td></tr>
83 <hr/><a name="_details"></a><h2>Detailed Description</h2>
84 <p>Turn information class. </p>
85 <dl class="author"><dt><b>Author:</b></dt><dd>Arto Hyvättinen </dd></dl>
86 <dl class="date"><dt><b>Date:</b></dt><dd>2010-08-13</dd></dl>
87 <p>Store information about one turn of player </p>
89 <p>Definition at line <a class="el" href="turninformation_8h_source.html#l00034">34</a> of file <a class="el" href="turninformation_8h_source.html">turninformation.h</a>.</p>
90 <hr/><h2>Constructor & Destructor Documentation</h2>
91 <a class="anchor" id="a0126f181e93c7fa7b6d53b46be79247d"></a><!-- doxytag: member="TurnInformation::TurnInformation" ref="a0126f181e93c7fa7b6d53b46be79247d" args="(int turnId, bool white)" -->
93 <div class="memproto">
94 <table class="memname">
96 <td class="memname">TurnInformation::TurnInformation </td>
98 <td class="paramtype">int </td>
99 <td class="paramname"> <em>turnId</em>, </td>
102 <td class="paramkey"></td>
104 <td class="paramtype">bool </td>
105 <td class="paramname"> <em>white</em></td><td> </td>
110 <td></td><td></td><td></td>
116 <p>Turn information object. </p>
117 <dl><dt><b>Parameters:</b></dt><dd>
118 <table border="0" cellspacing="2" cellpadding="0">
119 <tr><td valign="top"></td><td valign="top"><em>turnId</em> </td><td>Id of turn of player </td></tr>
120 <tr><td valign="top"></td><td valign="top"><em>white</em> </td><td>true if turn on white, false id black </td></tr>
125 <p>Definition at line <a class="el" href="turninformation_8cpp_source.html#l00024">24</a> of file <a class="el" href="turninformation_8cpp_source.html">turninformation.cpp</a>.</p>
129 <hr/><h2>Member Function Documentation</h2>
130 <a class="anchor" id="ab8d3aa0183f400b64b217d39e920bb69"></a><!-- doxytag: member="TurnInformation::addPause" ref="ab8d3aa0183f400b64b217d39e920bb69" args="(int msecs)" -->
131 <div class="memitem">
132 <div class="memproto">
133 <table class="memname">
135 <td class="memname">void TurnInformation::addPause </td>
137 <td class="paramtype">int </td>
138 <td class="paramname"> <em>msecs</em></td>
139 <td> ) </td>
146 <p>Definition at line <a class="el" href="turninformation_8cpp_source.html#l00040">40</a> of file <a class="el" href="turninformation_8cpp_source.html">turninformation.cpp</a>.</p>
150 <a class="anchor" id="a355359f883ab74e549b5e439ea7e827e"></a><!-- doxytag: member="TurnInformation::addTime" ref="a355359f883ab74e549b5e439ea7e827e" args="(int msecs)" -->
151 <div class="memitem">
152 <div class="memproto">
153 <table class="memname">
155 <td class="memname">void TurnInformation::addTime </td>
157 <td class="paramtype">int </td>
158 <td class="paramname"> <em>msecs</em></td>
159 <td> ) </td>
166 <p>Definition at line <a class="el" href="turninformation_8cpp_source.html#l00034">34</a> of file <a class="el" href="turninformation_8cpp_source.html">turninformation.cpp</a>.</p>
170 <a class="anchor" id="a04e622dacea74dbc558b1a4260bff9a6"></a><!-- doxytag: member="TurnInformation::getDuration" ref="a04e622dacea74dbc558b1a4260bff9a6" args="() const " -->
171 <div class="memitem">
172 <div class="memproto">
173 <table class="memname">
175 <td class="memname">int TurnInformation::getDuration </td>
177 <td class="paramname"></td>
178 <td> ) </td>
179 <td> const<code> [inline]</code></td>
185 <p>Duration of turn. </p>
186 <dl class="return"><dt><b>Returns:</b></dt><dd>Duration of turn in msecs </dd></dl>
188 <p>Definition at line <a class="el" href="turninformation_8h_source.html#l00047">47</a> of file <a class="el" href="turninformation_8h_source.html">turninformation.h</a>.</p>
192 <a class="anchor" id="ae2d37b598c7fb0fb5882e44559f662cb"></a><!-- doxytag: member="TurnInformation::getPaused" ref="ae2d37b598c7fb0fb5882e44559f662cb" args="() const " -->
193 <div class="memitem">
194 <div class="memproto">
195 <table class="memname">
197 <td class="memname">int TurnInformation::getPaused </td>
199 <td class="paramname"></td>
200 <td> ) </td>
201 <td> const<code> [inline]</code></td>
207 <p>Duration of pauses during this turn. </p>
208 <dl class="return"><dt><b>Returns:</b></dt><dd>Duration of pauses in msecs </dd></dl>
210 <p>Definition at line <a class="el" href="turninformation_8h_source.html#l00051">51</a> of file <a class="el" href="turninformation_8h_source.html">turninformation.h</a>.</p>
214 <a class="anchor" id="acca895a029b03caa72115aed776e3070"></a><!-- doxytag: member="TurnInformation::getTimeAfter" ref="acca895a029b03caa72115aed776e3070" args="() const " -->
215 <div class="memitem">
216 <div class="memproto">
217 <table class="memname">
219 <td class="memname">int TurnInformation::getTimeAfter </td>
221 <td class="paramname"></td>
222 <td> ) </td>
229 <p>Time available for this player after this turn. </p>
230 <dl class="return"><dt><b>Returns:</b></dt><dd>Time available in msecs </dd></dl>
232 <p>Definition at line <a class="el" href="turninformation_8cpp_source.html#l00053">53</a> of file <a class="el" href="turninformation_8cpp_source.html">turninformation.cpp</a>.</p>
236 <a class="anchor" id="ad9802d9ccc6849b3bc1aedf87d2f0926"></a><!-- doxytag: member="TurnInformation::getTurnId" ref="ad9802d9ccc6849b3bc1aedf87d2f0926" args="() const " -->
237 <div class="memitem">
238 <div class="memproto">
239 <table class="memname">
241 <td class="memname">int TurnInformation::getTurnId </td>
243 <td class="paramname"></td>
244 <td> ) </td>
245 <td> const<code> [inline]</code></td>
251 <p>Definition at line <a class="el" href="turninformation_8h_source.html#l00043">43</a> of file <a class="el" href="turninformation_8h_source.html">turninformation.h</a>.</p>
255 <a class="anchor" id="adfe335e110744566aee521c4784f08a0"></a><!-- doxytag: member="TurnInformation::isWhiteTurn" ref="adfe335e110744566aee521c4784f08a0" args="() const " -->
256 <div class="memitem">
257 <div class="memproto">
258 <table class="memname">
260 <td class="memname">bool TurnInformation::isWhiteTurn </td>
262 <td class="paramname"></td>
263 <td> ) </td>
264 <td> const<code> [inline]</code></td>
270 <p>Definition at line <a class="el" href="turninformation_8h_source.html#l00056">56</a> of file <a class="el" href="turninformation_8h_source.html">turninformation.h</a>.</p>
274 <a class="anchor" id="a8820646aa51dd407d909fa08b55d52c5"></a><!-- doxytag: member="TurnInformation::turnReady" ref="a8820646aa51dd407d909fa08b55d52c5" args="(int msecs)" -->
275 <div class="memitem">
276 <div class="memproto">
277 <table class="memname">
279 <td class="memname">void TurnInformation::turnReady </td>
281 <td class="paramtype">int </td>
282 <td class="paramname"> <em>msecs</em></td>
283 <td> ) </td>
290 <p>Mark turn ready. </p>
291 <p>Turn will be locked to chances.</p>
292 <dl><dt><b>Parameters:</b></dt><dd>
293 <table border="0" cellspacing="2" cellpadding="0">
294 <tr><td valign="top"></td><td valign="top"><em>msecs</em> </td><td>Time available after this turn in msecs </td></tr>
299 <p>Definition at line <a class="el" href="turninformation_8cpp_source.html#l00047">47</a> of file <a class="el" href="turninformation_8cpp_source.html">turninformation.cpp</a>.</p>
303 <hr/><h2>Member Data Documentation</h2>
304 <a class="anchor" id="a659fbb28b8b241ce857c93e99c6c0005"></a><!-- doxytag: member="TurnInformation::duration_" ref="a659fbb28b8b241ce857c93e99c6c0005" args="" -->
305 <div class="memitem">
306 <div class="memproto">
307 <table class="memname">
309 <td class="memname">int <a class="el" href="class_turn_information.html#a659fbb28b8b241ce857c93e99c6c0005">TurnInformation::duration_</a><code> [protected]</code></td>
317 <p>Definition at line <a class="el" href="turninformation_8h_source.html#l00072">72</a> of file <a class="el" href="turninformation_8h_source.html">turninformation.h</a>.</p>
321 <a class="anchor" id="a045f9d3fb6faea111cb6bc1e798ca40d"></a><!-- doxytag: member="TurnInformation::paused_" ref="a045f9d3fb6faea111cb6bc1e798ca40d" args="" -->
322 <div class="memitem">
323 <div class="memproto">
324 <table class="memname">
326 <td class="memname">int <a class="el" href="class_turn_information.html#a045f9d3fb6faea111cb6bc1e798ca40d">TurnInformation::paused_</a><code> [protected]</code></td>
332 <p>duration of turn in msecs </p>
334 <p>Definition at line <a class="el" href="turninformation_8h_source.html#l00073">73</a> of file <a class="el" href="turninformation_8h_source.html">turninformation.h</a>.</p>
338 <a class="anchor" id="a5516d055dd81c55b75567247b8293cde"></a><!-- doxytag: member="TurnInformation::timeAfter_" ref="a5516d055dd81c55b75567247b8293cde" args="" -->
339 <div class="memitem">
340 <div class="memproto">
341 <table class="memname">
343 <td class="memname">int <a class="el" href="class_turn_information.html#a5516d055dd81c55b75567247b8293cde">TurnInformation::timeAfter_</a><code> [protected]</code></td>
349 <p>duration of pauses in msecs </p>
351 <p>Definition at line <a class="el" href="turninformation_8h_source.html#l00074">74</a> of file <a class="el" href="turninformation_8h_source.html">turninformation.h</a>.</p>
355 <a class="anchor" id="a77d4475ceb0b529835ffe09cb3974cfa"></a><!-- doxytag: member="TurnInformation::turnId_" ref="a77d4475ceb0b529835ffe09cb3974cfa" args="" -->
356 <div class="memitem">
357 <div class="memproto">
358 <table class="memname">
360 <td class="memname">int <a class="el" href="class_turn_information.html#a77d4475ceb0b529835ffe09cb3974cfa">TurnInformation::turnId_</a><code> [protected]</code></td>
366 <p>Definition at line <a class="el" href="turninformation_8h_source.html#l00071">71</a> of file <a class="el" href="turninformation_8h_source.html">turninformation.h</a>.</p>
370 <a class="anchor" id="a8e0a6eb69455755152da7705e46e1f48"></a><!-- doxytag: member="TurnInformation::turnReady_" ref="a8e0a6eb69455755152da7705e46e1f48" args="" -->
371 <div class="memitem">
372 <div class="memproto">
373 <table class="memname">
375 <td class="memname">bool <a class="el" href="class_turn_information.html#a8e0a6eb69455755152da7705e46e1f48">TurnInformation::turnReady_</a><code> [protected]</code></td>
381 <p>time available after this turn in msecs </p>
383 <p>Definition at line <a class="el" href="turninformation_8h_source.html#l00075">75</a> of file <a class="el" href="turninformation_8h_source.html">turninformation.h</a>.</p>
387 <a class="anchor" id="a884138dea5d094e2772ee2d87e2cdbe4"></a><!-- doxytag: member="TurnInformation::white_" ref="a884138dea5d094e2772ee2d87e2cdbe4" args="" -->
388 <div class="memitem">
389 <div class="memproto">
390 <table class="memname">
392 <td class="memname">bool <a class="el" href="class_turn_information.html#a884138dea5d094e2772ee2d87e2cdbe4">TurnInformation::white_</a><code> [protected]</code></td>
398 <p>turn is ready and locked </p>
400 <p>Definition at line <a class="el" href="turninformation_8h_source.html#l00076">76</a> of file <a class="el" href="turninformation_8h_source.html">turninformation.h</a>.</p>
404 <hr/>The documentation for this class was generated from the following files:<ul>
405 <li>/holvi/arto/ohjelmointi/ChessClock/chessclock/classes/<a class="el" href="turninformation_8h_source.html">turninformation.h</a></li>
406 <li>/holvi/arto/ohjelmointi/ChessClock/chessclock/classes/<a class="el" href="turninformation_8cpp_source.html">turninformation.cpp</a></li>
409 <!--- window showing the filter options -->
410 <div id="MSearchSelectWindow"
411 onmouseover="return searchBox.OnSearchSelectShow()"
412 onmouseout="return searchBox.OnSearchSelectHide()"
413 onkeydown="return searchBox.OnSearchSelectKey(event)">
414 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a></div>
416 <!-- iframe showing the search results (closed by default) -->
417 <div id="MSearchResultsWindow">
418 <iframe src="" frameborder="0"
419 name="MSearchResults" id="MSearchResults">
423 <hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Aug 14 01:28:48 2010 for Chess Clock by
424 <a href="http://www.doxygen.org/index.html">
425 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>