<!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>os.h Source File</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> > <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 Page</span></a></li>
<li><a href="pages.html"><span>Related 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 List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">os.h</div> </div>
</div>
<div class="contents">
<a href="os_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* +---------------------------------------------------------------------------+</span>
<a name="l00002"></a>00002 <span class="comment"> | The Mobile Robot Programming Toolkit (MRPT) C++ library |</span>
<a name="l00003"></a>00003 <span class="comment"> | |</span>
<a name="l00004"></a>00004 <span class="comment"> | http://www.mrpt.org/ |</span>
<a name="l00005"></a>00005 <span class="comment"> | |</span>
<a name="l00006"></a>00006 <span class="comment"> | Copyright (C) 2005-2011 University of Malaga |</span>
<a name="l00007"></a>00007 <span class="comment"> | |</span>
<a name="l00008"></a>00008 <span class="comment"> | This software was written by the Machine Perception and Intelligent |</span>
<a name="l00009"></a>00009 <span class="comment"> | Robotics Lab, University of Malaga (Spain). |</span>
<a name="l00010"></a>00010 <span class="comment"> | Contact: Jose-Luis Blanco <jlblanco@ctima.uma.es> |</span>
<a name="l00011"></a>00011 <span class="comment"> | |</span>
<a name="l00012"></a>00012 <span class="comment"> | This file is part of the MRPT project. |</span>
<a name="l00013"></a>00013 <span class="comment"> | |</span>
<a name="l00014"></a>00014 <span class="comment"> | MRPT is free software: you can redistribute it and/or modify |</span>
<a name="l00015"></a>00015 <span class="comment"> | it under the terms of the GNU General Public License as published by |</span>
<a name="l00016"></a>00016 <span class="comment"> | the Free Software Foundation, either version 3 of the License, or |</span>
<a name="l00017"></a>00017 <span class="comment"> | (at your option) any later version. |</span>
<a name="l00018"></a>00018 <span class="comment"> | |</span>
<a name="l00019"></a>00019 <span class="comment"> | MRPT is distributed in the hope that it will be useful, |</span>
<a name="l00020"></a>00020 <span class="comment"> | but WITHOUT ANY WARRANTY; without even the implied warranty of |</span>
<a name="l00021"></a>00021 <span class="comment"> | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |</span>
<a name="l00022"></a>00022 <span class="comment"> | GNU General Public License for more details. |</span>
<a name="l00023"></a>00023 <span class="comment"> | |</span>
<a name="l00024"></a>00024 <span class="comment"> | You should have received a copy of the GNU General Public License |</span>
<a name="l00025"></a>00025 <span class="comment"> | along with MRPT. If not, see <http://www.gnu.org/licenses/>. |</span>
<a name="l00026"></a>00026 <span class="comment"> | |</span>
<a name="l00027"></a>00027 <span class="comment"> +---------------------------------------------------------------------------+ */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef FILE_MRPT_OS_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define FILE_MRPT_OS_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <mrpt/config.h></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="preprocessor">#include <cstdarg></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <cstdlib></span>
<a name="l00035"></a>00035 <span class="preprocessor">#include <cstring></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <deque></span>
<a name="l00037"></a>00037 <span class="preprocessor">#include <vector></span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="comment">// Duplicated here since <mrpt/system/os.h> is the only header that cannot include "utils_defs.h"</span>
<a name="l00040"></a>00040 <span class="preprocessor">#include <<a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html">mrpt/base/link_pragmas.h</a>></span> <span class="comment">// DLL import/export definitions</span>
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="preprocessor">#include <<a class="code" href="base_2include_2mrpt_2utils_2types_8h.html">mrpt/utils/types.h</a>></span> <span class="comment">// This must be AFTER <utils_impexp.h></span>
<a name="l00043"></a>00043 <span class="preprocessor">#include <<a class="code" href="mrpt__macros_8h.html">mrpt/utils/mrpt_macros.h</a>></span> <span class="comment">// This must be AFTER <utils_impexp.h></span>
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment">/** Represents an invalid timestamp, where applicable.</span>
<a name="l00046"></a>00046 <span class="comment"> */</span>
<a name="l00047"></a><a class="code" href="os_8h.html#a2a0a650d16403da1f447b7543ce68e2b">00047</a> <span class="preprocessor">#define INVALID_TIMESTAMP (0)</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span>
<a name="l00049"></a>00049 <span class="keyword">namespace </span>mrpt
<a name="l00050"></a>00050 {<span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> /** 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.</span>
<a name="l00052"></a>00052 <span class="comment"> * \sa mrpt::system::os \ingroup mrpt_base_grp</span>
<a name="l00053"></a>00053 <span class="comment"> */</span>
<a name="l00054"></a>00054 <span class="keyword">namespace </span>system
<a name="l00055"></a>00055 {<span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment"> /** \defgroup mrpt_system_os OS and compiler abstraction</span>
<a name="l00057"></a>00057 <span class="comment"> * \ingroup mrpt_base_grp */</span>
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> /** This namespace provides a OS-independent interface to low-level functions.</span>
<a name="l00060"></a>00060 <span class="comment"> * Most of these functions are converted into calls to standard functions, unless we are into Visual Studio 2005 (or newer). In that case the secure version</span>
<a name="l00061"></a>00061 <span class="comment"> * of the standard library functions (prefix "_s") are used instead. \ingroup mrpt_base_grp mrpt_system_os</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a>00063 <span class="keyword">namespace </span>os
<a name="l00064"></a>00064 {<span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment"> /** \addtogroup mrpt_system_os</span>
<a name="l00066"></a>00066 <span class="comment"> * @{ */</span>
<a name="l00067"></a>00067 <span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment"> /** An OS-independent version of sprintf (Notice the bufSize param, which may be ignored in some compilers)</span>
<a name="l00069"></a>00069 <span class="comment"> * \sa utils::format</span>
<a name="l00070"></a>00070 <span class="comment"> */</span>
<a name="l00071"></a>00071 <span class="keywordtype">int</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#gaa5c66ce41ee061c2ae514e260b29e7a6" title="An OS-independent version of sprintf (Notice the bufSize param, which may be ignored in some compiler...">sprintf</a>(<span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> bufSize, <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="namespacemrpt.html#a3a27af794b658df5491e2b7678f8ccb8" title="A std::string version of C sprintf.">format</a>, ...) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a> <a class="code" href="mrpt__macros_8h.html#aeb2b596164da312ce6775ca9ba09453c">MRPT_printf_format_check</a>(3,4);
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment"> /** An OS-independent version of vsprintf (Notice the bufSize param, which may be ignored in some compilers)</span>
<a name="l00074"></a>00074 <span class="comment"> */</span>
<a name="l00075"></a>00075 <span class="keywordtype">int</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#gae8b9937bb99f6222ecb023e4cad37e72" title="An OS-independent version of vsprintf (Notice the bufSize param, which may be ignored in some compile...">vsprintf</a>(<span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> bufSize, <span class="keyword">const</span> <span class="keywordtype">char</span> *format, va_list args) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00076"></a>00076 <span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment"> /** An OS-independent version of vsnprintf (Notice the bufSize param, which may be ignored in some compilers)</span>
<a name="l00078"></a>00078 <span class="comment"> */</span>
<a name="l00079"></a>00079 <span class="keywordtype">int</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#gab694144137a7c14d9504357f164d9495" title="An OS-independent version of vsnprintf (Notice the bufSize param, which may be ignored in some compil...">vsnprintf</a>(<span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> bufSize, <span class="keyword">const</span> <span class="keywordtype">char</span> *format, va_list args) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00080"></a>00080 <span class="comment"></span>
<a name="l00081"></a>00081 <span class="comment"> /** An OS-independent version of fopen.</span>
<a name="l00082"></a>00082 <span class="comment"> * \return It will always return NULL on any error.</span>
<a name="l00083"></a>00083 <span class="comment"> */</span>
<a name="l00084"></a>00084 FILE <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> *<a class="code" href="group__mrpt__system__os.html#ga9b309cf44c48a430f3c70524e7492108" title="An OS-independent version of fopen.">fopen</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *fileName,<span class="keyword">const</span> <span class="keywordtype">char</span> *mode) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> /** An OS-independent version of fopen (std::string version)</span>
<a name="l00087"></a>00087 <span class="comment"> * \return It will always return NULL on any error.</span>
<a name="l00088"></a>00088 <span class="comment"> */</span>
<a name="l00089"></a>00089 FILE <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> *<a class="code" href="group__mrpt__system__os.html#ga9b309cf44c48a430f3c70524e7492108" title="An OS-independent version of fopen.">fopen</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &fileName,<span class="keyword">const</span> <span class="keywordtype">char</span> *mode) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00090"></a>00090 <span class="comment"></span>
<a name="l00091"></a>00091 <span class="comment"> /** An OS-independent version of fprintf</span>
<a name="l00092"></a>00092 <span class="comment"> */</span>
<a name="l00093"></a>00093 <span class="keywordtype">int</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga4cc3a0ea9b292a90300224b00e1c8fac" title="An OS-independent version of fprintf.">fprintf</a>(FILE *fil, <span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a> <a class="code" href="mrpt__macros_8h.html#aeb2b596164da312ce6775ca9ba09453c">MRPT_printf_format_check</a>(2,3);
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment"> /** An OS-independent version of fscanf</span>
<a name="l00096"></a>00096 <span class="comment"> * \return The number of fields correctly assigned</span>
<a name="l00097"></a>00097 <span class="comment"> */</span>
<a name="l00098"></a>00098 <span class="comment">//int BASE_IMPEXP fscanf(FILE *fil, const char *format, ...) MRPT_NO_THROWS MRPT_scanf_format_check(2,3);</span>
<a name="l00099"></a>00099 <span class="comment"></span>
<a name="l00100"></a>00100 <span class="comment"> /** An OS-independent version of fclose.</span>
<a name="l00101"></a>00101 <span class="comment"> * \exception std::exception On trying to close a NULL file descriptor.</span>
<a name="l00102"></a>00102 <span class="comment"> */</span>
<a name="l00103"></a>00103 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#gaf465efb0a560da1737c595780530bddf" title="An OS-independent version of fscanf.">fclose</a>(FILE *f);
<a name="l00104"></a>00104 <span class="comment"></span>
<a name="l00105"></a>00105 <span class="comment"> /** An OS-independent version of strcat.</span>
<a name="l00106"></a>00106 <span class="comment"> * \return It will always return the "dest" pointer.</span>
<a name="l00107"></a>00107 <span class="comment"> */</span>
<a name="l00108"></a>00108 <span class="keywordtype">char</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> * <a class="code" href="group__mrpt__system__os.html#gab63d483a73b291f710802f6df6392974" title="An OS-independent version of strcat.">strcat</a>(<span class="keywordtype">char</span> *dest, <span class="keywordtype">size_t</span> destSize, <span class="keyword">const</span> <span class="keywordtype">char</span> *source) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00109"></a>00109 <span class="comment"></span>
<a name="l00110"></a>00110 <span class="comment"> /** An OS-independent version of strcpy.</span>
<a name="l00111"></a>00111 <span class="comment"> * \return It will always return the "dest" pointer.</span>
<a name="l00112"></a>00112 <span class="comment"> */</span>
<a name="l00113"></a>00113 <span class="keywordtype">char</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> *<a class="code" href="group__mrpt__system__os.html#gac649e04b317db1898fcdf3ead43723b2" title="An OS-independent version of strcpy.">strcpy</a>(<span class="keywordtype">char</span> *dest, <span class="keywordtype">size_t</span> destSize, <span class="keyword">const</span> <span class="keywordtype">char</span> *source) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00114"></a>00114 <span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment"> /** An OS-independent version of strcmp.</span>
<a name="l00116"></a>00116 <span class="comment"> * \return It will return 0 when both strings are equal, casi sensitive.</span>
<a name="l00117"></a>00117 <span class="comment"> */</span>
<a name="l00118"></a>00118 <span class="keywordtype">int</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga3632d373059319ed674ba3d37acf76a6" title="An OS-independent version of strcmp.">_strcmp</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>*str1,<span class="keyword">const</span> <span class="keywordtype">char</span>*str2) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00119"></a>00119 <span class="comment"></span>
<a name="l00120"></a>00120 <span class="comment"> /** An OS-independent version of strcmpi.</span>
<a name="l00121"></a>00121 <span class="comment"> * \return It will return 0 when both strings are equal, casi insensitive.</span>
<a name="l00122"></a>00122 <span class="comment"> */</span>
<a name="l00123"></a>00123 <span class="keywordtype">int</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga0b3d8b9d83ae1b217d30f59589a1be3f" title="An OS-independent version of strcmpi.">_strcmpi</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>*str1,<span class="keyword">const</span> <span class="keywordtype">char</span>*str2) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00124"></a>00124 <span class="comment"></span>
<a name="l00125"></a>00125 <span class="comment"> /** An OS-independent version of strncmp.</span>
<a name="l00126"></a>00126 <span class="comment"> * \return It will return 0 when both strings are equal, casi sensitive.</span>
<a name="l00127"></a>00127 <span class="comment"> */</span>
<a name="l00128"></a>00128 <span class="keywordtype">int</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#gadfdf22e91c68cb814d8e5585220f7bd2" title="An OS-independent version of strncmp.">_strncmp</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>*str,<span class="keyword">const</span> <span class="keywordtype">char</span>*subStr,<span class="keywordtype">size_t</span> count) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00129"></a>00129 <span class="comment"></span>
<a name="l00130"></a>00130 <span class="comment"> /** An OS-independent version of strnicmp.</span>
<a name="l00131"></a>00131 <span class="comment"> * \return It will return 0 when both strings are equal, casi insensitive.</span>
<a name="l00132"></a>00132 <span class="comment"> */</span>
<a name="l00133"></a>00133 <span class="keywordtype">int</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#gaad4fd17ac25e0afdcb8e1fc8b75120fd" title="An OS-independent version of strnicmp.">_strnicmp</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>*str,<span class="keyword">const</span> <span class="keywordtype">char</span>*subStr,<span class="keywordtype">size_t</span> count) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00134"></a>00134 <span class="comment"></span>
<a name="l00135"></a>00135 <span class="comment"> /** An OS-independent version of strtoll.</span>
<a name="l00136"></a>00136 <span class="comment"> */</span>
<a name="l00137"></a>00137 int64_t <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga50798351c76f6e0281c667f558d132ba" title="An OS-independent version of strtoll.">_strtoll</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *nptr, <span class="keywordtype">char</span> **endptr, <span class="keywordtype">int</span> base);
<a name="l00138"></a>00138 <span class="comment"></span>
<a name="l00139"></a>00139 <span class="comment"> /** An OS-independent version of strtoull.</span>
<a name="l00140"></a>00140 <span class="comment"> */</span>
<a name="l00141"></a>00141 uint64_t <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga4a4eaddddf8f4997208c347449d7e235" title="An OS-independent version of strtoull.">_strtoull</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *nptr, <span class="keywordtype">char</span> **endptr, <span class="keywordtype">int</span> base);
<a name="l00142"></a>00142 <span class="comment"></span>
<a name="l00143"></a>00143 <span class="comment"> /** An OS-independent version of timegm (which is not present in all compilers): converts a time structure into an UTM time_t */</span>
<a name="l00144"></a>00144 time_t <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga20c030721308318d3452add36f6caa5b" title="An OS-independent version of timegm (which is not present in all compilers): converts a time structur...">timegm</a>(<span class="keyword">struct</span> tm *tm);
<a name="l00145"></a>00145 <span class="comment"></span>
<a name="l00146"></a>00146 <span class="comment"> /** An OS and compiler independent version of "memcpy"</span>
<a name="l00147"></a>00147 <span class="comment"> */</span>
<a name="l00148"></a>00148 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#gae1184cfb1f617787dc4c9da98becbe3a" title="An OS and compiler independent version of "memcpy".">memcpy</a>(
<a name="l00149"></a>00149 <span class="keywordtype">void</span> *dest,
<a name="l00150"></a>00150 <span class="keywordtype">size_t</span> destSize,
<a name="l00151"></a>00151 <span class="keyword">const</span> <span class="keywordtype">void</span> *src,
<a name="l00152"></a>00152 <span class="keywordtype">size_t</span> copyCount ) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00153"></a>00153 <span class="comment"></span>
<a name="l00154"></a>00154 <span class="comment"> /** An OS-independent version of getch, which waits until a key is pushed.</span>
<a name="l00155"></a>00155 <span class="comment"> * \return The pushed key code</span>
<a name="l00156"></a>00156 <span class="comment"> */</span>
<a name="l00157"></a>00157 <span class="keywordtype">int</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga819ac14dfaf6d9b5f25c14196fb120eb" title="An OS-independent version of getch, which waits until a key is pushed.">getch</a>() <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00158"></a>00158 <span class="comment"></span>
<a name="l00159"></a>00159 <span class="comment"> /** An OS-independent version of kbhit, which returns true if a key has been pushed.</span>
<a name="l00160"></a>00160 <span class="comment"> */</span>
<a name="l00161"></a>00161 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga49ca087d2e21e81adb051d856f1827c4" title="An OS-independent version of kbhit, which returns true if a key has been pushed.">kbhit</a>() <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00162"></a>00162 <span class="comment"></span>
<a name="l00163"></a>00163 <span class="comment"> /** @} */</span>
<a name="l00164"></a>00164
<a name="l00165"></a>00165 } <span class="comment">// end namespace "os"</span>
<a name="l00166"></a>00166 <span class="comment"></span>
<a name="l00167"></a>00167 <span class="comment"> /** \addtogroup mrpt_system_os</span>
<a name="l00168"></a>00168 <span class="comment"> * @{ */</span>
<a name="l00169"></a>00169 <span class="comment"></span>
<a name="l00170"></a>00170 <span class="comment"> /** Shows the message "Press any key to continue" (or other custom message) to the current standard output and returns when a key is pressed.</span>
<a name="l00171"></a>00171 <span class="comment"> */</span>
<a name="l00172"></a>00172 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga3e5c097bf7a092bd8e40e89598caf662" title="Shows the message "Press any key to continue" (or other custom message) to the current standard outpu...">pause</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &msg = <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a>(<span class="stringliteral">"Press any key to continue..."</span>) ) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00173"></a>00173 <span class="comment"></span>
<a name="l00174"></a>00174 <span class="comment"> /** Clears the console window */</span>
<a name="l00175"></a>00175 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#gac1bd71bc107edf108b239e05b615a621" title="Clears the console window.">clearConsole</a>();
<a name="l00176"></a>00176 <span class="comment"></span>
<a name="l00177"></a>00177 <span class="comment"> /** A useful function for debuging, which saves a std::vector into a text file (compat. with MATLAB)</span>
<a name="l00178"></a>00178 <span class="comment"> * \return Returns false on any error, true on everything OK.</span>
<a name="l00179"></a>00179 <span class="comment"> */</span>
<a name="l00180"></a>00180 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga2454cccef332c556b3efffc4d0ac24ef" title="A useful function for debuging, which saves a std::vector into a text file (compat.">vectorToTextFile</a>( <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<float></a> &vec, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &fileName, <span class="keywordtype">bool</span> append = <span class="keyword">false</span>, <span class="keywordtype">bool</span> byRows=<span class="keyword">false</span> );<span class="comment"></span>
<a name="l00181"></a>00181 <span class="comment"> //! \overload</span>
<a name="l00182"></a>00182 <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga2454cccef332c556b3efffc4d0ac24ef" title="A useful function for debuging, which saves a std::vector into a text file (compat.">vectorToTextFile</a>( <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<double></a> &vec, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &fileName, <span class="keywordtype">bool</span> append = <span class="keyword">false</span>, <span class="keywordtype">bool</span> byRows=<span class="keyword">false</span> );<span class="comment"></span>
<a name="l00183"></a>00183 <span class="comment"> //! \overload</span>
<a name="l00184"></a>00184 <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga2454cccef332c556b3efffc4d0ac24ef" title="A useful function for debuging, which saves a std::vector into a text file (compat.">vectorToTextFile</a>( <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<int></a> &vec, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &fileName, <span class="keywordtype">bool</span> append = <span class="keyword">false</span>, <span class="keywordtype">bool</span> byRows=<span class="keyword">false</span> );<span class="comment"></span>
<a name="l00185"></a>00185 <span class="comment"> //! \overload</span>
<a name="l00186"></a>00186 <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga2454cccef332c556b3efffc4d0ac24ef" title="A useful function for debuging, which saves a std::vector into a text file (compat.">vectorToTextFile</a>( <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector<size_t></a> &vec, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &fileName, <span class="keywordtype">bool</span> append = <span class="keyword">false</span>, <span class="keywordtype">bool</span> byRows=<span class="keyword">false</span> );<span class="comment"></span>
<a name="l00187"></a>00187 <span class="comment"> //! \overload</span>
<a name="l00188"></a>00188 <span class="comment"></span> <span class="keyword">template</span> <<span class="keyword">class</span> Derived>
<a name="l00189"></a><a class="code" href="group__mrpt__system__os.html#ga6e9fff689b86257749d574ca7040275b">00189</a> <span class="keywordtype">bool</span> <a class="code" href="group__mrpt__system__os.html#ga2454cccef332c556b3efffc4d0ac24ef" title="A useful function for debuging, which saves a std::vector into a text file (compat.">vectorToTextFile</a>( <span class="keyword">const</span> <a class="code" href="class_eigen_1_1_matrix_base.html">Eigen::MatrixBase<Derived></a> &vec, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &fileName ) {
<a name="l00190"></a>00190 <span class="keywordflow">try</span> {
<a name="l00191"></a>00191 vec.<a class="code" href="class_eigen_1_1_matrix_base.html#a934cfd193a97d2bc6a473d472addd860" title="Save matrix to a text file, compatible with MATLAB text format (see also the methods of matrix classe...">saveToTextFile</a>(fileName);
<a name="l00192"></a>00192 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00193"></a>00193 } <span class="keywordflow">catch</span>(...) {<span class="keywordflow">return</span> <span class="keyword">false</span>;}
<a name="l00194"></a>00194 }
<a name="l00195"></a>00195 <span class="comment"></span>
<a name="l00196"></a>00196 <span class="comment"> /** Load a std::vector from a text file (compat. with MATLAB)</span>
<a name="l00197"></a>00197 <span class="comment"> * \return Returns false on any error, true on everything OK.</span>
<a name="l00198"></a>00198 <span class="comment"> * \sa loadBinaryFile</span>
<a name="l00199"></a>00199 <span class="comment"> */</span>
<a name="l00200"></a>00200 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga5c9824a5cf356616a6536544ecd6b7df" title="Load a std::vector from a text file (compat.">vectorFromTextFile</a>( <a class="code" href="classstd_1_1vector.html">std::vector<double></a> &vec, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &fileName, <span class="keyword">const</span> <span class="keywordtype">bool</span> byRows=<span class="keyword">false</span> );
<a name="l00201"></a>00201 <span class="comment"></span>
<a name="l00202"></a>00202 <span class="comment"> /** Saves a vector directly as a binary dump to a file:</span>
<a name="l00203"></a>00203 <span class="comment"> * \return Returns false on any error, true on everything OK.</span>
<a name="l00204"></a>00204 <span class="comment"> * \sa loadBinaryFile</span>
<a name="l00205"></a>00205 <span class="comment"> */</span>
<a name="l00206"></a>00206 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga538802487a6af115d4cf809da2a08829" title="Saves a vector directly as a binary dump to a file:">vectorToBinaryFile</a>( <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html" title="STL class.">vector_byte</a> &vec, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &fileName );
<a name="l00207"></a>00207 <span class="comment"></span>
<a name="l00208"></a>00208 <span class="comment"> /** Loads a entire file as a vector of bytes.</span>
<a name="l00209"></a>00209 <span class="comment"> * \return Returns false on any error, true on everything OK.</span>
<a name="l00210"></a>00210 <span class="comment"> * \sa vectorToBinaryFile</span>
<a name="l00211"></a>00211 <span class="comment"> */</span>
<a name="l00212"></a>00212 <span class="keywordtype">bool</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga99441f621af112d746046bd71ed8de85" title="Loads a entire file as a vector of bytes.">loadBinaryFile</a>( <a class="code" href="classstd_1_1vector.html" title="STL class.">vector_byte</a> &out_data, <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &fileName );
<a name="l00213"></a>00213 <span class="comment"></span>
<a name="l00214"></a>00214 <span class="comment"> /** Returns the MRPT compilation date</span>
<a name="l00215"></a>00215 <span class="comment"> */</span>
<a name="l00216"></a>00216 std::string <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga32d2ad44770a1a4dfcedab6d4d257bb8" title="Returns the MRPT compilation date.">MRPT_getCompilationDate</a>();
<a name="l00217"></a>00217 <span class="comment"></span>
<a name="l00218"></a>00218 <span class="comment"> /** Returns a string describing the MRPT version including the SVN number.</span>
<a name="l00219"></a>00219 <span class="comment"> */</span>
<a name="l00220"></a>00220 std::string <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga8fe63df666e65644f220e175df15c8ab" title="Returns a string describing the MRPT version including the SVN number.">MRPT_getVersion</a>();
<a name="l00221"></a>00221 <span class="comment"></span>
<a name="l00222"></a>00222 <span class="comment"> /** Call this to register handlers for fatal erros (memory access,etc) that show useful debug information (It is called automatically normally, no need for the user to explicitly call this method.).</span>
<a name="l00223"></a>00223 <span class="comment"> */</span>
<a name="l00224"></a>00224 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#gafd20c6a91497b8cfd29e3f42af74d133" title="Call this to register handlers for fatal erros (memory access,etc) that show useful debug information...">registerFatalExceptionHandlers</a>();
<a name="l00225"></a>00225 <span class="comment"></span>
<a name="l00226"></a>00226 <span class="comment"> /** Dumps the current program stack with detailed information of source files and lines.</span>
<a name="l00227"></a>00227 <span class="comment"> * This function requires MRPT linked against wxWidgets. Otherwise, an empty string is returned.</span>
<a name="l00228"></a>00228 <span class="comment"> * File names and lines won't be available in release builds.</span>
<a name="l00229"></a>00229 <span class="comment"> */</span>
<a name="l00230"></a>00230 std::string <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga264db8d9d6e0f4db51ee9de8e29029b6" title="Dumps the current program stack with detailed information of source files and lines.">stack_trace</a>(<span class="keywordtype">bool</span> calling_from_exception = <span class="keyword">false</span>);
<a name="l00231"></a>00231 <span class="comment"></span>
<a name="l00232"></a>00232 <span class="comment"> /** Only when built in debug (with _DEBUG), this function will be called just before raising any MRPT exception,</span>
<a name="l00233"></a>00233 <span class="comment"> * so the user can conveniently put a breakpoint here to explore the call stack, etc.</span>
<a name="l00234"></a>00234 <span class="comment"> */</span>
<a name="l00235"></a>00235 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#ga4c705731f4b8292a36ae31204e8e576b" title="Only when built in debug (with _DEBUG), this function will be called just before raising any MRPT exc...">breakpoint</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &exception_msg);
<a name="l00236"></a>00236 <span class="comment"></span>
<a name="l00237"></a>00237 <span class="comment"> /** For use in setConsoleColor */</span>
<a name="l00238"></a><a class="code" href="group__mrpt__system__os.html#gaf024857d947a048fe9d6b7f3bfab5045">00238</a> <span class="keyword">enum</span> <a class="code" href="group__mrpt__system__os.html#gaf024857d947a048fe9d6b7f3bfab5045" title="For use in setConsoleColor.">TConsoleColor</a>
<a name="l00239"></a>00239 {
<a name="l00240"></a><a class="code" href="group__mrpt__system__os.html#ggaf024857d947a048fe9d6b7f3bfab5045a254b3e8a94af9833ceb88a73f43f7acd">00240</a> <a class="code" href="group__mrpt__system__os.html#ggaf024857d947a048fe9d6b7f3bfab5045a254b3e8a94af9833ceb88a73f43f7acd">CONCOL_NORMAL</a> = 0,
<a name="l00241"></a><a class="code" href="group__mrpt__system__os.html#ggaf024857d947a048fe9d6b7f3bfab5045a0f0806fc7fa11f76bdf24bef60dc1946">00241</a> <a class="code" href="group__mrpt__system__os.html#ggaf024857d947a048fe9d6b7f3bfab5045a0f0806fc7fa11f76bdf24bef60dc1946">CONCOL_BLUE</a> = 1,
<a name="l00242"></a><a class="code" href="group__mrpt__system__os.html#ggaf024857d947a048fe9d6b7f3bfab5045afa4121ff6716d4fc242858fca5c314eb">00242</a> <a class="code" href="group__mrpt__system__os.html#ggaf024857d947a048fe9d6b7f3bfab5045afa4121ff6716d4fc242858fca5c314eb">CONCOL_GREEN</a> = 2,
<a name="l00243"></a><a class="code" href="group__mrpt__system__os.html#ggaf024857d947a048fe9d6b7f3bfab5045aa12feea04829d151f7b7434c6af3b9bc">00243</a> <a class="code" href="group__mrpt__system__os.html#ggaf024857d947a048fe9d6b7f3bfab5045aa12feea04829d151f7b7434c6af3b9bc">CONCOL_RED</a> = 4
<a name="l00244"></a>00244 };
<a name="l00245"></a>00245 <span class="comment"></span>
<a name="l00246"></a>00246 <span class="comment"> /** Changes the text color in the console for the text written from now on.</span>
<a name="l00247"></a>00247 <span class="comment"> * The parameter "color" can be any value in TConsoleColor.</span>
<a name="l00248"></a>00248 <span class="comment"> *</span>
<a name="l00249"></a>00249 <span class="comment"> * By default the color of "cout" is changed, unless changeStdErr=true, in which case "cerr" is changed.</span>
<a name="l00250"></a>00250 <span class="comment"> */</span>
<a name="l00251"></a>00251 <span class="keywordtype">void</span> <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="group__mrpt__system__os.html#gaedbeced9be12c473279fdd49765ee4e7" title="Changes the text color in the console for the text written from now on.">setConsoleColor</a>( <a class="code" href="group__mrpt__system__os.html#gaf024857d947a048fe9d6b7f3bfab5045" title="For use in setConsoleColor.">TConsoleColor</a> color, <span class="keywordtype">bool</span> changeStdErr=<span class="keyword">false</span> );
<a name="l00252"></a>00252 <span class="comment"></span>
<a name="l00253"></a>00253 <span class="comment"> /** @} */</span>
<a name="l00254"></a>00254
<a name="l00255"></a>00255 } <span class="comment">// End of namespace</span>
<a name="l00256"></a>00256
<a name="l00257"></a>00257 } <span class="comment">// End of namespace</span>
<a name="l00258"></a>00258
<a name="l00259"></a>00259 <span class="preprocessor">#endif</span>
</pre></div></div>
</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>
