<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>GG: GG::Timer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GG
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceGG.html">GG</a></li><li class="navelem"><a class="el" href="classGG_1_1Timer.html">Timer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> </div>
<div class="headertitle">
<div class="title">GG::Timer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="Timer_8h_source.html">Timer.h</a>></code></p>
<p><a href="classGG_1_1Timer-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a07d4b9f88a4a7b988596fc6a6fa40c19"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07d4b9f88a4a7b988596fc6a6fa40c19"></a>
<a class="el" href="classGG_1_1Timer.html#a2d19a6012cc5797b6e0dcaa2583bc495">FiredSignalType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Timer.html#a07d4b9f88a4a7b988596fc6a6fa40c19">FiredSignal</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Signal Types</h2></td></tr>
<tr class="memitem:a2d19a6012cc5797b6e0dcaa2583bc495"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d19a6012cc5797b6e0dcaa2583bc495"></a>
typedef boost::signal< void(unsigned <br class="typebreak"/>
int, <a class="el" href="classGG_1_1Timer.html">Timer</a> *)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Timer.html#a2d19a6012cc5797b6e0dcaa2583bc495">FiredSignalType</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Structors</h2></td></tr>
<tr class="memitem:aa20f861d49c67e28ae18c164272ce443"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Timer.html#aa20f861d49c67e28ae18c164272ce443">Timer</a> (unsigned int interval, unsigned int start_time=0)</td></tr>
<tr class="memitem:a90feb4cd07b3c8b373d6f9139ceb839b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a90feb4cd07b3c8b373d6f9139ceb839b"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Timer.html#a90feb4cd07b3c8b373d6f9139ceb839b">~Timer</a> ()</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Accessors</h2></td></tr>
<tr class="memitem:ac98ecb778523a823d7eadf308d592093"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac98ecb778523a823d7eadf308d592093"></a>
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Timer.html#ac98ecb778523a823d7eadf308d592093">Interval</a> () const </td></tr>
<tr class="memitem:ad3a9be64c215d851a655393b9371216f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3a9be64c215d851a655393b9371216f"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Timer.html#ad3a9be64c215d851a655393b9371216f">Running</a> () const </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Mutators</h2></td></tr>
<tr class="memitem:ab5bade0ac78d8671b7a6b70475758252"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5bade0ac78d8671b7a6b70475758252"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Timer.html#ab5bade0ac78d8671b7a6b70475758252">Reset</a> (unsigned int start_time=0)</td></tr>
<tr class="memitem:ab34af0e599cb3a65c231fe792789fbd4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab34af0e599cb3a65c231fe792789fbd4"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Timer.html#ab34af0e599cb3a65c231fe792789fbd4">SetInterval</a> (unsigned int interval)</td></tr>
<tr class="memitem:a589b508834b8e30c1d94155b3894018e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a589b508834b8e30c1d94155b3894018e"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Timer.html#a589b508834b8e30c1d94155b3894018e">Connect</a> (<a class="el" href="classGG_1_1Wnd.html">Wnd</a> *wnd)</td></tr>
<tr class="memitem:a54833b791a34813ba53399aa6a5ad988"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54833b791a34813ba53399aa6a5ad988"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Timer.html#a54833b791a34813ba53399aa6a5ad988">Disconnect</a> (<a class="el" href="classGG_1_1Wnd.html">Wnd</a> *wnd)</td></tr>
<tr class="memitem:a780bf5dc13c531934ff0d3dac67c1d3f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a780bf5dc13c531934ff0d3dac67c1d3f"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Timer.html#a780bf5dc13c531934ff0d3dac67c1d3f">Start</a> ()</td></tr>
<tr class="memitem:a3425d0157943d55845e55780c7e3da2e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3425d0157943d55845e55780c7e3da2e"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Timer.html#a3425d0157943d55845e55780c7e3da2e">Stop</a> ()</td></tr>
<tr class="memitem:a28fbf67682429927374ffdd50da70151"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28fbf67682429927374ffdd50da70151"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Timer.html#a28fbf67682429927374ffdd50da70151">Update</a> (unsigned int ticks)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classGG_1_1Timer.html" title="Timer provides a means for one or more Wnds to receive periodic notifications of the passage of time...">Timer</a> provides a means for one or more Wnds to receive periodic notifications of the passage of time. </p>
<p>The rate at which the <a class="el" href="classGG_1_1Timer.html" title="Timer provides a means for one or more Wnds to receive periodic notifications of the passage of time...">Timer</a> fires is not realtime. That is, there are no guarantees on the interval between firings other than that a minimum of <a class="el" href="classGG_1_1Timer.html#ac98ecb778523a823d7eadf308d592093" title="Returns the interval in ms between firings of the timer.">Interval()</a> ms will have elapsed. </p>
<p>Definition at line <a class="el" href="Timer_8h_source.html#l00047">47</a> of file <a class="el" href="Timer_8h_source.html">Timer.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa20f861d49c67e28ae18c164272ce443"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">GG::Timer::Timer </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>interval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>start_time</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Basic ctor. Takes an interval and a start time in ms; if the start time is ommitted, the start time will be immediate. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Timer_8h_source.html">Timer.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 15 2012 15:13:32 for GG by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1
</small></address>
</body>
</html>
