<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>mrpt::synch::CEvent Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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>
<div id="MSearchBox" class="MSearchBoxInactive">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</div>
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemrpt.html">mrpt</a> </li>
<li class="navelem"><a class="el" href="namespacemrpt_1_1synch.html">synch</a> </li>
<li class="navelem"><a class="el" href="classmrpt_1_1synch_1_1_c_event.html">CEvent</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">mrpt::synch::CEvent Class Reference<div class="ingroups"><a class="el" href="group__synch__grp.html">Synchronization, multi-threading synch tools</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="mrpt::synch::CEvent" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class provides a simple way of waiting for and signaling events (NOT IMPLEMENTED YET!). </p>
</div>
<p><code>#include <<a class="el" href="_c_event_8h_source.html">mrpt/synch/CEvent.h</a>></code></p>
<p><a href="classmrpt_1_1synch_1_1_c_event-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="classmrpt_1_1synch_1_1_c_event.html#afc93844e70c4c5f34d670c6659963556">CEvent</a> (bool initialSignaled)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor: set the initial signaled state of the event. <a href="#afc93844e70c4c5f34d670c6659963556"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_event.html#a4650092950da1ad5cbd1652f6d4c900d">~CEvent</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a4650092950da1ad5cbd1652f6d4c900d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_event.html#a1ecf69ff3fe35e59ff9d16a589764c86">signal</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal the event: the first waiting thread resumes execution (if no thread is waiting, the object keeps signaled) <a href="#a1ecf69ff3fe35e59ff9d16a589764c86"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_event.html#aff0b8ef7e60392e1e61abf05681b6510">wait</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Waits for the event to be signaled. <a href="#aff0b8ef7e60392e1e61abf05681b6510"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_event.html#ab5e9cb9d0ebabf37e67d74431cb82316">reset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Manual reset of the event, without waiting to a signaled state (without effect if it is currently not signaled) <a href="#ab5e9cb9d0ebabf37e67d74431cb82316"></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"><a class="el" href="classmrpt_1_1utils_1_1_c_referenced_mem_block.html">utils::CReferencedMemBlock</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_event.html#ad15c990260d96a19e54d3889303b577c">m_data</a></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="afc93844e70c4c5f34d670c6659963556"></a><!-- doxytag: member="mrpt::synch::CEvent::CEvent" ref="afc93844e70c4c5f34d670c6659963556" args="(bool initialSignaled)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::synch::CEvent::CEvent </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>initialSignaled</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor: set the initial signaled state of the event. </p>
</div>
</div>
<a class="anchor" id="a4650092950da1ad5cbd1652f6d4c900d"></a><!-- doxytag: member="mrpt::synch::CEvent::~CEvent" ref="a4650092950da1ad5cbd1652f6d4c900d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::synch::CEvent::~CEvent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab5e9cb9d0ebabf37e67d74431cb82316"></a><!-- doxytag: member="mrpt::synch::CEvent::reset" ref="ab5e9cb9d0ebabf37e67d74431cb82316" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::synch::CEvent::reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Manual reset of the event, without waiting to a signaled state (without effect if it is currently not signaled) </p>
</div>
</div>
<a class="anchor" id="a1ecf69ff3fe35e59ff9d16a589764c86"></a><!-- doxytag: member="mrpt::synch::CEvent::signal" ref="a1ecf69ff3fe35e59ff9d16a589764c86" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::synch::CEvent::signal </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Signal the event: the first waiting thread resumes execution (if no thread is waiting, the object keeps signaled) </p>
</div>
</div>
<a class="anchor" id="aff0b8ef7e60392e1e61abf05681b6510"></a><!-- doxytag: member="mrpt::synch::CEvent::wait" ref="aff0b8ef7e60392e1e61abf05681b6510" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::synch::CEvent::wait </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Waits for the event to be signaled. </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ad15c990260d96a19e54d3889303b577c"></a><!-- doxytag: member="mrpt::synch::CEvent::m_data" ref="ad15c990260d96a19e54d3889303b577c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmrpt_1_1utils_1_1_c_referenced_mem_block.html">utils::CReferencedMemBlock</a> <a class="el" href="classmrpt_1_1synch_1_1_c_event.html#ad15c990260d96a19e54d3889303b577c">mrpt::synch::CEvent::m_data</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_event_8h_source.html#l00048">48</a> of file <a class="el" href="_c_event_8h_source.html">CEvent.h</a>.</p>
</div>
</div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
