root/doc/html/classitpp_1_1TTimer.html @ 354

Revision 353, 9.0 kB (checked in by smidl, 16 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: itpp::TTimer&lt; THandler &gt; Class Template Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>itpp</b>::<a class="el" href="classitpp_1_1TTimer.html">TTimer</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::TTimer&lt; THandler &gt; Class Template Reference<br>
72<small>
73[<a class="el" href="group__protocol.html">Protocols Module</a>]</small>
74</h1><!-- doxytag: class="itpp::TTimer" --><code>#include &lt;<a class="el" href="signals__slots_8h-source.html">signals_slots.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classitpp_1_1TTimer-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
79<tr><td></td></tr>
80<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b52b5b2319fc9014efb5a882617dd23e"></a><!-- doxytag: member="itpp::TTimer::TTimer" ref="b52b5b2319fc9014efb5a882617dd23e" args="(THandler &amp;handler, void(THandler::*handlerFunction)(Ttype time))" -->
82&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TTimer.html#b52b5b2319fc9014efb5a882617dd23e">TTimer</a> (THandler &amp;handler, void(THandler::*handlerFunction)(Ttype time))</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3af3b027878117513f83ac32a2cb35a1"></a><!-- doxytag: member="itpp::TTimer::~TTimer" ref="3af3b027878117513f83ac32a2cb35a1" args="()" -->
86virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TTimer.html#3af3b027878117513f83ac32a2cb35a1">~TTimer</a> ()</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7fcbf2f530a950efb0af502bed8abce2"></a><!-- doxytag: member="itpp::TTimer::Set" ref="7fcbf2f530a950efb0af502bed8abce2" args="(Ttype time, bool relative=true)" -->
90void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TTimer.html#7fcbf2f530a950efb0af502bed8abce2">Set</a> (Ttype time, bool relative=true)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bc25e24ceb85a2832850a49e401c5435"></a><!-- doxytag: member="itpp::TTimer::Reset" ref="bc25e24ceb85a2832850a49e401c5435" args="()" -->
94void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TTimer.html#bc25e24ceb85a2832850a49e401c5435">Reset</a> ()</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="db22a58e770b0381ac024b801ea17ce5"></a><!-- doxytag: member="itpp::TTimer::ExpirationTime" ref="db22a58e770b0381ac024b801ea17ce5" args="() const " -->
98Ttype&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TTimer.html#db22a58e770b0381ac024b801ea17ce5">ExpirationTime</a> () const </td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b82a771e98eeeb14c4d9b7b9067915f9"></a><!-- doxytag: member="itpp::TTimer::IsPending" ref="b82a771e98eeeb14c4d9b7b9067915f9" args="() const " -->
102bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TTimer.html#b82a771e98eeeb14c4d9b7b9067915f9">IsPending</a> () const </td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
105<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dc8dab5a5a7fa6e559aa0b25960cb164"></a><!-- doxytag: member="itpp::TTimer::HandleProcessEvent" ref="dc8dab5a5a7fa6e559aa0b25960cb164" args="(Ttype currentTime)" -->
107virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TTimer.html#dc8dab5a5a7fa6e559aa0b25960cb164">HandleProcessEvent</a> (Ttype currentTime)</td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc88d99905440868e14eaf79afd8497b"></a><!-- doxytag: member="itpp::TTimer::HandleCancelEvent" ref="fc88d99905440868e14eaf79afd8497b" args="(Ttype)" -->
111virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TTimer.html#fc88d99905440868e14eaf79afd8497b">HandleCancelEvent</a> (Ttype)</td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
114<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5c73915dfdaa191722958214bf9844d"></a><!-- doxytag: member="itpp::TTimer::fPending" ref="c5c73915dfdaa191722958214bf9844d" args="" -->
116bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TTimer.html#c5c73915dfdaa191722958214bf9844d">fPending</a></td></tr>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flag denoting if timer is set. <br></td></tr>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12e6f66dd9333656113328edb9e0af04"></a><!-- doxytag: member="itpp::TTimer::fExpirationTime" ref="12e6f66dd9333656113328edb9e0af04" args="" -->
120Ttype&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1TTimer.html#12e6f66dd9333656113328edb9e0af04">fExpirationTime</a></td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
123</table>
124<hr><a name="_details"></a><h2>Detailed Description</h2>
125<h3>template&lt;class THandler&gt;<br>
126 class itpp::TTimer&lt; THandler &gt;</h3>
127
128<a class="el" href="classitpp_1_1TTimer.html">TTimer</a> is a class that can be set in order to be remembered at a future instance of time. The difference to "generic event" is the easy usage that already take care about posting and canceling events <hr>The documentation for this class was generated from the following file:<ul>
129<li><a class="el" href="signals__slots_8h-source.html">signals_slots.h</a></ul>
130</div>
131<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
132<a href="http://www.doxygen.org/index.html">
133<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
134</body>
135</html>
Note: See TracBrowser for help on using the browser.