<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csEventTimer Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<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="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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>
<h1>csEventTimer Class Reference</h1><!-- doxytag: class="csEventTimer" --><!-- doxytag: inherits="scfImplementation1< csEventTimer, iEventTimer >" -->This class implements a timer.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="csutil_2timer_8h-source.html">csutil/timer.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csEventTimer:</div>
<div class="dynsection">
<p><center><img src="classcsEventTimer__inherit__graph.png" border="0" usemap="#csEventTimer__inherit__map" alt="Inheritance graph"></center>
<map name="csEventTimer__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csEventTimer, iEventTimer \>" alt="" coords="60,161,412,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csEventTimer \>" alt="" coords="5,84,264,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="289,7,345,33"><area shape="rect" href="structiEventTimer.html" title="A timer." alt="" coords="288,84,387,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="24,7,245,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsEventTimer-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventTimer.html#5ec1cfeb085f70a266ef0f20ae55ef92">AddTimerEvent</a> (<a class="el" href="structiTimerEvent.html">iTimerEvent</a> *ev, <a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> delay)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a timer event to be scheduled later. <a href="#5ec1cfeb085f70a266ef0f20ae55ef92"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventTimer.html#dbe80cf32749062636d9816f4a596b20">GetEventCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query the number of events still in the queue. <a href="#dbe80cf32749062636d9816f4a596b20"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventTimer.html#88daf685b1df8016b92749b7fdfc4004">GetTimeLeft</a> (size_t idx) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query the number of ticks before the specified event fires. <a href="#88daf685b1df8016b92749b7fdfc4004"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventTimer.html#4c62c5d635f309d9fb15d0a9f19b35cb">RemoveAllTimerEvents</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear all timer events. <a href="#4c62c5d635f309d9fb15d0a9f19b35cb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventTimer.html#3f8a23d8204ce11a3e89ac2ef4de1f33">RemoveTimerEvent</a> (<a class="el" href="structiTimerEvent.html">iTimerEvent</a> *ev)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a timer event. <a href="#3f8a23d8204ce11a3e89ac2ef4de1f33"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classcsPtr.html">csPtr</a><br>
< <a class="el" href="structiEventTimer.html">iEventTimer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventTimer.html#f900650669f4bb977172e13530d67165">GetStandardTimer</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *object_reg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is a static method to easily get the standard global timer (name 'crystalspace.timer.standard' in the object registry). <a href="#f900650669f4bb977172e13530d67165"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class implements a timer.
<p>
You can add operations to it and they will be performed at the dedicated time.
<p>Definition at line <a class="el" href="csutil_2timer_8h-source.html#l00044">44</a> of file <a class="el" href="csutil_2timer_8h-source.html">timer.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5ec1cfeb085f70a266ef0f20ae55ef92"></a><!-- doxytag: member="csEventTimer::AddTimerEvent" ref="5ec1cfeb085f70a266ef0f20ae55ef92" args="(iTimerEvent *ev, csTicks delay)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csEventTimer::AddTimerEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiTimerEvent.html">iTimerEvent</a> * </td>
<td class="paramname"> <em>ev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td>
<td class="paramname"> <em>delay</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a timer event to be scheduled later.
<p>
<p>Implements <a class="el" href="structiEventTimer.html#689d3bb68f963d5b46f4dc792b6aab8c">iEventTimer</a>.</p>
</div>
</div><p>
<a class="anchor" name="dbe80cf32749062636d9816f4a596b20"></a><!-- doxytag: member="csEventTimer::GetEventCount" ref="dbe80cf32749062636d9816f4a596b20" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t csEventTimer::GetEventCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query the number of events still in the queue.
<p>
<p>Implements <a class="el" href="structiEventTimer.html#fbf95af9a411c1619c1e5621d5874031">iEventTimer</a>.</p>
<p>Definition at line <a class="el" href="csutil_2timer_8h-source.html#l00072">72</a> of file <a class="el" href="csutil_2timer_8h-source.html">timer.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="f900650669f4bb977172e13530d67165"></a><!-- doxytag: member="csEventTimer::GetStandardTimer" ref="f900650669f4bb977172e13530d67165" args="(iObjectRegistry *object_reg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiEventTimer.html">iEventTimer</a>> csEventTimer::GetStandardTimer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> * </td>
<td class="paramname"> <em>object_reg</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is a static method to easily get the standard global timer (name 'crystalspace.timer.standard' in the object registry).
<p>
If that timer doesn't exist yet it will be created.
</div>
</div><p>
<a class="anchor" name="88daf685b1df8016b92749b7fdfc4004"></a><!-- doxytag: member="csEventTimer::GetTimeLeft" ref="88daf685b1df8016b92749b7fdfc4004" args="(size_t idx) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> csEventTimer::GetTimeLeft </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query the number of ticks before the specified event fires.
<p>
<p>Implements <a class="el" href="structiEventTimer.html#bf08937e06ff5cd93776d17695917035">iEventTimer</a>.</p>
</div>
</div><p>
<a class="anchor" name="4c62c5d635f309d9fb15d0a9f19b35cb"></a><!-- doxytag: member="csEventTimer::RemoveAllTimerEvents" ref="4c62c5d635f309d9fb15d0a9f19b35cb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csEventTimer::RemoveAllTimerEvents </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear all timer events.
<p>
<p>Implements <a class="el" href="structiEventTimer.html#e991d51aefa5393acac16471a207ba60">iEventTimer</a>.</p>
</div>
</div><p>
<a class="anchor" name="3f8a23d8204ce11a3e89ac2ef4de1f33"></a><!-- doxytag: member="csEventTimer::RemoveTimerEvent" ref="3f8a23d8204ce11a3e89ac2ef4de1f33" args="(iTimerEvent *ev)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csEventTimer::RemoveTimerEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiTimerEvent.html">iTimerEvent</a> * </td>
<td class="paramname"> <em>ev</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a timer event.
<p>
<p>Implements <a class="el" href="structiEventTimer.html#ab1a6f17c931a1dbcc0926a3ff70a8ab">iEventTimer</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="csutil_2timer_8h-source.html">timer.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
488
