i/rtabmap
1
0
Fork 0
mirror of https://github.com/introlab/rtabmap.git synced 2026-10-04 00:57:46 +08:00
Code Issues Packages Projects Releases Wiki Activity

Preview for PR #1492 c82721341cb6b9be5ea6c74e1c195f07d4187738

Browse Source
This commit is contained in:
github-actions[bot]
2026-08-02 07:56:38 +00:00
parent 6259cf4409
commit 9043c4a9aa
1083 changed files with 121946 additions and 11202 deletions
Download Patch File Download Diff File Expand all files Collapse all files
preview/pr-1492/api/latest/classUEventsHandler.html
+36 -10
View File
@@ -10,6 +10,10 @@
<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>
@@ -27,6 +31,7 @@
<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>
@@ -50,6 +55,23 @@ $(function() {
/* @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('classUEventsHandler.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -71,7 +93,6 @@ $(function() {
</div>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
@@ -89,14 +110,14 @@ Inheritance diagram for UEventsHandler:</div>
<div class="center"><img src="classUEventsHandler__inherit__graph.png" border="0" usemap="#aUEventsHandler_inherit__map" alt="Inheritance graph"/></div>
<map name="aUEventsHandler_inherit__map" id="aUEventsHandler_inherit__map">
<area shape="rect" title=" " alt="" coords="147,79,274,104"/>
<area shape="rect" href="classrtabmap_1_1OdometryThread.html" title=" " alt="" coords="5,152,200,177"/>
<area shape="rect" href="classrtabmap_1_1OdometryThread.html" title="Runs an Odometry front&#45;end in its own thread, driven by events." alt="" coords="5,152,200,177"/>
<area shape="poly" title=" " alt="" coords="183,114,122,154,119,150,181,109"/>
<area shape="rect" href="classrtabmap_1_1RtabmapThread.html" title=" " alt="" coords="224,152,413,177"/>
<area shape="rect" href="classrtabmap_1_1RtabmapThread.html" title="Runs a Rtabmap instance in its own thread, driven by events." alt="" coords="224,152,413,177"/>
<area shape="poly" title=" " alt="" coords="241,109,302,150,300,154,238,114"/>
<area shape="rect" href="classUEventsSender.html" title=" " alt="" coords="150,5,271,31"/>
<area shape="poly" title=" " alt="" coords="213,44,213,79,208,79,208,44"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for UEventsHandler:</div>
<div class="dyncontent">
@@ -106,7 +127,7 @@ Collaboration diagram for UEventsHandler:</div>
<area shape="rect" href="classUEventsSender.html" title=" " alt="" coords="8,5,129,31"/>
<area shape="poly" title=" " alt="" coords="71,44,71,79,66,79,66,44"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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>
@@ -138,7 +159,7 @@ Friends</h2></td></tr>
<div class="textblock"><p>The class <a class="el" href="classUEventsHandler.html">UEventsHandler</a> is an abstract class for handling events.</p>
<p>Inherited classes must implement <a class="el" href="classUEventsHandler.html#a0d43b582c19f01196a513f66d3618d8d">handleEvent()</a> function, which is called by the <a class="el" href="classUEventsManager.html">UEventsManager</a> when an event is dispatched. Once the handler is created, it must be added to events manager with <a class="el" href="classUEventsManager.html#a3bb033062e4a0eb59efdf5f84d170388">UEventsManager::addHandler()</a> function. Note that it is not safe to automatically add the handler to <a class="el" href="classUEventsManager.html">UEventsManager</a> in the handler's constructor.</p>
<p>Note for multi-threading: the <a class="el" href="classUEventsHandler.html#a0d43b582c19f01196a513f66d3618d8d">handleEvent()</a> method is called inside the <a class="el" href="classUEventsManager.html">UEventsManager</a> thread. If the inherited class also inherits from UThreadNode, <a class="el" href="classUEventsHandler.html#a0d43b582c19f01196a513f66d3618d8d">handleEvent()</a> is done as well outside the thread's main loop, so be careful to protect private data of the thread used in its main loop.</p>
<p>Example for a useful combination of an <a class="el" href="classUEventsHandler.html">UEventsHandler</a> and a UThreadNode, with safe data modification while not blocking the <a class="el" href="classUEventsHandler.html#a0d43b582c19f01196a513f66d3618d8d">handleEvent()</a> call on a mutex: </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;utilite/UThreadNode.h&quot;</span></div>
<p>Example for a useful combination of an <a class="el" href="classUEventsHandler.html">UEventsHandler</a> and a UThreadNode, with safe data modification while not blocking the <a class="el" href="classUEventsHandler.html#a0d43b582c19f01196a513f66d3618d8d">handleEvent()</a> call on a mutex: </p><div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="UThreadNode_8h.html">utilite/UThreadNode.h</a>&quot;</span></div>
<div class="line"><span class="preprocessor">#include &quot;utilite/UEventsHandler.h&quot;</span></div>
<div class="line"><span class="preprocessor">#include &quot;utilite/UEventsManager.h&quot;</span></div>
<div class="line"><span class="preprocessor">#include &quot;utilite/UEvent.h&quot;</span></div>
@@ -199,6 +220,7 @@ Friends</h2></td></tr>
<div class="line"> counter.join(<span class="keyword">true</span>); <span class="comment">// Kill and wait to finish</span></div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="ttc" id="aUThreadNode_8h_html"><div class="ttname"><a href="UThreadNode_8h.html">UThreadNode.h</a></div><div class="ttdoc">Backward-compatible alias header for UThread.</div></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="aclassUEvent_html_a2c7d278240ad4b7d88a2c534cc5f47b4"><div class="ttname"><a href="classUEvent.html#a2c7d278240ad4b7d88a2c534cc5f47b4">UEvent::getClassName</a></div><div class="ttdeci">virtual std::string getClassName() const =0</div></div>
<div class="ttc" id="aclassUEventsHandler_html"><div class="ttname"><a href="classUEventsHandler.html">UEventsHandler</a></div><div class="ttdef"><b>Definition</b> <a href="UEventsHandler_8h_source.html#l00128">UEventsHandler.h:128</a></div></div>
@@ -221,7 +243,7 @@ Friends</h2></td></tr>
<dd>
<a class="el" href="classUEvent.html">UEvent</a> </dd>
<dd>
UThreadNode </dd></dl>
<a class="el" href="UThreadNode_8h.html#a82fc8ffe23f95d50f934eb27afd351d6" title="Alias for UThread, kept for backward compatibility.">UThreadNode</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="UEventsHandler_8h_source.html#l00128">128</a> of file <a class="el" href="UEventsHandler_8h_source.html">UEventsHandler.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
@@ -343,9 +365,13 @@ UThreadNode </dd></dl>
<li>utilite/include/rtabmap/utilite/<a class="el" href="UEventsHandler_8h_source.html">UEventsHandler.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classUEventsHandler.html">UEventsHandler</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>