Sophie

Sophie

distrib > Fedora > 16 > i386 > by-pkgid > 4bc66056a634db26a1f4d0845dc41ca6 > files > 6014

mrpt-doc-0.9.5-0.1.20110925svn2670.fc16.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>filesystem.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> &gt; <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
          <div class="left">
            <form id="FSearchBox" action="search.php" method="get">
              <img id="MSearchSelect" src="search/mag.png" alt=""/>
              <input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S" 
                     onfocus="searchBox.OnSearchFieldFocus(true)" 
                     onblur="searchBox.OnSearchFieldFocus(false)"/>
            </form>
          </div><div class="right"></div>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">filesystem.h File Reference</div>  </div>
</div>
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="utils__defs_8h_source.html">mrpt/utils/utils_defs.h</a>&gt;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for filesystem.h:</div>
<div class="dyncontent">
<div class="center"><img src="filesystem_8h__incl.png" border="0" usemap="#filesystem_8h" alt=""/></div>
<map name="filesystem_8h" id="filesystem_8h">
<area shape="rect" id="node3" href="utils__defs_8h.html" title="mrpt/utils/utils_defs.h" alt="" coords="2207,80,2353,107"/><area shape="rect" id="node7" href="os_8h.html" title="mrpt/system/os.h" alt="" coords="510,155,633,181"/><area shape="rect" id="node20" href="base_2include_2mrpt_2base_2link__pragmas_8h.html" title="mrpt/base/link_pragmas.h" alt="" coords="2118,379,2289,405"/><area shape="rect" id="node23" href="boost__join_8h.html" title="mrpt/utils/boost_join.h" alt="" coords="2377,453,2527,480"/><area shape="rect" id="node25" href="base_2include_2mrpt_2utils_2types_8h.html" title="mrpt/utils/types.h" alt="" coords="1351,229,1473,256"/><area shape="rect" id="node83" href="mrpt__macros_8h.html" title="mrpt/utils/mrpt_macros.h" alt="" coords="1693,229,1859,256"/><area shape="rect" id="node86" href="compiler__fixes_8h.html" title="mrpt/utils/compiler_fixes.h" alt="" coords="2521,155,2695,181"/><area shape="rect" id="node111" href="smart__ptr_8hpp.html" title="mrpt/otherlibs/stlplus/smart_ptr.hpp" alt="" coords="2627,229,2853,256"/><area shape="rect" id="node128" href="bits_8h.html" title="mrpt/utils/bits.h" alt="" coords="3216,155,3327,181"/><area shape="rect" id="node37" href="mrpt__stdint_8h.html" title="mrpt/utils/mrpt_stdint.h" alt="" coords="750,379,905,405"/><area shape="rect" id="node42" href="mrpt__inttypes_8h.html" title="mrpt/utils/mrpt_inttypes.h" alt="" coords="717,304,888,331"/><area shape="rect" id="node45" href="math__frwds_8h.html" title="mrpt/math/math_frwds.h" alt="" coords="963,304,1127,331"/><area shape="rect" id="node61" href="_dense.html" title="Eigen/Dense" alt="" coords="494,304,591,331"/><area shape="rect" id="node40" href="pstdint_8h.html" title="pstdint.h" alt="" coords="792,453,864,480"/><area shape="rect" id="node63" href="_core.html" title="Core" alt="" coords="505,453,556,480"/><area shape="rect" id="node74" href="_l_u.html" title="LU" alt="" coords="483,379,521,405"/><area shape="rect" id="node113" href="containers__fixes_8hpp.html" title="containers_fixes.hpp" alt="" coords="2802,379,2944,405"/><area shape="rect" id="node115" href="exceptions_8hpp.html" title="exceptions.hpp" alt="" coords="2685,304,2795,331"/><area shape="rect" id="node122" href="atomic__incr_8h.html" title="mrpt/synch/atomic_incr.h" alt="" coords="2491,304,2660,331"/><area shape="rect" id="node126" href="smart__ptr_8tpp.html" title="smart_ptr.tpp" alt="" coords="2820,304,2919,331"/><area shape="rect" id="node130" href="_s_s_e__types_8h.html" title="mrpt/utils/SSE_types.h" alt="" coords="3205,229,3363,256"/></map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="filesystem_8h__dep__incl.png" border="0" usemap="#filesystem_8hdep" alt=""/></div>
<map name="filesystem_8hdep" id="filesystem_8hdep">
<area shape="rect" id="node3" href="system_8h.html" title="system.h" alt="" coords="319,80,395,107"/><area shape="rect" id="node5" href="base_8h.html" title="base.h" alt="" coords="200,155,261,181"/><area shape="rect" id="node11" href="_c_face_detection_8h.html" title="CFaceDetection.h" alt="" coords="293,155,421,181"/><area shape="rect" id="node15" href="_c_h_m_t_s_l_a_m_8h.html" title="CHMTSLAM.h" alt="" coords="446,155,553,181"/><area shape="rect" id="node7" href="_c_image___s_s_e3_8cpp.html" title="CImage_SSE3.cpp" alt="" coords="5,229,139,256"/><area shape="rect" id="node9" href="_c_image___s_s_e2_8cpp.html" title="CImage_SSE2.cpp" alt="" coords="163,229,297,256"/><area shape="rect" id="node13" href="detectors_8h.html" title="detectors.h" alt="" coords="322,229,408,256"/><area shape="rect" id="node17" href="hmtslam_8h.html" title="hmtslam.h" alt="" coords="459,229,540,256"/></map>
</div>
</div>
<p><a href="filesystem_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemrpt.html">mrpt</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><p>This is the global namespace for all Mobile Robot Programming Toolkit (MRPT) libraries. </p>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemrpt_1_1system.html">mrpt::system</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><p>This namespace provides a OS-independent interface to many useful functions: filenames manipulation, time and date, string parsing, file I/O, threading, memory allocation, etc. </p>
<br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga82325926b9a2b34801d64f9c7f38d24f">mrpt::system::getTempFileName</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the name of a proposed temporary file name.  <a href="group__filesystem.html#ga82325926b9a2b34801d64f9c7f38d24f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga0f47381c1931e6ece35e41f944bdebb1">mrpt::system::getcwd</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current working directory.  <a href="group__filesystem.html#ga0f47381c1931e6ece35e41f944bdebb1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#gaa435b18007a6fca5d14ccdf6fc650492">mrpt::system::createDirectory</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;dirName)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a directory.  <a href="group__filesystem.html#gaa435b18007a6fca5d14ccdf6fc650492"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga8eb9af5a17fde6c308953303f70e4093">mrpt::system::deleteFile</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;fileName)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes a single file.  <a href="group__filesystem.html#ga8eb9af5a17fde6c308953303f70e4093"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga71cc493ee11ab1729522a90fb5478c2d">mrpt::system::deleteFiles</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;s)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete one or more files, especified by the (optional) path and the file name (including '?' or '*') - Use forward slash ('/') for directories for compatibility between Windows and Linux, since they will be internally traslated into backward slashes ('\') if MRPT is compiled under Windows.  <a href="group__filesystem.html#ga71cc493ee11ab1729522a90fb5478c2d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga26758c4304f3caec1e58d9382c173e40">mrpt::system::renameFile</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;oldFileName, const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;newFileName, <a class="el" href="classstd_1_1string.html">std::string</a> *error_msg=NULL)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Renames a file - If the target path is different and the filesystem allows it, it will be moved to the new location.  <a href="group__filesystem.html#ga26758c4304f3caec1e58d9382c173e40"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga076a37d5291251595fef9a49c1f3fd46">mrpt::system::deleteFilesInDirectory</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;s, bool deleteDirectoryAsWell=false)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete all the files in a given directory (nothing done if directory does not exists, or path is a file).  <a href="group__filesystem.html#ga076a37d5291251595fef9a49c1f3fd46"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga89b806814023cd0411a99d6cb4d54ea9">mrpt::system::extractFileName</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;filePath)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract just the name (without extension) of a filename from a complete path plus name plus extension.  <a href="group__filesystem.html#ga89b806814023cd0411a99d6cb4d54ea9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#gac857ed6d7bd5a5d17c3ab8fc249e8cfa">mrpt::system::extractFileExtension</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;filePath, bool ignore_gz=false)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract the extension of a filename.  <a href="group__filesystem.html#gac857ed6d7bd5a5d17c3ab8fc249e8cfa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga15e372b32fef4d2135e0d2d96adb766e">mrpt::system::extractFileDirectory</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;filePath)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract the whole path (the directory) of a filename from a complete path plus name plus extension.  <a href="group__filesystem.html#ga15e372b32fef4d2135e0d2d96adb766e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#gaa233b191fefbf42cf4d06bce65d2ccc2">mrpt::system::fileExists</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;fileName)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if a given file (or directory) exists.  <a href="group__filesystem.html#gaa233b191fefbf42cf4d06bce65d2ccc2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga0a8ee608bba288dbb2ad2b93e0bf91e9">mrpt::system::directoryExists</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;fileName)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if a given directory exists (it fails if the given path refers to an existing file).  <a href="group__filesystem.html#ga0a8ee608bba288dbb2ad2b93e0bf91e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga3ab2bd0ae86710964f38febf2827ba2f">mrpt::system::fileNameStripInvalidChars</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;filename)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace invalid filename chars by underscores ('_').  <a href="group__filesystem.html#ga3ab2bd0ae86710964f38febf2827ba2f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga603f2e4e59b427db27526a1ffbd26ae2">mrpt::system::fileNameChangeExtension</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;filename, const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;newExtension)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace the filename extension by another one.  <a href="group__filesystem.html#ga603f2e4e59b427db27526a1ffbd26ae2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint64_t BASE_IMPEXP&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__filesystem.html#ga7f6b64000fa073fc067c67ee0f9aaad5">mrpt::system::getFileSize</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;fileName)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the size of the given file, or size_t(-1) if some error is found accessing that file.  <a href="group__filesystem.html#ga7f6b64000fa073fc067c67ee0f9aaad5"></a><br/></td></tr>
</table>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150">  </td></tr> </table>  </body></html>