<!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>mrptEvent.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">mrptEvent.h</div> </div>
</div>
<div class="contents">
<a href="mrpt_event_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* +---------------------------------------------------------------------------+</span>
<a name="l00002"></a>00002 <span class="comment"> | The Mobile Robot Programming Toolkit (MRPT) C++ library |</span>
<a name="l00003"></a>00003 <span class="comment"> | |</span>
<a name="l00004"></a>00004 <span class="comment"> | http://www.mrpt.org/ |</span>
<a name="l00005"></a>00005 <span class="comment"> | |</span>
<a name="l00006"></a>00006 <span class="comment"> | Copyright (C) 2005-2011 University of Malaga |</span>
<a name="l00007"></a>00007 <span class="comment"> | |</span>
<a name="l00008"></a>00008 <span class="comment"> | This software was written by the Machine Perception and Intelligent |</span>
<a name="l00009"></a>00009 <span class="comment"> | Robotics Lab, University of Malaga (Spain). |</span>
<a name="l00010"></a>00010 <span class="comment"> | Contact: Jose-Luis Blanco <jlblanco@ctima.uma.es> |</span>
<a name="l00011"></a>00011 <span class="comment"> | |</span>
<a name="l00012"></a>00012 <span class="comment"> | This file is part of the MRPT project. |</span>
<a name="l00013"></a>00013 <span class="comment"> | |</span>
<a name="l00014"></a>00014 <span class="comment"> | MRPT is free software: you can redistribute it and/or modify |</span>
<a name="l00015"></a>00015 <span class="comment"> | it under the terms of the GNU General Public License as published by |</span>
<a name="l00016"></a>00016 <span class="comment"> | the Free Software Foundation, either version 3 of the License, or |</span>
<a name="l00017"></a>00017 <span class="comment"> | (at your option) any later version. |</span>
<a name="l00018"></a>00018 <span class="comment"> | |</span>
<a name="l00019"></a>00019 <span class="comment"> | MRPT is distributed in the hope that it will be useful, |</span>
<a name="l00020"></a>00020 <span class="comment"> | but WITHOUT ANY WARRANTY; without even the implied warranty of |</span>
<a name="l00021"></a>00021 <span class="comment"> | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |</span>
<a name="l00022"></a>00022 <span class="comment"> | GNU General Public License for more details. |</span>
<a name="l00023"></a>00023 <span class="comment"> | |</span>
<a name="l00024"></a>00024 <span class="comment"> | You should have received a copy of the GNU General Public License |</span>
<a name="l00025"></a>00025 <span class="comment"> | along with MRPT. If not, see <http://www.gnu.org/licenses/>. |</span>
<a name="l00026"></a>00026 <span class="comment"> | |</span>
<a name="l00027"></a>00027 <span class="comment"> +---------------------------------------------------------------------------+ */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef mrptEvent_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define mrptEvent_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="utils__defs_8h.html">mrpt/utils/utils_defs.h</a>></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <<a class="code" href="datetime_8h.html">mrpt/system/datetime.h</a>></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">namespace </span>mrpt
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036 <span class="keyword">namespace </span>utils
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <span class="keyword">class </span>CObservable;
<a name="l00039"></a>00039 <span class="comment"></span>
<a name="l00040"></a>00040 <span class="comment"> /** The basic event type for the observer-observable pattern in MRPT.</span>
<a name="l00041"></a>00041 <span class="comment"> * You can sub-class this base class to create custom event types, then</span>
<a name="l00042"></a>00042 <span class="comment"> * tell between them in runtime with isOfType<T>(), for example:</span>
<a name="l00043"></a>00043 <span class="comment"> * \code</span>
<a name="l00044"></a>00044 <span class="comment"> * if (e.isOfType<mrptEventOnDestroy>())</span>
<a name="l00045"></a>00045 <span class="comment"> * {</span>
<a name="l00046"></a>00046 <span class="comment"> * const mrptEventOnDestroy* ev = e.getAs<mrptEventOnDestroy>();</span>
<a name="l00047"></a>00047 <span class="comment"> * ev-> ...</span>
<a name="l00048"></a>00048 <span class="comment"> * }</span>
<a name="l00049"></a>00049 <span class="comment"> * \endcode</span>
<a name="l00050"></a>00050 <span class="comment"> *</span>
<a name="l00051"></a>00051 <span class="comment"> * \sa CObserver, CObservable</span>
<a name="l00052"></a>00052 <span class="comment"> * \ingroup mrpt_base_grp</span>
<a name="l00053"></a>00053 <span class="comment"> */</span>
<a name="l00054"></a>00054 <span class="keyword">class </span><a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> mrptEvent
<a name="l00055"></a>00055 {
<a name="l00056"></a>00056 <span class="keyword">protected</span>:
<a name="l00057"></a><a class="code" href="classmrpt_1_1utils_1_1mrpt_event.html#acfe7c36c5c89d7efd437f83870171f0a">00057</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1utils_1_1mrpt_event.html#acfe7c36c5c89d7efd437f83870171f0a" title="Just to allow this class to be polymorphic.">do_nothing</a>() { } <span class="comment">//!< Just to allow this class to be polymorphic</span>
<a name="l00058"></a>00058 <span class="comment"></span> <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> /** Default ctor */</span>
<a name="l00060"></a><a class="code" href="classmrpt_1_1utils_1_1mrpt_event.html#a8a2e1e1de9f534f2eace62dcfbee7e7a">00060</a> <span class="keyword">inline</span> <a class="code" href="classmrpt_1_1utils_1_1mrpt_event.html#a8a2e1e1de9f534f2eace62dcfbee7e7a" title="Default ctor.">mrptEvent</a>() : timestamp(mrpt::system::<a class="code" href="group__time__date.html#ga8cfac7450724f121d3a6a40a4b9ce205" title="A shortcut for system::getCurrentTime.">now</a>()) { }
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keyword">template</span> <<span class="keyword">class</span> EVENTTYPE>
<a name="l00063"></a><a class="code" href="classmrpt_1_1utils_1_1mrpt_event.html#aa9971e6282c268bd4380e294bfb71b60">00063</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classmrpt_1_1utils_1_1mrpt_event.html#aa9971e6282c268bd4380e294bfb71b60">isOfType</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">dynamic_cast<</span><span class="keyword">const </span>EVENTTYPE*<span class="keyword">></span>(<span class="keyword">this</span>)!=NULL; }
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keyword">template</span> <<span class="keyword">class</span> EVENTTYPE>
<a name="l00066"></a><a class="code" href="classmrpt_1_1utils_1_1mrpt_event.html#ab487ce428310b75d268edadff6be6c0c">00066</a> <span class="keyword">inline</span> <span class="keyword">const</span> EVENTTYPE* <a class="code" href="classmrpt_1_1utils_1_1mrpt_event.html#ab487ce428310b75d268edadff6be6c0c">getAs</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">dynamic_cast<</span><span class="keyword">const </span>EVENTTYPE*<span class="keyword">></span>(<span class="keyword">this</span>); }
<a name="l00067"></a>00067
<a name="l00068"></a><a class="code" href="classmrpt_1_1utils_1_1mrpt_event.html#aceba670cb9ef07097a20af98b5e40f61">00068</a> mrpt<a class="code" href="group__time__date.html#ga42674286d8d56afea013b6329bb7327a" title="A system independent time type, it holds the the number of 100-nanosecond intervals since January 1...">::system::TTimeStamp</a> <a class="code" href="classmrpt_1_1utils_1_1mrpt_event.html#aceba670cb9ef07097a20af98b5e40f61">timestamp</a>;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 }; <span class="comment">// End of class def.</span>
<a name="l00071"></a>00071 <span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> /** An event sent by any CObservable object (automatically) just before being destroyed and telling its observers to unsubscribe.</span>
<a name="l00073"></a>00073 <span class="comment"> * \ingroup mrpt_base_grp</span>
<a name="l00074"></a>00074 <span class="comment"> */</span>
<a name="l00075"></a>00075 <span class="keyword">class </span><a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="classmrpt_1_1utils_1_1mrpt_event_on_destroy.html" title="An event sent by any CObservable object (automatically) just before being destroyed and telling its o...">mrptEventOnDestroy</a> : <span class="keyword">public</span> <a class="code" href="classmrpt_1_1utils_1_1mrpt_event.html" title="The basic event type for the observer-observable pattern in MRPT.">mrptEvent</a>
<a name="l00076"></a>00076 {
<a name="l00077"></a>00077 <span class="keyword">protected</span>:
<a name="l00078"></a><a class="code" href="classmrpt_1_1utils_1_1mrpt_event_on_destroy.html#afd57a1b738e02f6fa49b972715dcc98c">00078</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1utils_1_1mrpt_event_on_destroy.html#afd57a1b738e02f6fa49b972715dcc98c" title="Just to allow this class to be polymorphic.">do_nothing</a>() { } <span class="comment">//!< Just to allow this class to be polymorphic</span>
<a name="l00079"></a>00079 <span class="comment"></span> <span class="keyword">public</span>:
<a name="l00080"></a><a class="code" href="classmrpt_1_1utils_1_1mrpt_event_on_destroy.html#a6b8b2988914d4622ccfeda39f16fd0f3">00080</a> <span class="keyword">inline</span> <a class="code" href="classmrpt_1_1utils_1_1mrpt_event_on_destroy.html#a6b8b2988914d4622ccfeda39f16fd0f3">mrptEventOnDestroy</a>(<span class="keyword">const</span> <a class="code" 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> *obj) : source_object(obj) { }
<a name="l00081"></a>00081
<a name="l00082"></a><a class="code" href="classmrpt_1_1utils_1_1mrpt_event_on_destroy.html#ab3e86bcecf3a9871b9e1e9e956b22ab4">00082</a> <span class="keyword">const</span> <a class="code" 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="code" href="classmrpt_1_1utils_1_1mrpt_event_on_destroy.html#ab3e86bcecf3a9871b9e1e9e956b22ab4">source_object</a>;
<a name="l00083"></a>00083
<a name="l00084"></a>00084 }; <span class="comment">// End of class def.</span>
<a name="l00085"></a>00085
<a name="l00086"></a>00086 } <span class="comment">// End of namespace</span>
<a name="l00087"></a>00087 } <span class="comment">// end of namespace</span>
<a name="l00088"></a>00088 <span class="preprocessor">#endif</span>
</pre></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>
