Amebis/stdex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
stdex/classstdex_1_1timeout__progress.html

385 lines
19 KiB
HTML
Raw Blame History

<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::timeout_progress&lt; T &gt; Class Template 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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">stdex
</div>
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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"><b>stdex</b></li><li class="navelem"><a class="el" href="classstdex_1_1timeout__progress.html">timeout_progress</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classstdex_1_1timeout__progress-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::timeout_progress&lt; T &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Timeout progress indicator.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="progress_8hpp_source.html">stdex/progress.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stdex::timeout_progress&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classstdex_1_1timeout__progress.png" usemap="#stdex::timeout_5Fprogress_3C_20T_20_3E_map" alt=""/>
<map id="stdex::timeout_5Fprogress_3C_20T_20_3E_map" name="stdex::timeout_5Fprogress_3C_20T_20_3E_map">
<area href="classstdex_1_1progress.html" title="Progress indicator base class." alt="stdex::progress&lt; T &gt;" shape="rect" coords="0,0,174,24"/>
</map>
</div></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:aeb3820c8c82dfe10d33c4e24269acf26" id="r_aeb3820c8c82dfe10d33c4e24269acf26"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aeb3820c8c82dfe10d33c4e24269acf26">timeout_progress</a> (const std::chrono::nanoseconds &amp;timeout=std::chrono::seconds(60), <a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *host=nullptr)</td></tr>
<tr class="memdesc:aeb3820c8c82dfe10d33c4e24269acf26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a timeout progress indicator. <br /></td></tr>
<tr class="separator:aeb3820c8c82dfe10d33c4e24269acf26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a499e6d9561358a764cbc1547a9273e62" id="r_a499e6d9561358a764cbc1547a9273e62"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a499e6d9561358a764cbc1547a9273e62">set_text</a> (const char *msg)</td></tr>
<tr class="memdesc:a499e6d9561358a764cbc1547a9273e62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set progress indicator text. <br /></td></tr>
<tr class="separator:a499e6d9561358a764cbc1547a9273e62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e77eaf88a2b82d0045b69030af971d9" id="r_a2e77eaf88a2b82d0045b69030af971d9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2e77eaf88a2b82d0045b69030af971d9">set_range</a> (T start, T end)</td></tr>
<tr class="memdesc:a2e77eaf88a2b82d0045b69030af971d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set progress range extent. <br /></td></tr>
<tr class="separator:a2e77eaf88a2b82d0045b69030af971d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4cb32662b73a88a2d519b1767d96d1df" id="r_a4cb32662b73a88a2d519b1767d96d1df"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4cb32662b73a88a2d519b1767d96d1df">set</a> (T value)</td></tr>
<tr class="memdesc:a4cb32662b73a88a2d519b1767d96d1df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set current progress. <br /></td></tr>
<tr class="separator:a4cb32662b73a88a2d519b1767d96d1df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af35da3be39391df927ee4b0830d4df00" id="r_af35da3be39391df927ee4b0830d4df00"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af35da3be39391df927ee4b0830d4df00">show</a> (bool show=true)</td></tr>
<tr class="memdesc:af35da3be39391df927ee4b0830d4df00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Show or hide progress. <br /></td></tr>
<tr class="separator:af35da3be39391df927ee4b0830d4df00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50484235e76ca413565cc5ae7d6eff79" id="r_a50484235e76ca413565cc5ae7d6eff79"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a50484235e76ca413565cc5ae7d6eff79">cancel</a> ()</td></tr>
<tr class="memdesc:a50484235e76ca413565cc5ae7d6eff79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query whether user requested abort. <br /></td></tr>
<tr class="separator:a50484235e76ca413565cc5ae7d6eff79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classstdex_1_1progress"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classstdex_1_1progress')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classstdex_1_1progress.html">stdex::progress&lt; T &gt;</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ae275f56548be7f06802fa8880598f047" id="r_ae275f56548be7f06802fa8880598f047"><td class="memItemLeft" align="right" valign="top"><a id="ae275f56548be7f06802fa8880598f047" name="ae275f56548be7f06802fa8880598f047"></a>
<a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *&#160;</td><td class="memItemRight" valign="bottom"><b>m_host</b></td></tr>
<tr class="separator:ae275f56548be7f06802fa8880598f047"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f4c5b1fa1a8c624cc3dccc8888f097d" id="r_a7f4c5b1fa1a8c624cc3dccc8888f097d"><td class="memItemLeft" align="right" valign="top"><a id="a7f4c5b1fa1a8c624cc3dccc8888f097d" name="a7f4c5b1fa1a8c624cc3dccc8888f097d"></a>
std::chrono::high_resolution_clock::time_point&#160;</td><td class="memItemRight" valign="bottom"><b>m_deadline</b></td></tr>
<tr class="separator:a7f4c5b1fa1a8c624cc3dccc8888f097d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class T&gt;<br />
class stdex::timeout_progress&lt; T &gt;</div><p>Timeout progress indicator. </p>
<p>Use to cancel long running jobs after the deadline. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aeb3820c8c82dfe10d33c4e24269acf26" name="aeb3820c8c82dfe10d33c4e24269acf26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb3820c8c82dfe10d33c4e24269acf26">&#9670;&#160;</a></span>timeout_progress()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1timeout__progress.html">stdex::timeout_progress</a>&lt; T &gt;::timeout_progress </td>
<td>(</td>
<td class="paramtype">const std::chrono::nanoseconds &amp;</td> <td class="paramname"><span class="paramname"><em>timeout</em></span><span class="paramdefsep"> = </span><span class="paramdefval">std::chrono::seconds(60)</span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstdex_1_1progress.html">progress</a>&lt; T &gt; *</td> <td class="paramname"><span class="paramname"><em>host</em></span><span class="paramdefsep"> = </span><span class="paramdefval">nullptr</span>&#160;)</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>Constructs a timeout progress indicator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>Timeout when to cancel the progress </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a50484235e76ca413565cc5ae7d6eff79" name="a50484235e76ca413565cc5ae7d6eff79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50484235e76ca413565cc5ae7d6eff79">&#9670;&#160;</a></span>cancel()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="classstdex_1_1timeout__progress.html">stdex::timeout_progress</a>&lt; T &gt;::cancel </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Query whether user requested abort. </p>
<p>Reimplemented from <a class="el" href="classstdex_1_1progress.html#a03380c822297092b3bb9867deee26202">stdex::progress&lt; T &gt;</a>.</p>
</div>
</div>
<a id="a4cb32662b73a88a2d519b1767d96d1df" name="a4cb32662b73a88a2d519b1767d96d1df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4cb32662b73a88a2d519b1767d96d1df">&#9670;&#160;</a></span>set()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classstdex_1_1timeout__progress.html">stdex::timeout_progress</a>&lt; T &gt;::set </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>value</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set current progress. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Current value of the progress. Must be between start and end parameters provided in <a class="el" href="#a2e77eaf88a2b82d0045b69030af971d9" title="Set progress range extent.">set_range()</a> call. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classstdex_1_1progress.html#acf3a29daf22709bf7e94e864c8be95a1">stdex::progress&lt; T &gt;</a>.</p>
</div>
</div>
<a id="a2e77eaf88a2b82d0045b69030af971d9" name="a2e77eaf88a2b82d0045b69030af971d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e77eaf88a2b82d0045b69030af971d9">&#9670;&#160;</a></span>set_range()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classstdex_1_1timeout__progress.html">stdex::timeout_progress</a>&lt; T &gt;::set_range </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>start</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>end</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set progress range extent. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">start</td><td>Minimum value of the progress </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">end</td><td>Maximum value of the progress </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classstdex_1_1progress.html#afbb1513bdb20340ebb21bd988f4e424a">stdex::progress&lt; T &gt;</a>.</p>
</div>
</div>
<a id="a499e6d9561358a764cbc1547a9273e62" name="a499e6d9561358a764cbc1547a9273e62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a499e6d9561358a764cbc1547a9273e62">&#9670;&#160;</a></span>set_text()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classstdex_1_1timeout__progress.html">stdex::timeout_progress</a>&lt; T &gt;::set_text </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>msg</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set progress indicator text. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Text to display </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classstdex_1_1progress.html#a2cab8b5ac137d16fced31ee205264b01">stdex::progress&lt; T &gt;</a>.</p>
</div>
</div>
<a id="af35da3be39391df927ee4b0830d4df00" name="af35da3be39391df927ee4b0830d4df00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af35da3be39391df927ee4b0830d4df00">&#9670;&#160;</a></span>show()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classstdex_1_1timeout__progress.html">stdex::timeout_progress</a>&lt; T &gt;::show </td>
<td>(</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>show</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Show or hide progress. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">show</td><td>Shows or hides progress indicator </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classstdex_1_1progress.html#ab6e57aed9e7a18a501e8a63cef199d8e">stdex::progress&lt; T &gt;</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/stdex/<a class="el" href="progress_8hpp_source.html">progress.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Oct 1 2024 14:47:47 for stdex by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink