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

335 lines
18 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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::aggregate_progress&lt; T &gt;::worker_progress 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>
<script type="text/javascript" src="clipboard.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.10.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" 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');
$(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"><b>stdex</b></li><li class="navelem"><a class="el" href="classstdex_1_1aggregate__progress.html">aggregate_progress</a></li><li class="navelem"><a class="el" href="classstdex_1_1aggregate__progress_1_1worker__progress.html">worker_progress</a></li> </ul>
</div>
</div><!-- top -->
<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_1aggregate__progress_1_1worker__progress-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::aggregate_progress&lt; T &gt;::worker_progress Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Progress indicator for individual worker.
<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::aggregate_progress&lt; T &gt;::worker_progress:</div>
<div class="dyncontent">
<div class="center">
<img src="classstdex_1_1aggregate__progress_1_1worker__progress.png" usemap="#stdex::aggregate_5Fprogress_3C_20T_20_3E::worker_5Fprogress_map" alt=""/>
<map id="stdex::aggregate_5Fprogress_3C_20T_20_3E::worker_5Fprogress_map" name="stdex::aggregate_5Fprogress_3C_20T_20_3E::worker_5Fprogress_map">
<area href="classstdex_1_1progress.html" title="Progress indicator base class." alt="stdex::progress&lt; T &gt;" shape="rect" coords="0,0,294,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:a455d70012c0d9cca29b9a9845a7ac4bb" id="r_a455d70012c0d9cca29b9a9845a7ac4bb"><td class="memItemLeft" align="right" valign="top"><a id="a455d70012c0d9cca29b9a9845a7ac4bb" name="a455d70012c0d9cca29b9a9845a7ac4bb"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>worker_progress</b> (<a class="el" href="classstdex_1_1aggregate__progress.html">aggregate_progress</a>&lt; T &gt; &amp;host)</td></tr>
<tr class="separator:a455d70012c0d9cca29b9a9845a7ac4bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae84e8b08865cf05024e8a777d9a75711" id="r_ae84e8b08865cf05024e8a777d9a75711"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae84e8b08865cf05024e8a777d9a75711">set_text</a> (const char *msg)</td></tr>
<tr class="memdesc:ae84e8b08865cf05024e8a777d9a75711"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set progress indicator text. <br /></td></tr>
<tr class="separator:ae84e8b08865cf05024e8a777d9a75711"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab11e34d7b3bb61db20f98379813f3ad6" id="r_ab11e34d7b3bb61db20f98379813f3ad6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab11e34d7b3bb61db20f98379813f3ad6">set_range</a> (T start, T end)</td></tr>
<tr class="memdesc:ab11e34d7b3bb61db20f98379813f3ad6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set local extend of the progress indicator. <br /></td></tr>
<tr class="separator:ab11e34d7b3bb61db20f98379813f3ad6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61a1f4accad5a1243e1bbf4084205bef" id="r_a61a1f4accad5a1243e1bbf4084205bef"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a61a1f4accad5a1243e1bbf4084205bef">set</a> (T value)</td></tr>
<tr class="memdesc:a61a1f4accad5a1243e1bbf4084205bef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set local current progress. <br /></td></tr>
<tr class="separator:a61a1f4accad5a1243e1bbf4084205bef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa48fb208c1bf38d041669e4b1d0b8a46" id="r_aa48fb208c1bf38d041669e4b1d0b8a46"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa48fb208c1bf38d041669e4b1d0b8a46">show</a> (bool show=true)</td></tr>
<tr class="memdesc:aa48fb208c1bf38d041669e4b1d0b8a46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Show or hide progress. <br /></td></tr>
<tr class="separator:aa48fb208c1bf38d041669e4b1d0b8a46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61defd3930ff3a62d56890c80f60086a" id="r_a61defd3930ff3a62d56890c80f60086a"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a61defd3930ff3a62d56890c80f60086a">cancel</a> ()</td></tr>
<tr class="memdesc:a61defd3930ff3a62d56890c80f60086a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query whether user requested abort. <br /></td></tr>
<tr class="separator:a61defd3930ff3a62d56890c80f60086a"><td class="memSeparator" colspan="2">&#160;</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:a7b80322fe7bb65e4919d79fe79ed1a5a" id="r_a7b80322fe7bb65e4919d79fe79ed1a5a"><td class="memItemLeft" align="right" valign="top"><a id="a7b80322fe7bb65e4919d79fe79ed1a5a" name="a7b80322fe7bb65e4919d79fe79ed1a5a"></a>
<a class="el" href="classstdex_1_1aggregate__progress.html">aggregate_progress</a>&lt; T &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>m_host</b></td></tr>
<tr class="separator:a7b80322fe7bb65e4919d79fe79ed1a5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd799957015233ceb25721f41ff655dd" id="r_afd799957015233ceb25721f41ff655dd"><td class="memItemLeft" align="right" valign="top"><a id="afd799957015233ceb25721f41ff655dd" name="afd799957015233ceb25721f41ff655dd"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>m_start</b></td></tr>
<tr class="separator:afd799957015233ceb25721f41ff655dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e0458751548c7bf5da6aad6b4567bfc" id="r_a0e0458751548c7bf5da6aad6b4567bfc"><td class="memItemLeft" align="right" valign="top"><a id="a0e0458751548c7bf5da6aad6b4567bfc" name="a0e0458751548c7bf5da6aad6b4567bfc"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>m_end</b></td></tr>
<tr class="separator:a0e0458751548c7bf5da6aad6b4567bfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbb82e73517c18d25cf8e712d8723307" id="r_adbb82e73517c18d25cf8e712d8723307"><td class="memItemLeft" align="right" valign="top"><a id="adbb82e73517c18d25cf8e712d8723307" name="adbb82e73517c18d25cf8e712d8723307"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>m_value</b></td></tr>
<tr class="separator:adbb82e73517c18d25cf8e712d8723307"><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::aggregate_progress&lt; T &gt;::worker_progress</div><p>Progress indicator for individual worker. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a61defd3930ff3a62d56890c80f60086a" name="a61defd3930ff3a62d56890c80f60086a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61defd3930ff3a62d56890c80f60086a">&#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_1aggregate__progress.html">stdex::aggregate_progress</a>&lt; T &gt;::worker_progress::cancel </td>
<td>(</td>
<td class="paramname"><span class="paramname"></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="a61a1f4accad5a1243e1bbf4084205bef" name="a61a1f4accad5a1243e1bbf4084205bef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61a1f4accad5a1243e1bbf4084205bef">&#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_1aggregate__progress.html">stdex::aggregate_progress</a>&lt; T &gt;::worker_progress::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 local 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="#ab11e34d7b3bb61db20f98379813f3ad6" title="Set local extend of the progress indicator.">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="ab11e34d7b3bb61db20f98379813f3ad6" name="ab11e34d7b3bb61db20f98379813f3ad6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab11e34d7b3bb61db20f98379813f3ad6">&#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_1aggregate__progress.html">stdex::aggregate_progress</a>&lt; T &gt;::worker_progress::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 local extend of the progress indicator. </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="ae84e8b08865cf05024e8a777d9a75711" name="ae84e8b08865cf05024e8a777d9a75711"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae84e8b08865cf05024e8a777d9a75711">&#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_1aggregate__progress.html">stdex::aggregate_progress</a>&lt; T &gt;::worker_progress::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="aa48fb208c1bf38d041669e4b1d0b8a46" name="aa48fb208c1bf38d041669e4b1d0b8a46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa48fb208c1bf38d041669e4b1d0b8a46">&#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_1aggregate__progress.html">stdex::aggregate_progress</a>&lt; T &gt;::worker_progress::show </td>
<td>(</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>show</em><span class="paramdefsep"> = </span><span class="paramdefval">true</span></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 Wed Feb 14 2024 14:06:27 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.10.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink