<!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"/>
<title>KatanaNativeInterface: KNI::Timer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">KatanaNativeInterface <span id="projectnumber">$VERSION$</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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>
<li><a href="dirs.html"><span>Directories</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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classKNI_1_1Timer.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<h1>KNI::Timer Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="KNI::Timer" -->
<p>Provides a stop-watch-like class with a resolution of milliseconds.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Timer_8h_source.html">Timer.h</a>></code></p>
<p><a href="classKNI_1_1Timer-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1Timer.html#aeb46f94e7e0be4c3c9c6472b50189557">Timer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1Timer.html#a277fce8c1df55fc9f9065def3c4035bb">Timer</a> (long timeout)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1Timer.html#a72b9a726bbfaeac811fda182bd6deca2">Set</a> (long timeout)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1Timer.html#ac6fc4fc1ba79af2170cf15cd9768d184">Start</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1Timer.html#aceba410e44517b69f0733406240dfb4a">Set_And_Start</a> (long timeout)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1Timer.html#a90ce464e939dc223f0d2323c750ca06d">Elapsed</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if timer is elapsed. <a href="#a90ce464e939dc223f0d2323c750ca06d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1Timer.html#a73e7d741acac8c319745237ab1c4b3a2">ElapsedTime</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the elapsed time. <a href="#a73e7d741acac8c319745237ab1c4b3a2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1Timer.html#ab1799e76364b7567726a43c819f68e53">WaitUntilElapsed</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Block until time's up. <a href="#ab1799e76364b7567726a43c819f68e53"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1Timer.html#a7c5d9aa62099607d1bccb8d923eedef1">_ElapsedTime</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Platform specific implementation of <a class="el" href="classKNI_1_1Timer.html#a73e7d741acac8c319745237ab1c4b3a2" title="Returns the elapsed time.">ElapsedTime()</a>. <a href="#a7c5d9aa62099607d1bccb8d923eedef1"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1Timer.html#a5e44ae336d7455414ad4a77940d5b6aa">_timeout</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct timeval </td><td class="memItemRight" valign="bottom"><a class="el" href="classKNI_1_1Timer.html#a2678a40577d398541d87b56461c0e063">_ct</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Provides a stop-watch-like class with a resolution of milliseconds. </p>
<p>Definition at line <a class="el" href="Timer_8h_source.html#l00041">41</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="aeb46f94e7e0be4c3c9c6472b50189557"></a><!-- doxytag: member="KNI::Timer::Timer" ref="aeb46f94e7e0be4c3c9c6472b50189557" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KNI::Timer::Timer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a277fce8c1df55fc9f9065def3c4035bb"></a><!-- doxytag: member="KNI::Timer::Timer" ref="a277fce8c1df55fc9f9065def3c4035bb" args="(long timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KNI::Timer::Timer </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>timeout</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7c5d9aa62099607d1bccb8d923eedef1"></a><!-- doxytag: member="KNI::Timer::_ElapsedTime" ref="a7c5d9aa62099607d1bccb8d923eedef1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long KNI::Timer::_ElapsedTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Platform specific implementation of <a class="el" href="classKNI_1_1Timer.html#a73e7d741acac8c319745237ab1c4b3a2" title="Returns the elapsed time.">ElapsedTime()</a>. </p>
</div>
</div>
<a class="anchor" id="a90ce464e939dc223f0d2323c750ca06d"></a><!-- doxytag: member="KNI::Timer::Elapsed" ref="a90ce464e939dc223f0d2323c750ca06d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KNI::Timer::Elapsed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if timer is elapsed. </p>
</div>
</div>
<a class="anchor" id="a73e7d741acac8c319745237ab1c4b3a2"></a><!-- doxytag: member="KNI::Timer::ElapsedTime" ref="a73e7d741acac8c319745237ab1c4b3a2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long KNI::Timer::ElapsedTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the elapsed time. </p>
</div>
</div>
<a class="anchor" id="a72b9a726bbfaeac811fda182bd6deca2"></a><!-- doxytag: member="KNI::Timer::Set" ref="a72b9a726bbfaeac811fda182bd6deca2" args="(long timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KNI::Timer::Set </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>timeout</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aceba410e44517b69f0733406240dfb4a"></a><!-- doxytag: member="KNI::Timer::Set_And_Start" ref="aceba410e44517b69f0733406240dfb4a" args="(long timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KNI::Timer::Set_And_Start </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>timeout</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac6fc4fc1ba79af2170cf15cd9768d184"></a><!-- doxytag: member="KNI::Timer::Start" ref="ac6fc4fc1ba79af2170cf15cd9768d184" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KNI::Timer::Start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab1799e76364b7567726a43c819f68e53"></a><!-- doxytag: member="KNI::Timer::WaitUntilElapsed" ref="ab1799e76364b7567726a43c819f68e53" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KNI::Timer::WaitUntilElapsed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Block until time's up. </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a2678a40577d398541d87b56461c0e063"></a><!-- doxytag: member="KNI::Timer::_ct" ref="a2678a40577d398541d87b56461c0e063" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct timeval <a class="el" href="classKNI_1_1Timer.html#a2678a40577d398541d87b56461c0e063">KNI::Timer::_ct</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="Timer_8h_source.html#l00048">48</a> of file <a class="el" href="Timer_8h_source.html">Timer.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5e44ae336d7455414ad4a77940d5b6aa"></a><!-- doxytag: member="KNI::Timer::_timeout" ref="a5e44ae336d7455414ad4a77940d5b6aa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long <a class="el" href="classKNI_1_1Timer.html#a5e44ae336d7455414ad4a77940d5b6aa">KNI::Timer::_timeout</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="Timer_8h_source.html#l00043">43</a> of file <a class="el" href="Timer_8h_source.html">Timer.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/common/<a class="el" href="Timer_8h_source.html">Timer.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceKNI.html">KNI</a> </li>
<li class="navelem"><a class="el" href="classKNI_1_1Timer.html">Timer</a> </li>
<li class="footer">Generated on Tue Feb 8 2011 for KatanaNativeInterface by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
