blob: 994fbdc0400c6e7ccf6958fcd8ae32d3bbce085c [file]
<!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>iceberg-cpp: iceberg::Timer::Timed 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="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" />
</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">iceberg-cpp
</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&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1Timer.html">Timer</a></li><li class="navelem"><a class="el" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classiceberg_1_1Timer_1_1Timed-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::Timer::Timed Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>RAII guard that records elapsed time into a non-owning <a class="el" href="classiceberg_1_1Timer.html" title="Abstract timer for measuring operation durations.">Timer</a> on destruction.
<a href="classiceberg_1_1Timer_1_1Timed.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="timer_8h_source.html">timer.h</a>&gt;</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:a71c6fd17dbe6dac336c9f535835589dd" id="r_a71c6fd17dbe6dac336c9f535835589dd"><td class="memItemLeft" align="right" valign="top"><a id="a71c6fd17dbe6dac336c9f535835589dd" name="a71c6fd17dbe6dac336c9f535835589dd"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Timed</b> (<a class="el" href="classiceberg_1_1Timer.html">Timer</a> &amp;timer)</td></tr>
<tr class="separator:a71c6fd17dbe6dac336c9f535835589dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93ece9e51bea065bf6b85b69c9cd15d9" id="r_a93ece9e51bea065bf6b85b69c9cd15d9"><td class="memItemLeft" align="right" valign="top"><a id="a93ece9e51bea065bf6b85b69c9cd15d9" name="a93ece9e51bea065bf6b85b69c9cd15d9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Timed</b> (const <a class="el" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a> &amp;)=delete</td></tr>
<tr class="separator:a93ece9e51bea065bf6b85b69c9cd15d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0e7ce0fb299fb5d62b596461958efb9" id="r_ae0e7ce0fb299fb5d62b596461958efb9"><td class="memItemLeft" align="right" valign="top"><a id="ae0e7ce0fb299fb5d62b596461958efb9" name="ae0e7ce0fb299fb5d62b596461958efb9"></a>
<a class="el" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a> &amp;)=delete</td></tr>
<tr class="separator:ae0e7ce0fb299fb5d62b596461958efb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a587c1e2b1ed089285589a3fd3b0db376" id="r_a587c1e2b1ed089285589a3fd3b0db376"><td class="memItemLeft" align="right" valign="top"><a id="a587c1e2b1ed089285589a3fd3b0db376" name="a587c1e2b1ed089285589a3fd3b0db376"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Timed</b> (<a class="el" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a> &amp;&amp;other) noexcept</td></tr>
<tr class="separator:a587c1e2b1ed089285589a3fd3b0db376"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a250828d19d4b638185e2bcc789218caa" id="r_a250828d19d4b638185e2bcc789218caa"><td class="memItemLeft" align="right" valign="top"><a id="a250828d19d4b638185e2bcc789218caa" name="a250828d19d4b638185e2bcc789218caa"></a>
<a class="el" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a> &amp;&amp;other) noexcept</td></tr>
<tr class="separator:a250828d19d4b638185e2bcc789218caa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a435fc292cb438022e77ff8584a6c2c40" id="r_a435fc292cb438022e77ff8584a6c2c40"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Timer_1_1Timed.html#a435fc292cb438022e77ff8584a6c2c40">Stop</a> ()</td></tr>
<tr class="memdesc:a435fc292cb438022e77ff8584a6c2c40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Explicitly stop timing and record the duration. <br /></td></tr>
<tr class="separator:a435fc292cb438022e77ff8584a6c2c40"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>RAII guard that records elapsed time into a non-owning <a class="el" href="classiceberg_1_1Timer.html" title="Abstract timer for measuring operation durations.">Timer</a> on destruction. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a435fc292cb438022e77ff8584a6c2c40" name="a435fc292cb438022e77ff8584a6c2c40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a435fc292cb438022e77ff8584a6c2c40">&#9670;&#160;</a></span>Stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void iceberg::Timer::Timed::Stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Explicitly stop timing and record the duration. </p>
<p>Subsequent calls (including the destructor) are no-ops. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/metrics/<a class="el" href="timer_8h_source.html">timer.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>