<!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::utils::CObservable 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_1utils.html">utils</a> </li>
<li class="navelem"><a class="el" href="classmrpt_1_1utils_1_1_c_observable.html">CObservable</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">mrpt::utils::CObservable Class Reference<div class="ingroups"><a class="el" href="group__mrpt__base__grp.html">[mrpt-base]</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="mrpt::utils::CObservable" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Inherit from this class for those objects capable of being observed by a <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 after subscribing to...">CObserver</a> class. </p>
<p>The only thing to do in your child class is to call <a class="el" href="classmrpt_1_1utils_1_1_c_observable.html#a0c384e00c06199bc2ff37ff5ecb520c9" title="Called when you want this object to emit an event to all the observers currently subscribed to this o...">CObservable::publishEvent()</a> whenever needed and all the observer classes will be notified.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The pairs <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 class...">CObservable</a> / <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 after subscribing to...">CObserver</a> automatically notify each other the destruction of any of them, effectively ending the subscription of events.</dd></dl>
<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 after subscribing to...">CObserver</a>, <a class="el" href="classmrpt_1_1utils_1_1mrpt_event.html" title="The basic event type for the observer-observable pattern in MRPT.">mrptEvent</a> </dd></dl>
</div>
<p><code>#include <<a class="el" href="_c_observable_8h_source.html">mrpt/utils/CObservable.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mrpt::utils::CObservable:</div>
<div class="dyncontent">
<div class="center"><img src="classmrpt_1_1utils_1_1_c_observable__inherit__graph.png" border="0" usemap="#mrpt_1_1utils_1_1_c_observable_inherit__map" alt="Inheritance graph"/></div>
<map name="mrpt_1_1utils_1_1_c_observable_inherit__map" id="mrpt_1_1utils_1_1_c_observable_inherit__map">
<area shape="rect" id="node3" href="classmrpt_1_1gui_1_1_c_base_g_u_i_window.html" title="The base class for GUI window classes." alt="" coords="228,81,420,108"/><area shape="rect" id="node11" href="classmrpt_1_1opengl_1_1_c_open_g_l_viewport.html" title="A viewport within a COpenGLScene, containing a set of OpenGL objects to render." alt="" coords="219,208,429,235"/><area shape="rect" id="node13" href="classmrpt_1_1slam_1_1_c_metric_map.html" title="Declares a virtual base class for all metric maps storage classes." alt="" coords="243,309,405,336"/><area shape="rect" id="node5" href="classmrpt_1_1gui_1_1_c_display_window.html" title="This class creates a window as a graphical user interface (GUI) for displaying images to the user..." alt="" coords="509,5,691,32"/><area shape="rect" id="node7" href="classmrpt_1_1gui_1_1_c_display_window3_d.html" title="A graphical user interface (GUI) for efficiently rendering 3D scenes in real-time." alt="" coords="501,56,699,83"/><area shape="rect" id="node9" href="classmrpt_1_1gui_1_1_c_display_window_plots.html" title="Create a GUI window and display plots with MATLAB-like interfaces and commands." alt="" coords="494,107,706,133"/><area shape="rect" id="node15" href="classmrpt_1_1slam_1_1_c_beacon_map.html" title="A class for storing a map of 3D probabilistic beacons, using a Montecarlo, Gaussian, or Sum of Gaussians (SOG) representation (for range-only SLAM)." alt="" coords="515,157,685,184"/><area shape="rect" id="node17" href="classmrpt_1_1slam_1_1_c_height_grid_map2_d.html" title="A mesh representation of a surface which keeps the estimated height for each (x,y) location..." alt="" coords="497,208,703,235"/><area shape="rect" id="node19" href="classmrpt_1_1slam_1_1_c_landmarks_map.html" title="A class for storing a map of 3D probabilistic landmarks." alt="" coords="505,259,695,285"/><area shape="rect" id="node21" href="classmrpt_1_1slam_1_1_c_multi_metric_map.html" title="This class stores any customizable set of metric maps." alt="" coords="505,309,695,336"/><area shape="rect" id="node23" href="classmrpt_1_1slam_1_1_c_occupancy_grid_map2_d.html" title="A class for storing an occupancy grid map." alt="" coords="483,360,717,387"/><area shape="rect" id="node25" href="classmrpt_1_1slam_1_1_c_points_map.html" title="A cloud of points in 2D or 3D, which can be built from a sequence of laser scans or other sensors..." alt="" coords="518,411,682,437"/><area shape="rect" id="node33" href="classmrpt_1_1slam_1_1_c_random_field_grid_map2_d.html" title="CRandomFieldGridMap2D represents a 2D grid map where each cell is associated one real-valued property..." alt="" coords="477,461,723,488"/><area shape="rect" id="node39" href="classmrpt_1_1slam_1_1_c_reflectivity_grid_map2_d.html" title="A 2D grid map representing the reflectivity of the environment (for example, measured with an IR prox..." alt="" coords="483,512,717,539"/><area shape="rect" id="node27" href="classmrpt_1_1slam_1_1_c_coloured_points_map.html" title="A map of 2D/3D points with individual colours (RGB)." alt="" coords="800,309,1016,336"/><area shape="rect" id="node29" href="classmrpt_1_1slam_1_1_c_simple_points_map.html" title="A cloud of points in 2D or 3D, which can be built from a sequence of laser scans." alt="" coords="806,360,1010,387"/><area shape="rect" id="node31" href="classmrpt_1_1slam_1_1_c_weighted_points_map.html" title="A cloud of points in 2D or 3D, which can be built from a sequence of laser scans." alt="" coords="799,411,1017,437"/><area shape="rect" id="node35" href="classmrpt_1_1slam_1_1_c_gas_concentration_grid_map2_d.html" title="CGasConcentrationGridMap2D represents a PDF of gas concentrations over a 2D area." alt="" coords="771,461,1045,488"/><area shape="rect" id="node37" href="classmrpt_1_1slam_1_1_c_wireless_power_grid_map2_d.html" title="CWirelessPowerGridMap2D represents a PDF of wifi concentrations over a 2D area." alt="" coords="780,512,1036,539"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classmrpt_1_1utils_1_1_c_observable-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_1utils_1_1_c_observable.html#a10e505b56b5b6a0bad788cbcbfeb6166">CObservable</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_observable.html#a59649b560042466f319ce175b2d476cc">~CObservable</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_observable.html#a0c384e00c06199bc2ff37ff5ecb520c9">publishEvent</a> (const <a class="el" href="classmrpt_1_1utils_1_1mrpt_event.html">mrptEvent</a> &e) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when you want this object to emit an event to all the observers currently subscribed to this object. <a href="#a0c384e00c06199bc2ff37ff5ecb520c9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_observable.html#a1c1e8c7d0d184ccdaa7d5a0ee5184e1e">hasSubscribers</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Can be called by a derived class before preparing an event for publishing with <em>publishEvent</em> to determine if there is no one subscribed, so it can save the wasted time preparing an event that will be not read. <a href="#a1c1e8c7d0d184ccdaa7d5a0ee5184e1e"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_observable.html#a25594493ff957135812f1d28f7c8ad81">internal_observer_begin</a> (<a class="el" href="classmrpt_1_1utils_1_1_c_observer.html">CObserver</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_observable.html#ad5c13834d83ad83e9a0bd140e3d067a8">internal_observer_end</a> (<a class="el" href="classmrpt_1_1utils_1_1_c_observer.html">CObserver</a> *)</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="classstd_1_1set.html">std::set</a>< <a class="el" href="classmrpt_1_1utils_1_1_c_observer.html">CObserver</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_observable.html#af284242c78ccac52706d5c67a3e3946f">m_subscribers</a></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_observable.html#a22c18bc499a63fbdf75b61e04846c685">CObserver</a></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a10e505b56b5b6a0bad788cbcbfeb6166"></a><!-- doxytag: member="mrpt::utils::CObservable::CObservable" ref="a10e505b56b5b6a0bad788cbcbfeb6166" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::utils::CObservable::CObservable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a59649b560042466f319ce175b2d476cc"></a><!-- doxytag: member="mrpt::utils::CObservable::~CObservable" ref="a59649b560042466f319ce175b2d476cc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual mrpt::utils::CObservable::~CObservable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1c1e8c7d0d184ccdaa7d5a0ee5184e1e"></a><!-- doxytag: member="mrpt::utils::CObservable::hasSubscribers" ref="a1c1e8c7d0d184ccdaa7d5a0ee5184e1e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::utils::CObservable::hasSubscribers </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Can be called by a derived class before preparing an event for publishing with <em>publishEvent</em> to determine if there is no one subscribed, so it can save the wasted time preparing an event that will be not read. </p>
<p>Definition at line <a class="el" href="_c_observable_8h_source.html#l00069">69</a> of file <a class="el" href="_c_observable_8h_source.html">CObservable.h</a>.</p>
</div>
</div>
<a class="anchor" id="a25594493ff957135812f1d28f7c8ad81"></a><!-- doxytag: member="mrpt::utils::CObservable::internal_observer_begin" ref="a25594493ff957135812f1d28f7c8ad81" args="(CObserver *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CObservable::internal_observer_begin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmrpt_1_1utils_1_1_c_observer.html">CObserver</a> * </td>
<td class="paramname"></td><td>)</td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad5c13834d83ad83e9a0bd140e3d067a8"></a><!-- doxytag: member="mrpt::utils::CObservable::internal_observer_end" ref="ad5c13834d83ad83e9a0bd140e3d067a8" args="(CObserver *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CObservable::internal_observer_end </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmrpt_1_1utils_1_1_c_observer.html">CObserver</a> * </td>
<td class="paramname"></td><td>)</td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0c384e00c06199bc2ff37ff5ecb520c9"></a><!-- doxytag: member="mrpt::utils::CObservable::publishEvent" ref="a0c384e00c06199bc2ff37ff5ecb520c9" args="(const mrptEvent &e) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CObservable::publishEvent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmrpt_1_1utils_1_1mrpt_event.html">mrptEvent</a> & </td>
<td class="paramname"><em>e</em></td><td>)</td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when you want this object to emit an event to all the observers currently subscribed to this object. </p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a22c18bc499a63fbdf75b61e04846c685"></a><!-- doxytag: member="mrpt::utils::CObservable::CObserver" ref="a22c18bc499a63fbdf75b61e04846c685" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classmrpt_1_1utils_1_1_c_observer.html">CObserver</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_observable_8h_source.html#l00052">52</a> of file <a class="el" href="_c_observable_8h_source.html">CObservable.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="af284242c78ccac52706d5c67a3e3946f"></a><!-- doxytag: member="mrpt::utils::CObservable::m_subscribers" ref="af284242c78ccac52706d5c67a3e3946f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstd_1_1set.html">std::set</a><<a class="el" href="classmrpt_1_1utils_1_1_c_observer.html">CObserver</a>*> <a class="el" href="classmrpt_1_1utils_1_1_c_observable.html#af284242c78ccac52706d5c67a3e3946f">mrpt::utils::CObservable::m_subscribers</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_observable_8h_source.html#l00059">59</a> of file <a class="el" href="_c_observable_8h_source.html">CObservable.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>
