root/doc/html/classitpp_1_1Base__Event.html @ 353

Revision 353, 9.9 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::Base_Event Class 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_1Base__Event.html">Base_Event</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Base_Event Class Reference<br>
72<small>
73[<a class="el" href="group__protocol.html">Protocols Module</a>]</small>
74</h1><!-- doxytag: class="itpp::Base_Event" -->Base <a class="el" href="classitpp_1_1Event.html" title="An Event class that executes a function when the event expires.">Event</a> Class. 
75<a href="#_details">More...</a>
76<p>
77<code>#include &lt;<a class="el" href="events_8h-source.html">events.h</a>&gt;</code>
78<p>
79
80<p>
81<a href="classitpp_1_1Base__Event-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
82<tr><td></td></tr>
83<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="baeabfb0a38f892224be0d6ec6382d1e"></a><!-- doxytag: member="itpp::Base_Event::Base_Event" ref="baeabfb0a38f892224be0d6ec6382d1e" args="(const Ttype delta_time)" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Base__Event.html#baeabfb0a38f892224be0d6ec6382d1e">Base_Event</a> (const Ttype delta_time)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Schedule an event at time <code>delta_time</code> from now. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="76cc005e77cd5fd345a7eaab859e209f"></a><!-- doxytag: member="itpp::Base_Event::~Base_Event" ref="76cc005e77cd5fd345a7eaab859e209f" args="()" -->
89virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Base__Event.html#76cc005e77cd5fd345a7eaab859e209f">~Base_Event</a> ()</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d007ec59181c639a4677d95d4011b70"></a><!-- doxytag: member="itpp::Base_Event::cancel" ref="4d007ec59181c639a4677d95d4011b70" args="()" -->
93void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Base__Event.html#4d007ec59181c639a4677d95d4011b70">cancel</a> ()</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cancel an event. <br></td></tr>
96<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7b8e2d54a4a8f31c86dbaf8a39ad74d"></a><!-- doxytag: member="itpp::Base_Event::exec" ref="d7b8e2d54a4a8f31c86dbaf8a39ad74d" args="(void)=0" -->
98virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Base__Event.html#d7b8e2d54a4a8f31c86dbaf8a39ad74d">exec</a> (void)=0</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
101<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1620ad79858e3690a47502639c848f71"></a><!-- doxytag: member="itpp::Base_Event::delta_t" ref="1620ad79858e3690a47502639c848f71" args="" -->
103Ttype&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Base__Event.html#1620ad79858e3690a47502639c848f71">delta_t</a></td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e1908543c3f79105e22f89edae9c0ec8"></a><!-- doxytag: member="itpp::Base_Event::expire_t" ref="e1908543c3f79105e22f89edae9c0ec8" args="" -->
107Ttype&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Base__Event.html#e1908543c3f79105e22f89edae9c0ec8">expire_t</a></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="05911900c8118201c58541a0c4d4522f"></a><!-- doxytag: member="itpp::Base_Event::active" ref="05911900c8118201c58541a0c4d4522f" args="" -->
111bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Base__Event.html#05911900c8118201c58541a0c4d4522f">active</a></td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f9afce7195120eeba4656a2c9a34480e"></a><!-- doxytag: member="itpp::Base_Event::id" ref="f9afce7195120eeba4656a2c9a34480e" args="" -->
115unsigned long long int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Base__Event.html#f9afce7195120eeba4656a2c9a34480e">id</a></td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
118<tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf53c4e00e13b18a5aed1203aa5cb22b"></a><!-- doxytag: member="itpp::Base_Event::global_id" ref="bf53c4e00e13b18a5aed1203aa5cb22b" args="" -->
120static unsigned long long int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Base__Event.html#bf53c4e00e13b18a5aed1203aa5cb22b">global_id</a> = 0</td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">ADD DOCUMENTATION HERE. <br></td></tr>
123<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c3d2ef7b2c58fe89177dccb0c8d8fde4"></a><!-- doxytag: member="itpp::Base_Event::Base_Signal" ref="c3d2ef7b2c58fe89177dccb0c8d8fde4" args="" -->
125class&nbsp;</td><td class="memItemRight" valign="bottom"><b>Base_Signal</b></td></tr>
126
127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="344ea40d9d6c6a503c790dae68d41bbd"></a><!-- doxytag: member="itpp::Base_Event::Event_Queue" ref="344ea40d9d6c6a503c790dae68d41bbd" args="" -->
128class&nbsp;</td><td class="memItemRight" valign="bottom"><b>Event_Queue</b></td></tr>
129
130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="629c246bbb968078cf6bf6277887d006"></a><!-- doxytag: member="itpp::Base_Event::Compare_Base_Event_Times" ref="629c246bbb968078cf6bf6277887d006" args="" -->
131struct&nbsp;</td><td class="memItemRight" valign="bottom"><b>Compare_Base_Event_Times</b></td></tr>
132
133</table>
134<hr><a name="_details"></a><h2>Detailed Description</h2>
135Base <a class="el" href="classitpp_1_1Event.html" title="An Event class that executes a function when the event expires.">Event</a> Class.
136<p>
137An abstract Base class of Events that can be used to derive new events. All <a class="el" href="classitpp_1_1Event.html" title="An Event class that executes a function when the event expires.">Event</a> classes need to define the <a class="el" href="classitpp_1_1Base__Event.html#d7b8e2d54a4a8f31c86dbaf8a39ad74d" title="ADD DOCUMENTATION HERE.">exec()</a> function which is called when the event expires. An event has an execution time and an id. <hr>The documentation for this class was generated from the following files:<ul>
138<li><a class="el" href="events_8h-source.html">events.h</a><li><a class="el" href="events_8cpp.html">events.cpp</a></ul>
139</div>
140<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
141<a href="http://www.doxygen.org/index.html">
142<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
143</body>
144</html>
Note: See TracBrowser for help on using the browser.