rtabmap/preview/pr-1492/api/latest/classrtabmap_1_1OdometryResetEvent.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: rtabmap::OdometryResetEvent 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('classrtabmap_1_1OdometryResetEvent.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="classrtabmap_1_1OdometryResetEvent-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">rtabmap::OdometryResetEvent Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Asks <a class="el" href="classrtabmap_1_1OdometryThread.html">OdometryThread</a> to restart the odometry from a given pose.  
 <a href="classrtabmap_1_1OdometryResetEvent.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="OdometryEvent_8h_source.html">OdometryEvent.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for rtabmap::OdometryResetEvent:</div>
<div class="dyncontent">
<div class="center"><img src="classrtabmap_1_1OdometryResetEvent__inherit__graph.png" border="0" usemap="#artabmap_1_1OdometryResetEvent_inherit__map" alt="Inheritance graph"/></div>
<map name="artabmap_1_1OdometryResetEvent_inherit__map" id="artabmap_1_1OdometryResetEvent_inherit__map">
<area shape="rect" title="Asks OdometryThread to restart the odometry from a given pose." alt="" coords="5,79,229,104"/>
<area shape="rect" href="classUEvent.html" title=" " alt="" coords="83,5,152,31"/>
<area shape="poly" title=" " alt="" coords="120,44,120,79,115,79,115,44"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for rtabmap::OdometryResetEvent:</div>
<div class="dyncontent">
<div class="center"><img src="classrtabmap_1_1OdometryResetEvent__coll__graph.png" border="0" usemap="#artabmap_1_1OdometryResetEvent_coll__map" alt="Collaboration graph"/></div>
<map name="artabmap_1_1OdometryResetEvent_coll__map" id="artabmap_1_1OdometryResetEvent_coll__map">
<area shape="rect" title="Asks OdometryThread to restart the odometry from a given pose." alt="" coords="5,79,229,104"/>
<area shape="rect" href="classUEvent.html" title=" " alt="" coords="83,5,152,31"/>
<area shape="poly" title=" " alt="" coords="120,44,120,79,115,79,115,44"/>
</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:a035eee412d9bda7da321523baff799f3" id="r_a035eee412d9bda7da321523baff799f3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1OdometryResetEvent.html#a035eee412d9bda7da321523baff799f3">OdometryResetEvent</a> (const <a class="el" href="classrtabmap_1_1Transform.html">Transform</a> &amp;pose=<a class="el" href="classrtabmap_1_1Transform.html#a8ea4368f2018d751d2733038081d56a2">Transform::getIdentity</a>())</td></tr>
<tr class="separator:a035eee412d9bda7da321523baff799f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94dc8e8b7ec952c0ca2b393cc0f3e71d" id="r_a94dc8e8b7ec952c0ca2b393cc0f3e71d"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1OdometryResetEvent.html#a94dc8e8b7ec952c0ca2b393cc0f3e71d">getClassName</a> () const</td></tr>
<tr class="separator:a94dc8e8b7ec952c0ca2b393cc0f3e71d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae756dea7a2e79fd918dd4c158085bc68" id="r_ae756dea7a2e79fd918dd4c158085bc68"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classrtabmap_1_1Transform.html">Transform</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrtabmap_1_1OdometryResetEvent.html#ae756dea7a2e79fd918dd4c158085bc68">getPose</a> () const</td></tr>
<tr class="separator:ae756dea7a2e79fd918dd4c158085bc68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classUEvent"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classUEvent')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classUEvent.html">UEvent</a></td></tr>
<tr class="memitem:a7356350719dfd5ba2d28368d1fdcd143 inherit pub_methods_classUEvent" 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 inherit pub_methods_classUEvent"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classUEvent"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classUEvent')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classUEvent.html">UEvent</a></td></tr>
<tr class="memitem:a662b610c2e9ebaae5e91ed5ea1dcef34 inherit pro_methods_classUEvent" 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 inherit pro_methods_classUEvent"><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>Asks <a class="el" href="classrtabmap_1_1OdometryThread.html">OdometryThread</a> to restart the odometry from a given pose. </p>
<p>The buffered frames and <a class="el" href="classrtabmap_1_1IMU.html" title="Inertial measurement sample (ROS sensor_msgs/Imu-like fields).">IMU</a> samples are dropped, and the integration starts over from <a class="el" href="classrtabmap_1_1OdometryResetEvent.html#ae756dea7a2e79fd918dd4c158085bc68">getPose()</a>. Handled even before the thread is started.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classrtabmap_1_1OdometryThread.html" title="Runs an Odometry front-end in its own thread, driven by events.">OdometryThread</a> </dd>
<dd>
<a class="el" href="classrtabmap_1_1Odometry.html#a0ea20c39ae597a21e896b706662bb31c" title="Resets internal state and sets the initial pose.">Odometry::reset()</a> </dd></dl>

<p class="definition">Definition at line <a class="el" href="OdometryEvent_8h_source.html#l00144">144</a> of file <a class="el" href="OdometryEvent_8h_source.html">OdometryEvent.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a035eee412d9bda7da321523baff799f3" name="a035eee412d9bda7da321523baff799f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a035eee412d9bda7da321523baff799f3">&#9670;&#160;</a></span>OdometryResetEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">rtabmap::OdometryResetEvent::OdometryResetEvent </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classrtabmap_1_1Transform.html">Transform</a> &amp;&#160;</td>
          <td class="paramname"><em>pose</em> = <code><a class="el" href="classrtabmap_1_1Transform.html#a8ea4368f2018d751d2733038081d56a2">Transform::getIdentity</a>()</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pose</td><td>Pose to restart from (identity by default). </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="OdometryEvent_8h_source.html#l00148">148</a> of file <a class="el" href="OdometryEvent_8h_source.html">OdometryEvent.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual rtabmap::OdometryResetEvent::~OdometryResetEvent </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="OdometryEvent_8h_source.html#l00149">149</a> of file <a class="el" href="OdometryEvent_8h_source.html">OdometryEvent.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a94dc8e8b7ec952c0ca2b393cc0f3e71d" name="a94dc8e8b7ec952c0ca2b393cc0f3e71d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94dc8e8b7ec952c0ca2b393cc0f3e71d">&#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 rtabmap::OdometryResetEvent::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">inline</span><span class="mlabel">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>Implements <a class="el" href="classUEvent.html#a2c7d278240ad4b7d88a2c534cc5f47b4">UEvent</a>.</p>

<p class="definition">Definition at line <a class="el" href="OdometryEvent_8h_source.html#l00150">150</a> of file <a class="el" href="OdometryEvent_8h_source.html">OdometryEvent.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classrtabmap_1_1Transform.html">Transform</a> &amp; rtabmap::OdometryResetEvent::getPose </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">
<dl class="section return"><dt>Returns</dt><dd>The pose the odometry should restart from. </dd></dl>

<p class="definition">Definition at line <a class="el" href="OdometryEvent_8h_source.html#l00152">152</a> of file <a class="el" href="OdometryEvent_8h_source.html">OdometryEvent.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>corelib/include/rtabmap/core/<a class="el" href="OdometryEvent_8h_source.html">OdometryEvent.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="namespacertabmap.html">rtabmap</a></li><li class="navelem"><a class="el" href="classrtabmap_1_1OdometryResetEvent.html">OdometryResetEvent</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>