<!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>CTimeLogger.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">CTimeLogger.h</div> </div>
</div>
<div class="contents">
<a href="_c_time_logger_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 CTimeLogger_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define CTimeLogger_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="_c_tic_tac_8h.html">mrpt/utils/CTicTac.h</a>></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <<a class="code" href="_c_debug_output_capable_8h.html">mrpt/utils/CDebugOutputCapable.h</a>></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="preprocessor">#include <stack></span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="keyword">namespace </span>mrpt
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <span class="keyword">namespace </span>utils
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040 <span class="keyword">using namespace </span>std;
<a name="l00041"></a>00041 <span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment"> /** A versatile "profiler" that logs the time spent within each pair of calls to enter(X)-leave(X), among other stats.</span>
<a name="l00043"></a>00043 <span class="comment"> * The results can be dumped to cout or to Visual Studio's output panel.</span>
<a name="l00044"></a>00044 <span class="comment"> * Recursive methods are supported with no problems, that is, calling "enter(X) enter(X) ... leave(X) leave(X)".</span>
<a name="l00045"></a>00045 <span class="comment"> * \note The default behavior is dumping all the information at destruction.</span>
<a name="l00046"></a>00046 <span class="comment"> * \ingroup mrpt_base_grp</span>
<a name="l00047"></a>00047 <span class="comment"> */</span>
<a name="l00048"></a>00048 <span class="keyword">class </span><a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> CTimeLogger : <span class="keyword">public</span> mrpt::utils::CDebugOutputCapable
<a name="l00049"></a>00049 {
<a name="l00050"></a>00050 <span class="keyword">private</span>:
<a name="l00051"></a><a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html#a726aa9a1d65010d0319a2c8ba686677a">00051</a> <a class="code" href="classmrpt_1_1utils_1_1_c_tic_tac.html" title="This class implements a high-performance stopwatch.">CTicTac</a> <a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html#a726aa9a1d65010d0319a2c8ba686677a">m_tictac</a>;
<a name="l00052"></a><a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html#a7162231fe44c7b11e4eb48c609b8655c">00052</a> <span class="keywordtype">bool</span> <a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html#a7162231fe44c7b11e4eb48c609b8655c">m_enabled</a>;
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment"> //! Data of all the calls:</span>
<a name="l00055"></a>00055 <span class="comment"></span> <span class="keyword">struct </span><a class="code" href="structmrpt_1_1utils_1_1_c_time_logger_1_1_t_call_data.html" title="Data of all the calls:">TCallData</a>
<a name="l00056"></a>00056 {
<a name="l00057"></a>00057 <a class="code" href="structmrpt_1_1utils_1_1_c_time_logger_1_1_t_call_data.html" title="Data of all the calls:">TCallData</a>();
<a name="l00058"></a>00058
<a name="l00059"></a><a class="code" href="structmrpt_1_1utils_1_1_c_time_logger_1_1_t_call_data.html#af593c8a520160e3ccfecc1cfab54fbc0">00059</a> <span class="keywordtype">size_t</span> <a class="code" href="structmrpt_1_1utils_1_1_c_time_logger_1_1_t_call_data.html#af593c8a520160e3ccfecc1cfab54fbc0">n_calls</a>;
<a name="l00060"></a><a class="code" href="structmrpt_1_1utils_1_1_c_time_logger_1_1_t_call_data.html#ae05844ba9be60ddc843169af544cc0b0">00060</a> <span class="keywordtype">double</span> <a class="code" href="structmrpt_1_1utils_1_1_c_time_logger_1_1_t_call_data.html#ae05844ba9be60ddc843169af544cc0b0">min_t</a>,max_t,mean_t;
<a name="l00061"></a><a class="code" href="structmrpt_1_1utils_1_1_c_time_logger_1_1_t_call_data.html#a3a07f7d6e2bed1f123e384a1d1bb66b8">00061</a> <a class="code" href="classstd_1_1stack.html" title="STL class.">stack<double,vector<double></a> > <a class="code" href="structmrpt_1_1utils_1_1_c_time_logger_1_1_t_call_data.html#a3a07f7d6e2bed1f123e384a1d1bb66b8">open_calls</a>;
<a name="l00062"></a>00062 };
<a name="l00063"></a>00063
<a name="l00064"></a><a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html#a159a6c22db4d2d814b1b32972fd43e67">00064</a> <a class="code" href="classstd_1_1map.html">map<string,TCallData></a> <a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html#a159a6c22db4d2d814b1b32972fd43e67">m_data</a>;
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keywordtype">void</span> do_enter( <span class="keyword">const</span> <span class="keywordtype">char</span> *func_name );
<a name="l00067"></a>00067 <span class="keywordtype">double</span> do_leave( <span class="keyword">const</span> <span class="keywordtype">char</span> *func_name );
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keyword">public</span>:
<a name="l00070"></a>00070 <a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html" title="A versatile "profiler" that logs the time spent within each pair of calls to enter(X)-leave(X), among other stats.">CTimeLogger</a>(<span class="keywordtype">bool</span> enabled = <span class="keyword">true</span>); <span class="comment">//! Default constructor</span>
<a name="l00071"></a>00071 <span class="comment"></span> <span class="keyword">virtual</span> ~<a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html" title="A versatile "profiler" that logs the time spent within each pair of calls to enter(X)-leave(X), among other stats.">CTimeLogger</a>(); <span class="comment">//!< Destructor</span>
<a name="l00072"></a>00072 <span class="comment"></span> std<a class="code" href="classstd_1_1string.html" title="STL class.">::string</a> getStatsAsText(<span class="keyword">const</span> <span class="keywordtype">size_t</span> column_width=80) <span class="keyword">const</span>; <span class="comment">//!< Dump all stats to a multi-line text string. \sa dumpAllStats, saveToCVSFile</span>
<a name="l00073"></a>00073 <span class="comment"></span> <span class="keywordtype">void</span> dumpAllStats(<span class="keyword">const</span> <span class="keywordtype">size_t</span> column_width=80) <span class="keyword">const</span>; <span class="comment">//!< Dump all stats through the CDebugOutputCapable interface. \sa getStatsAsText, saveToCVSFile</span>
<a name="l00074"></a>00074 <span class="comment"></span> <span class="keywordtype">void</span> clear();
<a name="l00075"></a><a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html#a8d8bb7ec6e550806ef110ef6e5bc3bae">00075</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html#a8d8bb7ec6e550806ef110ef6e5bc3bae">enable</a>(<span class="keywordtype">bool</span> enabled = <span class="keyword">true</span>) { m_enabled = enabled; }
<a name="l00076"></a><a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html#a9b4cef6b288d4c4507301ad69f9d3abc">00076</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html#a9b4cef6b288d4c4507301ad69f9d3abc">disable</a>() { m_enabled = <span class="keyword">false</span>; }
<a name="l00077"></a>00077 <span class="keywordtype">void</span> saveToCSVFile(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &csv_file) <span class="keyword">const</span>; <span class="comment">//!< Dump all stats to a Comma Separated Values (CSV) file. \sa dumpAllStats</span>
<a name="l00078"></a>00078 <span class="comment"></span><span class="comment"></span>
<a name="l00079"></a>00079 <span class="comment"> /** Start of a named section \sa enter */</span>
<a name="l00080"></a><a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html#a777152412cc5b3906f8c50f10b4e92e9">00080</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html#a777152412cc5b3906f8c50f10b4e92e9" title="Start of a named section.">enter</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *func_name ) {
<a name="l00081"></a>00081 <span class="keywordflow">if</span> (m_enabled)
<a name="l00082"></a>00082 do_enter(func_name);
<a name="l00083"></a>00083 }<span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment"> /** End of a named section \return The ellapsed time, in seconds or 0 if disabled. \sa enter */</span>
<a name="l00085"></a><a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html#adb31026df488e8c86a1b37c82ae89516">00085</a> <span class="keyword">inline</span> <span class="keywordtype">double</span> <a class="code" href="classmrpt_1_1utils_1_1_c_time_logger.html#adb31026df488e8c86a1b37c82ae89516" title="End of a named section.">leave</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *func_name ) {
<a name="l00086"></a>00086 <span class="keywordflow">return</span> m_enabled ? do_leave(func_name) : 0;
<a name="l00087"></a>00087 }<span class="comment"></span>
<a name="l00088"></a>00088 <span class="comment"> /** Return the mean execution time of the given "section", or 0 if it hasn't ever been called "enter" with that section name */</span>
<a name="l00089"></a>00089 <span class="keywordtype">double</span> getMeanTime(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &name) <span class="keyword">const</span>;
<a name="l00090"></a>00090 }; <span class="comment">// End of class def.</span>
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment"> /** @name Auxiliary stuff for the global profiler used in MRPT_START / MRPT_END macros.</span>
<a name="l00094"></a>00094 <span class="comment"> @{ */</span>
<a name="l00095"></a>00095 <span class="keyword">extern</span> CTimeLogger <a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> <a class="code" href="namespacemrpt_1_1utils.html#aeb7b274154fa0c64231554b888b571d4">global_profiler</a>;
<a name="l00096"></a>00096 <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="namespacemrpt_1_1utils.html#a24f4b2c38eb394a65cd1376b8c2cff8a">global_profiler_enter</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *func_name) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;
<a name="l00097"></a>00097 <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="namespacemrpt_1_1utils.html#a3e9d2d7f13a79eb33d16370cf4e7f7df">global_profiler_leave</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *func_name) <a class="code" href="mrpt__macros_8h.html#afed971bfd24ff010f488cce2aa424de4" title="Used after member declarations.">MRPT_NO_THROWS</a>;<span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment"> /** @} */</span>
<a name="l00099"></a>00099
<a name="l00100"></a>00100 } <span class="comment">// End of namespace</span>
<a name="l00101"></a>00101 } <span class="comment">// End of namespace</span>
<a name="l00102"></a>00102 <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>
