root/doc/html/classitpp_1_1Event__Queue.html @ 353

Revision 353, 8.1 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::Event_Queue 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_1Event__Queue.html">Event_Queue</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Event_Queue Class Reference<br>
72<small>
73[<a class="el" href="group__protocol.html">Protocols Module</a>]</small>
74</h1><!-- doxytag: class="itpp::Event_Queue" --><a class="el" href="classitpp_1_1Event.html" title="An Event class that executes a function when the event expires.">Event</a> Queue 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_1Event__Queue-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="6f7fdf62d13e0590f27bab0fa9b7948d"></a><!-- doxytag: member="itpp::Event_Queue::Event_Queue" ref="6f7fdf62d13e0590f27bab0fa9b7948d" args="()" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Event__Queue.html#6f7fdf62d13e0590f27bab0fa9b7948d">Event_Queue</a> ()</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5312542514cf15448959fc9d81d15961"></a><!-- doxytag: member="itpp::Event_Queue::~Event_Queue" ref="5312542514cf15448959fc9d81d15961" args="()" -->
89&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Event__Queue.html#5312542514cf15448959fc9d81d15961">~Event_Queue</a> ()</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
92<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9d01b44e3979d76865d1fee69733a97e"></a><!-- doxytag: member="itpp::Event_Queue::add" ref="9d01b44e3979d76865d1fee69733a97e" args="(Base_Event *e)" -->
94static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Event__Queue.html#9d01b44e3979d76865d1fee69733a97e">add</a> (<a class="el" href="classitpp_1_1Base__Event.html">Base_Event</a> *e)</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add event to Queue. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ac4b417979ddc31b7588602a3c1438e6"></a><!-- doxytag: member="itpp::Event_Queue::now" ref="ac4b417979ddc31b7588602a3c1438e6" args="()" -->
98static Ttype&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Event__Queue.html#ac4b417979ddc31b7588602a3c1438e6">now</a> ()</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return current time. <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5bde95d04badf287fd5bc5c548f3f7f8"></a><!-- doxytag: member="itpp::Event_Queue::start" ref="5bde95d04badf287fd5bc5c548f3f7f8" args="()" -->
102static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Event__Queue.html#5bde95d04badf287fd5bc5c548f3f7f8">start</a> ()</td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start executing events. <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8fe88816c74d7b6b5b0ed2ad5104264"></a><!-- doxytag: member="itpp::Event_Queue::stop" ref="a8fe88816c74d7b6b5b0ed2ad5104264" args="()" -->
106static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Event__Queue.html#a8fe88816c74d7b6b5b0ed2ad5104264">stop</a> ()</td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop execution of events. <br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e9b152b5ec0fd6bf637df85b44dfa1e3"></a><!-- doxytag: member="itpp::Event_Queue::clear" ref="e9b152b5ec0fd6bf637df85b44dfa1e3" args="()" -->
110static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Event__Queue.html#e9b152b5ec0fd6bf637df85b44dfa1e3">clear</a> ()</td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove all events. <br></td></tr>
113<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c3d2ef7b2c58fe89177dccb0c8d8fde4"></a><!-- doxytag: member="itpp::Event_Queue::Base_Signal" ref="c3d2ef7b2c58fe89177dccb0c8d8fde4" args="" -->
115class&nbsp;</td><td class="memItemRight" valign="bottom"><b>Base_Signal</b></td></tr>
116
117</table>
118<hr><a name="_details"></a><h2>Detailed Description</h2>
119<a class="el" href="classitpp_1_1Event.html" title="An Event class that executes a function when the event expires.">Event</a> Queue class.
120<p>
121A class for storing and executing events. Events can be added to the queue and when the <a class="el" href="classitpp_1_1Event__Queue.html#5bde95d04badf287fd5bc5c548f3f7f8" title="Start executing events.">start()</a> is called all events will be executed. Observe that Events need to be created before they are added to the queue by calling an appropriate constructor. However, expired events are destroyed automatically (the destructor is called). <hr>The documentation for this class was generated from the following files:<ul>
122<li><a class="el" href="events_8h-source.html">events.h</a><li><a class="el" href="events_8cpp.html">events.cpp</a></ul>
123</div>
124<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
125<a href="http://www.doxygen.org/index.html">
126<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
127</body>
128</html>
Note: See TracBrowser for help on using the browser.