mirror of
https://github.com/introlab/rtabmap.git
synced 2026-10-04 00:57:46 +08:00
683 lines
30 KiB
HTML
683 lines
30 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: UFile 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.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&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('classUFile.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="classUFile-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">UFile Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="UFile_8h_source.html">UFile.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:a19572c749b383b5fc15aca3615cdc682" id="r_a19572c749b383b5fc15aca3615cdc682"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#a19572c749b383b5fc15aca3615cdc682">UFile</a> (const std::string &path)</td></tr>
|
|
<tr class="separator:a19572c749b383b5fc15aca3615cdc682"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad0ecde61a088d9fc3d034a513133341d" id="r_ad0ecde61a088d9fc3d034a513133341d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#ad0ecde61a088d9fc3d034a513133341d">isValid</a> ()</td></tr>
|
|
<tr class="separator:ad0ecde61a088d9fc3d034a513133341d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4963afa70289718a3bd1ca50b6adb420" id="r_a4963afa70289718a3bd1ca50b6adb420"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#a4963afa70289718a3bd1ca50b6adb420">exists</a> ()</td></tr>
|
|
<tr class="separator:a4963afa70289718a3bd1ca50b6adb420"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c42f32c914b349d13103d0397c1b3c1" id="r_a0c42f32c914b349d13103d0397c1b3c1"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#a0c42f32c914b349d13103d0397c1b3c1">length</a> ()</td></tr>
|
|
<tr class="separator:a0c42f32c914b349d13103d0397c1b3c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4918a111f92f2fdb7406fbd1661a1587" id="r_a4918a111f92f2fdb7406fbd1661a1587"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#a4918a111f92f2fdb7406fbd1661a1587">rename</a> (const std::string &newName)</td></tr>
|
|
<tr class="separator:a4918a111f92f2fdb7406fbd1661a1587"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7e7f5995b05cda098037ca1cdcd63f4" id="r_af7e7f5995b05cda098037ca1cdcd63f4"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#af7e7f5995b05cda098037ca1cdcd63f4">getName</a> ()</td></tr>
|
|
<tr class="separator:af7e7f5995b05cda098037ca1cdcd63f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa937b9f20ef2e51091845c5108ded154" id="r_aa937b9f20ef2e51091845c5108ded154"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#aa937b9f20ef2e51091845c5108ded154">getExtension</a> ()</td></tr>
|
|
<tr class="separator:aa937b9f20ef2e51091845c5108ded154"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa02141310fab62290721deee433f6314" id="r_aa02141310fab62290721deee433f6314"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#aa02141310fab62290721deee433f6314">copy</a> (const std::string &to)</td></tr>
|
|
<tr class="separator:aa02141310fab62290721deee433f6314"><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:ab8719ee88436205b171674060eaa4dea" id="r_ab8719ee88436205b171674060eaa4dea"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#ab8719ee88436205b171674060eaa4dea">exists</a> (const std::string &filePath)</td></tr>
|
|
<tr class="separator:ab8719ee88436205b171674060eaa4dea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1415739da256633ad417ac7d5fc2c11" id="r_ae1415739da256633ad417ac7d5fc2c11"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#ae1415739da256633ad417ac7d5fc2c11">length</a> (const std::string &filePath)</td></tr>
|
|
<tr class="separator:ae1415739da256633ad417ac7d5fc2c11"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1faba3e78bb915a685d82f0696e1ec02" id="r_a1faba3e78bb915a685d82f0696e1ec02"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#a1faba3e78bb915a685d82f0696e1ec02">erase</a> (const std::string &filePath)</td></tr>
|
|
<tr class="separator:a1faba3e78bb915a685d82f0696e1ec02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a725e2edf4b5f603bfc688e96c76858d4" id="r_a725e2edf4b5f603bfc688e96c76858d4"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#a725e2edf4b5f603bfc688e96c76858d4">rename</a> (const std::string &oldFilePath, const std::string &newFilePath)</td></tr>
|
|
<tr class="separator:a725e2edf4b5f603bfc688e96c76858d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3e7905705a69b747e1ed6b6e37b19f3f" id="r_a3e7905705a69b747e1ed6b6e37b19f3f"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#a3e7905705a69b747e1ed6b6e37b19f3f">getName</a> (const std::string &filePath)</td></tr>
|
|
<tr class="separator:a3e7905705a69b747e1ed6b6e37b19f3f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac630657b2f15288df6ecddec029b42c6" id="r_ac630657b2f15288df6ecddec029b42c6"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#ac630657b2f15288df6ecddec029b42c6">getExtension</a> (const std::string &filePath)</td></tr>
|
|
<tr class="separator:ac630657b2f15288df6ecddec029b42c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa99e6dc81f23e17ce92bd848dfe5a2f4" id="r_aa99e6dc81f23e17ce92bd848dfe5a2f4"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUFile.html#aa99e6dc81f23e17ce92bd848dfe5a2f4">copy</a> (const std::string &from, const std::string &to)</td></tr>
|
|
<tr class="separator:aa99e6dc81f23e17ce92bd848dfe5a2f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Class <a class="el" href="classUFile.html">UFile</a>.</p>
|
|
<p>This class can be used to modify/erase files on hard drive. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="UFile_8h_source.html#l00033">33</a> of file <a class="el" href="UFile_8h_source.html">UFile.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a19572c749b383b5fc15aca3615cdc682" name="a19572c749b383b5fc15aca3615cdc682"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a19572c749b383b5fc15aca3615cdc682">◆ </a></span>UFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">UFile::UFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>path</em></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>Create a <a class="el" href="classUFile.html">UFile</a> object with path initialized to an existing file . </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>the path to an existing file </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="UFile_8h_source.html#l00091">91</a> of file <a class="el" href="UFile_8h_source.html">UFile.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4f74e28f98898e3603140b6409fa52ba" name="a4f74e28f98898e3603140b6409fa52ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4f74e28f98898e3603140b6409fa52ba">◆ </a></span>~UFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">UFile::~UFile </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 class="definition">Definition at line <a class="el" href="UFile_8h_source.html#l00092">92</a> of file <a class="el" href="UFile_8h_source.html">UFile.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ab8719ee88436205b171674060eaa4dea" name="ab8719ee88436205b171674060eaa4dea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab8719ee88436205b171674060eaa4dea">◆ </a></span>exists() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool UFile::exists </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>filePath</em></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>Check if a file exists. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filePath</td><td>the file path </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if the file exists, otherwise false. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae1415739da256633ad417ac7d5fc2c11" name="ae1415739da256633ad417ac7d5fc2c11"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae1415739da256633ad417ac7d5fc2c11">◆ </a></span>length() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static long UFile::length </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>filePath</em></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>Get the file length. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filePath</td><td>the file path </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>long the length of the file in bytes. Return -1 if the file doesn't exist. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1faba3e78bb915a685d82f0696e1ec02" name="a1faba3e78bb915a685d82f0696e1ec02"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1faba3e78bb915a685d82f0696e1ec02">◆ </a></span>erase()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static int UFile::erase </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>filePath</em></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>Erase a file. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filePath</td><td>the file path </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if success. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a725e2edf4b5f603bfc688e96c76858d4" name="a725e2edf4b5f603bfc688e96c76858d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a725e2edf4b5f603bfc688e96c76858d4">◆ </a></span>rename() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static int UFile::rename </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>oldFilePath</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>newFilePath</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>Rename a file. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">oldFilePath</td><td>the old file path </td></tr>
|
|
<tr><td class="paramname">newFilePath</td><td>the new file path </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if success. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3e7905705a69b747e1ed6b6e37b19f3f" name="a3e7905705a69b747e1ed6b6e37b19f3f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3e7905705a69b747e1ed6b6e37b19f3f">◆ </a></span>getName() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::string UFile::getName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>filePath</em></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>Get the file name from a file path (with extension). </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filePath</td><td>the file path </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the file name. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac630657b2f15288df6ecddec029b42c6" name="ac630657b2f15288df6ecddec029b42c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac630657b2f15288df6ecddec029b42c6">◆ </a></span>getExtension() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::string UFile::getExtension </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>filePath</em></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>Get the file extension. </p><dl class="section return"><dt>Returns</dt><dd>the file extension </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa99e6dc81f23e17ce92bd848dfe5a2f4" name="aa99e6dc81f23e17ce92bd848dfe5a2f4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa99e6dc81f23e17ce92bd848dfe5a2f4">◆ </a></span>copy() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void UFile::copy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>from</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>to</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>Copy a file. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">from</td><td>the file path </td></tr>
|
|
<tr><td class="paramname">to</td><td>destination file path </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad0ecde61a088d9fc3d034a513133341d" name="ad0ecde61a088d9fc3d034a513133341d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad0ecde61a088d9fc3d034a513133341d">◆ </a></span>isValid()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool UFile::isValid </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>Check if the file exists. Same as <a class="el" href="classUFile.html#a4963afa70289718a3bd1ca50b6adb420">exists()</a>. </p><dl class="section return"><dt>Returns</dt><dd>true if the path exits </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="UFile_8h_source.html#l00098">98</a> of file <a class="el" href="UFile_8h_source.html">UFile.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4963afa70289718a3bd1ca50b6adb420" name="a4963afa70289718a3bd1ca50b6adb420"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4963afa70289718a3bd1ca50b6adb420">◆ </a></span>exists() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool UFile::exists </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>Check if the file exists. </p><dl class="section return"><dt>Returns</dt><dd>true if the path exits </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="UFile_8h_source.html#l00104">104</a> of file <a class="el" href="UFile_8h_source.html">UFile.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c42f32c914b349d13103d0397c1b3c1" name="a0c42f32c914b349d13103d0397c1b3c1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c42f32c914b349d13103d0397c1b3c1">◆ </a></span>length() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long UFile::length </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>Get the length of the file. </p><dl class="section return"><dt>Returns</dt><dd>long the length of the file in bytes. Return -1 if the file doesn't exist. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="UFile_8h_source.html#l00110">110</a> of file <a class="el" href="UFile_8h_source.html">UFile.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4918a111f92f2fdb7406fbd1661a1587" name="a4918a111f92f2fdb7406fbd1661a1587"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4918a111f92f2fdb7406fbd1661a1587">◆ </a></span>rename() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int UFile::rename </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>newName</em></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>Rename the file name. The path stays the same. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">the</td><td>new name </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="UFile_8h_source.html#l00116">116</a> of file <a class="el" href="UFile_8h_source.html">UFile.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af7e7f5995b05cda098037ca1cdcd63f4" name="af7e7f5995b05cda098037ca1cdcd63f4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7e7f5995b05cda098037ca1cdcd63f4">◆ </a></span>getName() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string UFile::getName </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>Get the file name without the path. </p><dl class="section return"><dt>Returns</dt><dd>the file name </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="UFile_8h_source.html#l00135">135</a> of file <a class="el" href="UFile_8h_source.html">UFile.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa937b9f20ef2e51091845c5108ded154" name="aa937b9f20ef2e51091845c5108ded154"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa937b9f20ef2e51091845c5108ded154">◆ </a></span>getExtension() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string UFile::getExtension </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>Get the file extension. </p><dl class="section return"><dt>Returns</dt><dd>the file extension </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="UFile_8h_source.html#l00140">140</a> of file <a class="el" href="UFile_8h_source.html">UFile.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa02141310fab62290721deee433f6314" name="aa02141310fab62290721deee433f6314"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa02141310fab62290721deee433f6314">◆ </a></span>copy() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void UFile::copy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>to</em></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>Copy a file. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">to</td><td>destination file path </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="UFile_8h_source.html#l00146">146</a> of file <a class="el" href="UFile_8h_source.html">UFile.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="UFile_8h_source.html">UFile.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="classUFile.html">UFile</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>
|