preview/pr-1492/api/latest/classUEvent.html

<!-- HTML header for doxygen 1.9.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>RTAB-Map: UEvent Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="custom.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript">window.RTABMAP_DOC_ROOT="";</script>
<script type="text/javascript" src="../versions.js"></script>
<script type="text/javascript" src="version-switcher.js"></script>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">DoxygenAwesomeDarkModeToggle.init();</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">RTAB-Map<span id="projectnumber">&#160;0.23.10</span>
   </div>
   <div id="projectbrief">Real-Time Appearance-Based Mapping</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classUEvent.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classUEvent-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">UEvent Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="UEvent_8h_source.html">UEvent.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for UEvent:</div>
<div class="dyncontent">
<div class="center"><img src="classUEvent__inherit__graph.png" border="0" usemap="#aUEvent_inherit__map" alt="Inheritance graph"/></div>
<map name="aUEvent_inherit__map" id="aUEvent_inherit__map">
<area shape="rect" title=" " alt="" coords="5,351,75,376"/>
<area shape="rect" href="classULogEvent.html" title=" " alt="" coords="190,5,282,31"/>
<area shape="poly" title=" " alt="" coords="42,337,52,267,68,178,91,95,105,62,121,40,136,29,153,21,189,14,190,20,155,26,139,33,125,44,110,65,96,97,73,180,57,268,47,337"/>
<area shape="rect" href="classUObjDeletedEvent.html" title=" " alt="" coords="165,55,307,80"/>
<area shape="poly" title=" " alt="" coords="38,337,41,284,53,218,63,183,78,149,97,117,121,89,141,76,164,68,166,73,143,81,124,93,101,120,82,151,68,184,58,219,47,285,44,337"/>
<area shape="rect" href="classrtabmap_1_1IMUEvent.html" title="UEvent carrying an IMU sample and timestamp." alt="" coords="162,104,310,129"/>
<area shape="poly" title=" " alt="" coords="40,337,46,293,60,240,84,185,100,160,121,139,140,126,161,119,162,124,142,131,124,143,105,164,88,188,65,241,52,294,46,337"/>
<area shape="rect" href="classrtabmap_1_1OdometryEvent.html" title="One processed frame with the pose the odometry integrated for it." alt="" coords="143,153,329,179"/>
<area shape="poly" title=" " alt="" coords="43,336,52,302,67,262,90,222,121,188,141,176,144,181,124,192,94,225,72,264,57,304,49,338"/>
<area shape="rect" href="classrtabmap_1_1OdometryResetEvent.html" title="Asks OdometryThread to restart the odometry from a given pose." alt="" coords="124,203,348,228"/>
<area shape="poly" title=" " alt="" coords="49,337,76,286,96,259,121,237,143,226,145,231,124,242,100,263,80,288,53,339"/>
<area shape="rect" href="classrtabmap_1_1ParamEvent.html" title=" " alt="" coords="155,252,317,277"/>
<area shape="poly" title=" " alt="" coords="58,338,86,311,121,286,154,274,155,279,124,291,90,315,62,342"/>
<area shape="rect" href="classrtabmap_1_1RtabmapEvent.html" title=" " alt="" coords="145,301,327,327"/>
<area shape="poly" title=" " alt="" coords="87,346,122,335,170,324,171,329,123,341,88,351"/>
<area shape="rect" href="classrtabmap_1_1RtabmapEvent3DMap.html" title=" " alt="" coords="123,351,349,376"/>
<area shape="poly" title=" " alt="" coords="89,361,123,361,123,366,89,366"/>
<area shape="rect" href="classrtabmap_1_1RtabmapEventCmd.html" title="Command sent to RtabmapThread, with its parameters." alt="" coords="131,400,341,425"/>
<area shape="poly" title=" " alt="" coords="88,375,123,385,176,397,175,403,122,390,87,380"/>
<area shape="rect" href="classrtabmap_1_1RtabmapEventInit.html" title=" " alt="" coords="135,449,337,475"/>
<area shape="poly" title=" " alt="" coords="63,384,90,411,124,434,156,447,154,452,121,439,87,415,59,388"/>
<area shape="rect" href="classrtabmap_1_1RtabmapGlobalPathEvent.html" title=" " alt="" coords="129,499,343,539"/>
<area shape="poly" title=" " alt="" coords="54,388,81,437,101,462,124,484,147,497,144,502,121,488,97,466,77,440,49,390"/>
<area shape="rect" href="classrtabmap_1_1RtabmapGoalStatusEvent.html" title=" " alt="" coords="129,563,343,603"/>
<area shape="poly" title=" " alt="" coords="48,389,56,425,71,469,93,512,124,549,141,561,138,565,121,553,89,515,66,471,51,427,43,390"/>
<area shape="rect" href="classrtabmap_1_1RtabmapLabelErrorEvent.html" title=" " alt="" coords="131,627,341,667"/>
<area shape="poly" title=" " alt="" coords="45,390,50,438,62,498,86,560,103,588,124,613,140,625,137,629,121,617,99,592,81,563,57,500,44,439,39,391"/>
<area shape="rect" href="classrtabmap_1_1SensorEvent.html" title="Event class for sensor data communication in RTAB&#45;Map&#39;s event system." alt="" coords="153,692,319,717"/>
<area shape="poly" title=" " alt="" coords="47,389,57,458,74,544,97,626,110,657,124,677,154,695,151,699,121,681,105,659,92,627,69,546,52,459,42,390"/>
<area shape="rect" href="classrtabmap_1_1UserDataEvent.html" title=" " alt="" coords="145,741,327,767"/>
<area shape="poly" title=" " alt="" coords="46,389,55,467,70,569,94,665,108,702,125,727,146,741,143,746,121,731,103,705,88,667,65,570,49,468,41,390"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2c7d278240ad4b7d88a2c534cc5f47b4" id="r_a2c7d278240ad4b7d88a2c534cc5f47b4"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUEvent.html#a2c7d278240ad4b7d88a2c534cc5f47b4">getClassName</a> () const =0</td></tr>
<tr class="separator:a2c7d278240ad4b7d88a2c534cc5f47b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7356350719dfd5ba2d28368d1fdcd143" id="r_a7356350719dfd5ba2d28368d1fdcd143"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUEvent.html#a7356350719dfd5ba2d28368d1fdcd143">getCode</a> () const</td></tr>
<tr class="separator:a7356350719dfd5ba2d28368d1fdcd143"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a662b610c2e9ebaae5e91ed5ea1dcef34" id="r_a662b610c2e9ebaae5e91ed5ea1dcef34"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUEvent.html#a662b610c2e9ebaae5e91ed5ea1dcef34">UEvent</a> (int code=0)</td></tr>
<tr class="separator:a662b610c2e9ebaae5e91ed5ea1dcef34"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This is the base class for all events used with the <a class="el" href="classUEventsManager.html">UEventsManager</a>. Inherited classes must redefined the virtual method <a class="el" href="classUEvent.html#a2c7d278240ad4b7d88a2c534cc5f47b4">getClassName()</a> to return their class name.</p>
<p>Example: </p><div class="fragment"><div class="line"><span class="keyword">class </span>MyEvent : <span class="keyword">public</span> <a class="code hl_class" href="classUEvent.html">UEvent</a></div>
<div class="line">{</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line">   MyEvent() {}</div>
<div class="line">   <span class="keyword">virtual</span> ~MyEvent() {}</div>
<div class="line">   std::string getClassName()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="stringliteral">&quot;MyEvent&quot;</span>;}</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> * argv[])</div>
<div class="line">{</div>
<div class="line"> ...</div>
<div class="line"> <a class="code hl_function" href="classUEventsManager.html#a956353a8006abe2edb0be2e1fc1846cb">UEventsManager::post</a>(<span class="keyword">new</span> MyEvent()); <span class="comment">// UEventsManager take ownership of the event (deleted by UEventsManager).</span></div>
<div class="line"> ...</div>
<div class="line">}</div>
<div class="ttc" id="aclassUEvent_html"><div class="ttname"><a href="classUEvent.html">UEvent</a></div><div class="ttdef"><b>Definition</b> <a href="UEvent_8h_source.html#l00057">UEvent.h:57</a></div></div>
<div class="ttc" id="aclassUEventsManager_html_a956353a8006abe2edb0be2e1fc1846cb"><div class="ttname"><a href="classUEventsManager.html#a956353a8006abe2edb0be2e1fc1846cb">UEventsManager::post</a></div><div class="ttdeci">static void post(UEvent *event, bool async=true, const UEventsSender *sender=0)</div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="classUEventsManager.html">UEventsManager</a> </dd>
<dd>
<a class="el" href="classUEventsHandler.html">UEventsHandler</a> </dd>
<dd>
<a class="el" href="classUEvent.html#a2c7d278240ad4b7d88a2c534cc5f47b4">getClassName()</a> </dd></dl>

