<!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>The MRPT project: mrpt::utils::mrptEvent 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.6.2-20100208 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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="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">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacemrpt.html">mrpt</a>::<a class="el" href="namespacemrpt_1_1utils.html">utils</a>::<a class="el" href="classmrpt_1_1utils_1_1mrpt_event.html">mrptEvent</a>
</div>
</div>
<div class="contents">
<h1>mrpt::utils::mrptEvent Class Reference</h1><!-- doxytag: class="mrpt::utils::mrptEvent" -->
<p>The basic event type for the observer-observable pattern in MRPT.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="mrpt_event_8h_source.html">mrpt/utils/mrptEvent.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mrpt::utils::mrptEvent:</div>
<div class="dynsection">
<div class="center"><img src="classmrpt_1_1utils_1_1mrpt_event__inherit__graph.png" border="0" usemap="#mrpt_1_1utils_1_1mrpt_event_inherit__map" alt="Inheritance graph"/></div>
<map name="mrpt_1_1utils_1_1mrpt_event_inherit__map" id="mrpt_1_1utils_1_1mrpt_event_inherit__map">
<area shape="rect" id="node3" href="classmrpt_1_1gui_1_1mrpt_event_window_char.html" title="An event sent by a window upon a char pressed by the user." alt="" coords="219,5,435,35"/><area shape="rect" id="node5" href="classmrpt_1_1gui_1_1mrpt_event_window_resize.html" title="An event sent by a window upon resize." alt="" coords="212,59,441,88"/><area shape="rect" id="node7" href="classmrpt_1_1slam_1_1mrpt_event_metric_map_clear.html" title="Event emitted by a metric up upon call of clear()." alt="" coords="205,112,448,141"/><area shape="rect" id="node9" href="classmrpt_1_1slam_1_1mrpt_event_metric_map_insert.html" title="Event emitted by a metric up upon a succesful call to insertObservation()." alt="" coords="204,165,449,195"/><area shape="rect" id="node11" href="classmrpt_1_1utils_1_1mrpt_event_on_destroy.html" title="An event sent by any CObservable object (automatically) just before being destroyed..." alt="" coords="221,219,432,248"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classmrpt_1_1utils_1_1mrpt_event-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>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_1utils_1_1mrpt_event.html#a8a2e1e1de9f534f2eace62dcfbee7e7a">mrptEvent</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default ctor. <a href="#a8a2e1e1de9f534f2eace62dcfbee7e7a"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class EVENTTYPE > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1mrpt_event.html#ad6efbd2fda1ee0d58af38fcbf697d65d">isOfType</a> () const </td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemrpt_1_1system.html#a42674286d8d56afea013b6329bb7327a">mrpt::system::TTimeStamp</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1mrpt_event.html#aceba670cb9ef07097a20af98b5e40f61">timestamp</a></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1mrpt_event.html#acfe7c36c5c89d7efd437f83870171f0a">do_nothing</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Just to allow this class to be polymorphic. <a href="#acfe7c36c5c89d7efd437f83870171f0a"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The basic event type for the observer-observable pattern in MRPT. </p>
<p>You can sub-class this base class to create custom event types, then tell between them in runtime with <a class="el" href="classmrpt_1_1utils_1_1mrpt_event.html#ad6efbd2fda1ee0d58af38fcbf697d65d">isOfType<T>()</a>, for example: </p>
<div class="fragment"><pre class="fragment"> <span class="keywordflow">if</span> (e.isOfType<mrptEventOnDestroy>()) { ... }
</pre></div><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1utils_1_1_c_observer.html" title="Inherit from this class to get notified about events from any CObservable object...">CObserver</a>, <a class="el" href="classmrpt_1_1utils_1_1_c_observable.html" title="Inherit from this class for those objects capable of being observed by a CObserver...">CObservable</a> </dd></dl>
<p>Definition at line <a class="el" href="mrpt_event_8h_source.html#l00049">49</a> of file <a class="el" href="mrpt_event_8h_source.html">mrptEvent.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8a2e1e1de9f534f2eace62dcfbee7e7a"></a><!-- doxytag: member="mrpt::utils::mrptEvent::mrptEvent" ref="a8a2e1e1de9f534f2eace62dcfbee7e7a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::utils::mrptEvent::mrptEvent </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default ctor. </p>
<p>Definition at line <a class="el" href="mrpt_event_8h_source.html#l00055">55</a> of file <a class="el" href="mrpt_event_8h_source.html">mrptEvent.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acfe7c36c5c89d7efd437f83870171f0a"></a><!-- doxytag: member="mrpt::utils::mrptEvent::do_nothing" ref="acfe7c36c5c89d7efd437f83870171f0a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void mrpt::utils::mrptEvent::do_nothing </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Just to allow this class to be polymorphic. </p>
<p>Reimplemented in <a class="el" href="classmrpt_1_1utils_1_1mrpt_event_on_destroy.html#afd57a1b738e02f6fa49b972715dcc98c">mrpt::utils::mrptEventOnDestroy</a>, <a class="el" href="classmrpt_1_1gui_1_1mrpt_event_window_char.html#a92bc871ddd8b7ed913da2d8e4f352597">mrpt::gui::mrptEventWindowChar</a>, <a class="el" href="classmrpt_1_1gui_1_1mrpt_event_window_resize.html#a551f070ee9724b870f4ee52aea566ff1">mrpt::gui::mrptEventWindowResize</a>, <a class="el" href="classmrpt_1_1slam_1_1mrpt_event_metric_map_clear.html#ac89507164a51f8e55206c60386e2600d">mrpt::slam::mrptEventMetricMapClear</a>, and <a class="el" href="classmrpt_1_1slam_1_1mrpt_event_metric_map_insert.html#a79d11b319a5fd36ba189aa33260bc5b2">mrpt::slam::mrptEventMetricMapInsert</a>.</p>
<p>Definition at line <a class="el" href="mrpt_event_8h_source.html#l00052">52</a> of file <a class="el" href="mrpt_event_8h_source.html">mrptEvent.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad6efbd2fda1ee0d58af38fcbf697d65d"></a><!-- doxytag: member="mrpt::utils::mrptEvent::isOfType" ref="ad6efbd2fda1ee0d58af38fcbf697d65d" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class EVENTTYPE > </div>
<table class="memname">
<tr>
<td class="memname">bool mrpt::utils::mrptEvent::isOfType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="mrpt_event_8h_source.html#l00058">58</a> of file <a class="el" href="mrpt_event_8h_source.html">mrptEvent.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aceba670cb9ef07097a20af98b5e40f61"></a><!-- doxytag: member="mrpt::utils::mrptEvent::timestamp" ref="aceba670cb9ef07097a20af98b5e40f61" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacemrpt_1_1system.html#a42674286d8d56afea013b6329bb7327a">mrpt::system::TTimeStamp</a> <a class="el" href="classmrpt_1_1utils_1_1mrpt_event.html#aceba670cb9ef07097a20af98b5e40f61">mrpt::utils::mrptEvent::timestamp</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="mrpt_event_8h_source.html#l00060">60</a> of file <a class="el" href="mrpt_event_8h_source.html">mrptEvent.h</a>.</p>
</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.6.2-20100208</a> for MRPT 0.9.0 SVN: at Wed Jul 14 12:48:09 UTC 2010</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
