Files
ortools-clone/docs/cpp/class_cycle_timer.html
Laurent Perron 5615fe9c61 regenerate docs
2022-01-17 21:42:14 +01:00

443 lines
19 KiB
HTML

<!-- HTML header for doxygen 1.8.18-->
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: CycleTimer</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="styleSheet.tmp.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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="orLogo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OR-Tools
&#160;<span id="projectnumber">9.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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>
</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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('class_cycle_timer.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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="class_cycle_timer-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">CycleTimer</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="timer_8h_source.html#l00073">73</a> of file <a class="el" href="timer_8h_source.html">timer.h</a>.</p>
</div><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:af32844bbd663b3e4c51d4b86cf09ac0c"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cycle_timer.html#af32844bbd663b3e4c51d4b86cf09ac0c">GetCycles</a> () const</td></tr>
<tr class="separator:af32844bbd663b3e4c51d4b86cf09ac0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a372de693ad40b3f42839c8ec6ac845f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wall_timer.html#a372de693ad40b3f42839c8ec6ac845f4">Reset</a> ()</td></tr>
<tr class="separator:a372de693ad40b3f42839c8ec6ac845f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07aaf1227e4d645f15e0a964f54ef291"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wall_timer.html#a07aaf1227e4d645f15e0a964f54ef291">Start</a> ()</td></tr>
<tr class="separator:a07aaf1227e4d645f15e0a964f54ef291"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bdbb9a2345c126ae0d72b1e2a9a21d5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wall_timer.html#a6bdbb9a2345c126ae0d72b1e2a9a21d5">Restart</a> ()</td></tr>
<tr class="separator:a6bdbb9a2345c126ae0d72b1e2a9a21d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17a237457e57625296e6b24feb19c60a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wall_timer.html#a17a237457e57625296e6b24feb19c60a">Stop</a> ()</td></tr>
<tr class="separator:a17a237457e57625296e6b24feb19c60a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec56fe080959ecebec3feaed9dafde84"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wall_timer.html#aec56fe080959ecebec3feaed9dafde84">Get</a> () const</td></tr>
<tr class="separator:aec56fe080959ecebec3feaed9dafde84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c329983260537a5036296d24e920620"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wall_timer.html#a6c329983260537a5036296d24e920620">GetInMs</a> () const</td></tr>
<tr class="separator:a6c329983260537a5036296d24e920620"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bcdc31a4e7046af8dcb244e3eaae071"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wall_timer.html#a1bcdc31a4e7046af8dcb244e3eaae071">GetInUsec</a> () const</td></tr>
<tr class="separator:a1bcdc31a4e7046af8dcb244e3eaae071"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4529f7d5e72dcd2c9d8961ee60f0ed6a"><td class="memItemLeft" align="right" valign="top">absl::Duration&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wall_timer.html#a4529f7d5e72dcd2c9d8961ee60f0ed6a">GetDuration</a> () const</td></tr>
<tr class="separator:a4529f7d5e72dcd2c9d8961ee60f0ed6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad201152b05beda61e51e3594ff07c8fe"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wall_timer.html#ad201152b05beda61e51e3594ff07c8fe">IsRunning</a> () const</td></tr>
<tr class="separator:ad201152b05beda61e51e3594ff07c8fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:af76f41dcdfc96bfdd746abe4e8c72fc1"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_wall_timer.html#af76f41dcdfc96bfdd746abe4e8c72fc1">GetNanos</a> () const</td></tr>
<tr class="separator:af76f41dcdfc96bfdd746abe4e8c72fc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aec56fe080959ecebec3feaed9dafde84" name="aec56fe080959ecebec3feaed9dafde84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec56fe080959ecebec3feaed9dafde84">&#9670;&nbsp;</a></span>Get()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double Get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer_8h_source.html#l00045">45</a> of file <a class="el" href="timer_8h_source.html">timer.h</a>.</p>
</div>
</div>
<a id="af32844bbd663b3e4c51d4b86cf09ac0c" name="af32844bbd663b3e4c51d4b86cf09ac0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af32844bbd663b3e4c51d4b86cf09ac0c">&#9670;&nbsp;</a></span>GetCycles()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int64_t GetCycles </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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="timer_8h_source.html#l00077">77</a> of file <a class="el" href="timer_8h_source.html">timer.h</a>.</p>
</div>
</div>
<a id="a4529f7d5e72dcd2c9d8961ee60f0ed6a" name="a4529f7d5e72dcd2c9d8961ee60f0ed6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4529f7d5e72dcd2c9d8961ee60f0ed6a">&#9670;&nbsp;</a></span>GetDuration()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">absl::Duration GetDuration </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer_8h_source.html#l00048">48</a> of file <a class="el" href="timer_8h_source.html">timer.h</a>.</p>
</div>
</div>
<a id="a6c329983260537a5036296d24e920620" name="a6c329983260537a5036296d24e920620"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c329983260537a5036296d24e920620">&#9670;&nbsp;</a></span>GetInMs()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int64_t GetInMs </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer_8h_source.html#l00046">46</a> of file <a class="el" href="timer_8h_source.html">timer.h</a>.</p>
</div>
</div>
<a id="a1bcdc31a4e7046af8dcb244e3eaae071" name="a1bcdc31a4e7046af8dcb244e3eaae071"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bcdc31a4e7046af8dcb244e3eaae071">&#9670;&nbsp;</a></span>GetInUsec()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int64_t GetInUsec </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer_8h_source.html#l00047">47</a> of file <a class="el" href="timer_8h_source.html">timer.h</a>.</p>
</div>
</div>
<a id="af76f41dcdfc96bfdd746abe4e8c72fc1" name="af76f41dcdfc96bfdd746abe4e8c72fc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af76f41dcdfc96bfdd746abe4e8c72fc1">&#9670;&nbsp;</a></span>GetNanos()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int64_t GetNanos </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer_8h_source.html#l00054">54</a> of file <a class="el" href="timer_8h_source.html">timer.h</a>.</p>
</div>
</div>
<a id="ad201152b05beda61e51e3594ff07c8fe" name="ad201152b05beda61e51e3594ff07c8fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad201152b05beda61e51e3594ff07c8fe">&#9670;&nbsp;</a></span>IsRunning()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool IsRunning </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer_8h_source.html#l00051">51</a> of file <a class="el" href="timer_8h_source.html">timer.h</a>.</p>
</div>
</div>
<a id="a372de693ad40b3f42839c8ec6ac845f4" name="a372de693ad40b3f42839c8ec6ac845f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a372de693ad40b3f42839c8ec6ac845f4">&#9670;&nbsp;</a></span>Reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Reset </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 class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer_8h_source.html#l00026">26</a> of file <a class="el" href="timer_8h_source.html">timer.h</a>.</p>
</div>
</div>
<a id="a6bdbb9a2345c126ae0d72b1e2a9a21d5" name="a6bdbb9a2345c126ae0d72b1e2a9a21d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bdbb9a2345c126ae0d72b1e2a9a21d5">&#9670;&nbsp;</a></span>Restart()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Restart </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 class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer_8h_source.html#l00035">35</a> of file <a class="el" href="timer_8h_source.html">timer.h</a>.</p>
</div>
</div>
<a id="a07aaf1227e4d645f15e0a964f54ef291" name="a07aaf1227e4d645f15e0a964f54ef291"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07aaf1227e4d645f15e0a964f54ef291">&#9670;&nbsp;</a></span>Start()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Start </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 class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer_8h_source.html#l00031">31</a> of file <a class="el" href="timer_8h_source.html">timer.h</a>.</p>
</div>
</div>
<a id="a17a237457e57625296e6b24feb19c60a" name="a17a237457e57625296e6b24feb19c60a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17a237457e57625296e6b24feb19c60a">&#9670;&nbsp;</a></span>Stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Stop </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 class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer_8h_source.html#l00039">39</a> of file <a class="el" href="timer_8h_source.html">timer.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="timer_8h_source.html">timer.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_cycle_timer.html">CycleTimer</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.3 </li>
</ul>
</div>
</body>
</html>