<p class="definition">Definition at line <a class="el" href="UEvent_8h_source.html#l00057">57</a> of file <a class="el" href="UEvent_8h_source.html">UEvent.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aea8772f96437a02fadd4435934da77b1" name="aea8772f96437a02fadd4435934da77b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea8772f96437a02fadd4435934da77b1">&#9670;&#160;</a></span>~UEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual UEvent::~UEvent </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="UEvent_8h_source.html#l00059">59</a> of file <a class="el" href="UEvent_8h_source.html">UEvent.h</a>.</p>

</div>
</div>
<a id="a662b610c2e9ebaae5e91ed5ea1dcef34" name="a662b610c2e9ebaae5e91ed5ea1dcef34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a662b610c2e9ebaae5e91ed5ea1dcef34">&#9670;&#160;</a></span>UEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">UEvent::UEvent </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>code</em> = <code>0</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">code</td><td>the event code. TODO : Remove the code, not required for most of all implemented events </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="UEvent_8h_source.html#l00081">81</a> of file <a class="el" href="UEvent_8h_source.html">UEvent.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2c7d278240ad4b7d88a2c534cc5f47b4" name="a2c7d278240ad4b7d88a2c534cc5f47b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c7d278240ad4b7d88a2c534cc5f47b4">&#9670;&#160;</a></span>getClassName()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string UEvent::getClassName </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>This method is used to get the class name of the event. For example, if a class MouseEvent inherits from <a class="el" href="classUEvent.html">UEvent</a>, it must return the "MouseEvent" string. </p><dl class="section return"><dt>Returns</dt><dd>the class name </dd></dl>

