mirror of
https://github.com/introlab/rtabmap.git
synced 2026-10-04 00:57:46 +08:00
278 lines
15 KiB
HTML
278 lines
15 KiB
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: UTimer 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"> 0.23.12</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&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&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&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('classUTimer.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> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="classUTimer-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">UTimer Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="UTimer_8h_source.html">UTimer.h</a>></code></p>
|
|
<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:a10f628d8be04474d13c04b07c0426200" id="r_a10f628d8be04474d13c04b07c0426200"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUTimer.html#a10f628d8be04474d13c04b07c0426200">start</a> ()</td></tr>
|
|
<tr class="separator:a10f628d8be04474d13c04b07c0426200"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a517d6f5f6e6c28b9392d04be22a320" id="r_a6a517d6f5f6e6c28b9392d04be22a320"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUTimer.html#a6a517d6f5f6e6c28b9392d04be22a320">stop</a> ()</td></tr>
|
|
<tr class="separator:a6a517d6f5f6e6c28b9392d04be22a320"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a372405f02e1d4e9571a73d80962d6f4c" id="r_a372405f02e1d4e9571a73d80962d6f4c"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classUTimer.html#a372405f02e1d4e9571a73d80962d6f4c">elapsed</a> ()</td></tr>
|
|
<tr class="separator:a372405f02e1d4e9571a73d80962d6f4c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a4db71ee1852fcd6dd8eba9fe1db30b" id="r_a1a4db71ee1852fcd6dd8eba9fe1db30b"><td class="memItemLeft" align="right" valign="top"><a id="a1a4db71ee1852fcd6dd8eba9fe1db30b" name="a1a4db71ee1852fcd6dd8eba9fe1db30b"></a>
|
|
double </td><td class="memItemRight" valign="bottom"><b>getElapsedTime</b> ()</td></tr>
|
|
<tr class="separator:a1a4db71ee1852fcd6dd8eba9fe1db30b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4db57cf682a403fba8ddf95d268d2a6" id="r_aa4db57cf682a403fba8ddf95d268d2a6"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classUTimer.html#aa4db57cf682a403fba8ddf95d268d2a6">restart</a> ()</td></tr>
|
|
<tr class="separator:aa4db57cf682a403fba8ddf95d268d2a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed9550d86073c827bb5aa1e843d3d686" id="r_aed9550d86073c827bb5aa1e843d3d686"><td class="memItemLeft" align="right" valign="top"><a id="aed9550d86073c827bb5aa1e843d3d686" name="aed9550d86073c827bb5aa1e843d3d686"></a>
|
|
double </td><td class="memItemRight" valign="bottom"><b>ticks</b> ()</td></tr>
|
|
<tr class="separator:aed9550d86073c827bb5aa1e843d3d686"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ad10fce2a4901bf5d6a460ca7b158cb3a" id="r_ad10fce2a4901bf5d6a460ca7b158cb3a"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="classUTimer.html#ad10fce2a4901bf5d6a460ca7b158cb3a">now</a> ()</td></tr>
|
|
<tr class="separator:ad10fce2a4901bf5d6a460ca7b158cb3a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>This class is used to time some codes (in seconds). On Unix, the resolution is up to microseconds (see gettimeofday()). On Windows, the performance counter is used (see QueryPerformanceCounter() and QueryPerformanceFrequency()). Example: </p><div class="fragment"><div class="line"><a class="code hl_class" href="classUTimer.html">UTimer</a> timer;</div>
|
|
<div class="line">timer.<a class="code hl_function" href="classUTimer.html#a10f628d8be04474d13c04b07c0426200">start</a>();</div>
|
|
<div class="line">... (<span class="keywordflow">do</span> some work)</div>
|
|
<div class="line">timer.<a class="code hl_function" href="classUTimer.html#a6a517d6f5f6e6c28b9392d04be22a320">stop</a>();</div>
|
|
<div class="line"><span class="keywordtype">double</span> seconds = timer.getInterval();</div>
|
|
<div class="line">...</div>
|
|
<div class="ttc" id="aclassUTimer_html"><div class="ttname"><a href="classUTimer.html">UTimer</a></div><div class="ttdef"><b>Definition</b> <a href="UTimer_8h_source.html#l00046">UTimer.h:47</a></div></div>
|
|
<div class="ttc" id="aclassUTimer_html_a10f628d8be04474d13c04b07c0426200"><div class="ttname"><a href="classUTimer.html#a10f628d8be04474d13c04b07c0426200">UTimer::start</a></div><div class="ttdeci">void start()</div></div>
|
|
<div class="ttc" id="aclassUTimer_html_a6a517d6f5f6e6c28b9392d04be22a320"><div class="ttname"><a href="classUTimer.html#a6a517d6f5f6e6c28b9392d04be22a320">UTimer::stop</a></div><div class="ttdeci">void stop()</div></div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="UTimer_8h_source.html#l00046">46</a> of file <a class="el" href="UTimer_8h_source.html">UTimer.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ad10fce2a4901bf5d6a460ca7b158cb3a" name="ad10fce2a4901bf5d6a460ca7b158cb3a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad10fce2a4901bf5d6a460ca7b158cb3a">◆ </a></span>now()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static double UTimer::now </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This method is used to get the time of the system right now. </p><dl class="section return"><dt>Returns</dt><dd>double the time in seconds. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a10f628d8be04474d13c04b07c0426200" name="a10f628d8be04474d13c04b07c0426200"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a10f628d8be04474d13c04b07c0426200">◆ </a></span>start()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void UTimer::start </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This method starts the timer. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6a517d6f5f6e6c28b9392d04be22a320" name="a6a517d6f5f6e6c28b9392d04be22a320"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6a517d6f5f6e6c28b9392d04be22a320">◆ </a></span>stop()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void UTimer::stop </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This method stops the timer. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a372405f02e1d4e9571a73d80962d6f4c" name="a372405f02e1d4e9571a73d80962d6f4c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a372405f02e1d4e9571a73d80962d6f4c">◆ </a></span>elapsed()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double UTimer::elapsed </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This method is used to get the elapsed time between now and the <a class="el" href="classUTimer.html#a10f628d8be04474d13c04b07c0426200">start()</a>. If timer is stopped, the interval time between <a class="el" href="classUTimer.html#a6a517d6f5f6e6c28b9392d04be22a320">stop()</a> and the <a class="el" href="classUTimer.html#a10f628d8be04474d13c04b07c0426200">start()</a> is returned. </p><dl class="section return"><dt>Returns</dt><dd>double the interval in seconds. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="UTimer_8h_source.html#l00075">75</a> of file <a class="el" href="UTimer_8h_source.html">UTimer.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa4db57cf682a403fba8ddf95d268d2a6" name="aa4db57cf682a403fba8ddf95d268d2a6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa4db57cf682a403fba8ddf95d268d2a6">◆ </a></span>restart()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double UTimer::restart </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This method is used to get the interval of the timer while it is running. It's automatically stop the timer, get the interval and restart the timer. It's the same of calling <a class="el" href="classUTimer.html#a6a517d6f5f6e6c28b9392d04be22a320">stop()</a>, <a class="el" href="classUTimer.html#a372405f02e1d4e9571a73d80962d6f4c">elapsed()</a> and <a class="el" href="classUTimer.html#a10f628d8be04474d13c04b07c0426200">start()</a>. Method <a class="el" href="classUTimer.html#aa4db57cf682a403fba8ddf95d268d2a6">restart()</a> does the same thing, for convenience. </p><dl class="section return"><dt>Returns</dt><dd>double the interval in seconds. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="UTimer_8h_source.html#l00086">86</a> of file <a class="el" href="UTimer_8h_source.html">UTimer.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="UTimer_8h_source.html">UTimer.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="classUTimer.html">UTimer</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>
|