<p>Implemented in <a class="el" href="classrtabmap_1_1IMUEvent.html#adf3482d48ccbf36daa039efb596405d0">rtabmap::IMUEvent</a>, <a class="el" href="classrtabmap_1_1OdometryEvent.html#a461365124cbdf488d3a05874be8c4bb2">rtabmap::OdometryEvent</a>, <a class="el" href="classrtabmap_1_1OdometryResetEvent.html#a94dc8e8b7ec952c0ca2b393cc0f3e71d">rtabmap::OdometryResetEvent</a>, <a class="el" href="classrtabmap_1_1ParamEvent.html#a877e2b7fedcb8aba63e3430d7f975e0a">rtabmap::ParamEvent</a>, <a class="el" href="classrtabmap_1_1RtabmapEvent.html#ae548b73bb3504a10a4e40592648f42b8">rtabmap::RtabmapEvent</a>, <a class="el" href="classrtabmap_1_1RtabmapEventCmd.html#a23c1b76dc2e8d6223cb52cb4fcaf7b5c">rtabmap::RtabmapEventCmd</a>, <a class="el" href="classrtabmap_1_1RtabmapEventInit.html#ac10fa3c98f98804d1059b2673233bf0c">rtabmap::RtabmapEventInit</a>, <a class="el" href="classrtabmap_1_1RtabmapEvent3DMap.html#ad2d9581145b56762e1d9ae5f04101db5">rtabmap::RtabmapEvent3DMap</a>, <a class="el" href="classrtabmap_1_1RtabmapGlobalPathEvent.html#a5dd474b3110c9d4bb53a832aaeda8145">rtabmap::RtabmapGlobalPathEvent</a>, <a class="el" href="classrtabmap_1_1RtabmapLabelErrorEvent.html#ab41ac9cdd98c1d94b1a8dc9a21364315">rtabmap::RtabmapLabelErrorEvent</a>, <a class="el" href="classrtabmap_1_1RtabmapGoalStatusEvent.html#aa90a7d8a6afe4de12b28f68aaf4f2897">rtabmap::RtabmapGoalStatusEvent</a>, <a class="el" href="classrtabmap_1_1SensorEvent.html#a7bb8ca3a235aa8b58227bc50e19d7493">rtabmap::SensorEvent</a>, <a class="el" href="classrtabmap_1_1UserDataEvent.html#a26248169380397c47377310d61090385">rtabmap::UserDataEvent</a>, <a class="el" href="classULogEvent.html#a70ec329f7f43a18805469302ffddc610">ULogEvent</a>, and <a class="el" href="classUObjDeletedEvent.html#adb1ad42f6258d12eee9da77d6f129633">UObjDeletedEvent</a>.</p>

</div>
</div>
<a id="a7356350719dfd5ba2d28368d1fdcd143" name="a7356350719dfd5ba2d28368d1fdcd143"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7356350719dfd5ba2d28368d1fdcd143">&#9670;&#160;</a></span>getCode()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int UEvent::getCode </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Get event's code. </p><dl class="section return"><dt>Returns</dt><dd>the code </dd></dl>

<p class="definition">Definition at line <a class="el" href="UEvent_8h_source.html#l00074">74</a> of file <a class="el" href="UEvent_8h_source.html">UEvent.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>utilite/include/rtabmap/utilite/<a class="el" href="UEvent_8h_source.html">UEvent.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classUEvent.html">UEvent</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
  </ul>
</div>
</body>
</html>