<!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.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libzypp: zypp::CombinedProgressData 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="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> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</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 style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libzypp  <span id="projectnumber">17.9.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('classzypp_1_1CombinedProgressData.html','');}); /* @license-end */ </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pri-attribs">Private Attributes</a> | <a href="classzypp_1_1CombinedProgressData-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">zypp::CombinedProgressData Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Progress callback from another progress. <a href="classzypp_1_1CombinedProgressData.html#details">More...</a></p> <p><code>#include <<a class="el" href="ProgressData_8h_source.html">ProgressData.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a466b88a9d36b3547f257aa592493847c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1CombinedProgressData.html#a466b88a9d36b3547f257aa592493847c">CombinedProgressData</a> (<a class="el" href="classzypp_1_1ProgressData.html">ProgressData</a> &pd, <a class="el" href="classzypp_1_1ProgressData.html#a2fde90d6cf8ea72b4a3be3185d45fe5d">ProgressData::value_type</a> weight=0)</td></tr> <tr class="memdesc:a466b88a9d36b3547f257aa592493847c"><td class="mdescLeft"> </td><td class="mdescRight">Ctor. <a href="#a466b88a9d36b3547f257aa592493847c">More...</a><br /></td></tr> <tr class="separator:a466b88a9d36b3547f257aa592493847c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a13abaa838ebca2bc457088ead63f2119"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbool.html">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1CombinedProgressData.html#a13abaa838ebca2bc457088ead63f2119">operator()</a> (const <a class="el" href="classzypp_1_1ProgressData.html">ProgressData</a> &progress)</td></tr> <tr class="memdesc:a13abaa838ebca2bc457088ead63f2119"><td class="mdescLeft"> </td><td class="mdescRight">Implements the <a class="el" href="classzypp_1_1ProgressData.html#a89143a717926c1fa891ba91f07ad7aa8">ProgressData::ReceiverFnc</a> callback interface. <a href="#a13abaa838ebca2bc457088ead63f2119">More...</a><br /></td></tr> <tr class="separator:a13abaa838ebca2bc457088ead63f2119"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a> Private Attributes</h2></td></tr> <tr class="memitem:a2abac8b0f41d6e0948b89f2e6508e20f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classzypp_1_1ProgressData.html#a2fde90d6cf8ea72b4a3be3185d45fe5d">ProgressData::value_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1CombinedProgressData.html#a2abac8b0f41d6e0948b89f2e6508e20f">_weight</a></td></tr> <tr class="separator:a2abac8b0f41d6e0948b89f2e6508e20f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6c252fe6e54d9dc2de5d30c638133030"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classzypp_1_1ProgressData.html#a2fde90d6cf8ea72b4a3be3185d45fe5d">ProgressData::value_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1CombinedProgressData.html#a6c252fe6e54d9dc2de5d30c638133030">_last_value</a></td></tr> <tr class="separator:a6c252fe6e54d9dc2de5d30c638133030"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a04b6784da55861b0ba9e921a3d6df855"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classzypp_1_1ProgressData.html">ProgressData</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1CombinedProgressData.html#a04b6784da55861b0ba9e921a3d6df855">_pd</a></td></tr> <tr class="separator:a04b6784da55861b0ba9e921a3d6df855"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Progress callback from another progress. </p> <p>This class allows you to pass a progress callback to a subtask based on a current progress data, plus a weight value. Every progress reported by the subtask via this callback will be forwarded to the main progress data, with the corresponding weight.</p> <p>Example:</p> <div class="fragment"><div class="line"><span class="comment">// receiver for main task</span></div><div class="line"><span class="keywordtype">void</span> task_receiver( ProgressData &progress );</div><div class="line"></div><div class="line"><span class="comment">// subtask prototypes</span></div><div class="line"><span class="keywordtype">void</span> do_subtask_one( <a class="code" href="classzypp_1_1ProgressData.html#a89143a717926c1fa891ba91f07ad7aa8">ProgressData::ReceiverFnc</a> &fnc );</div><div class="line"><span class="keywordtype">void</span> do_subtask_two( <a class="code" href="classzypp_1_1ProgressData.html#a89143a717926c1fa891ba91f07ad7aa8">ProgressData::ReceiverFnc</a> &fnc );</div><div class="line"></div><div class="line"><span class="comment">// main task</span></div><div class="line">ProgressData progress;</div><div class="line"><span class="comment">//progress for subtask 1</span></div><div class="line"><span class="comment">// which is 80%</span></div><div class="line"><a class="code" href="classzypp_1_1CombinedProgressData.html#a466b88a9d36b3547f257aa592493847c">CombinedProgressData</a> sub1(pd, 80);</div><div class="line"><span class="comment">// the second is only 20%</span></div><div class="line"><a class="code" href="classzypp_1_1CombinedProgressData.html#a466b88a9d36b3547f257aa592493847c">CombinedProgressData</a> sub2(pd, 20);</div><div class="line">do_subtask_one( sub1 );</div><div class="line">do_subtask_two( sub2 );</div></div><!-- fragment --> <p class="definition">Definition at line <a class="el" href="ProgressData_8h_source.html#l00390">390</a> of file <a class="el" href="ProgressData_8h_source.html">ProgressData.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a466b88a9d36b3547f257aa592493847c"></a> <h2 class="memtitle"><span class="permalink"><a href="#a466b88a9d36b3547f257aa592493847c">◆ </a></span>CombinedProgressData()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">zypp::CombinedProgressData::CombinedProgressData </td> <td>(</td> <td class="paramtype"><a class="el" href="classzypp_1_1ProgressData.html">ProgressData</a> & </td> <td class="paramname"><em>pd</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classzypp_1_1ProgressData.html#a2fde90d6cf8ea72b4a3be3185d45fe5d">ProgressData::value_type</a> </td> <td class="paramname"><em>weight</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Ctor. </p> <p>Creates a <a class="el" href="classzypp_1_1ProgressData.html#a89143a717926c1fa891ba91f07ad7aa8">ProgressData::ReceiverFnc</a> from a <a class="el" href="classzypp_1_1ProgressData.html">ProgressData</a> object</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pd</td><td><a class="el" href="classzypp_1_1ProgressData.html">ProgressData</a> object </td></tr> <tr><td class="paramname">weight</td><td>Weight of the subtask relative to the main task range.</td></tr> </table> </dd> </dl> <p>If weight is 0, or</p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pd</td><td>only reports keepalives. then only ticks are sent. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="ProgressData_8cc_source.html#l00126">126</a> of file <a class="el" href="ProgressData_8cc_source.html">ProgressData.cc</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="a13abaa838ebca2bc457088ead63f2119"></a> <h2 class="memtitle"><span class="permalink"><a href="#a13abaa838ebca2bc457088ead63f2119">◆ </a></span>operator()()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classbool.html">bool</a> zypp::CombinedProgressData::operator() </td> <td>(</td> <td class="paramtype">const <a class="el" href="classzypp_1_1ProgressData.html">ProgressData</a> & </td> <td class="paramname"><em>progress</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Implements the <a class="el" href="classzypp_1_1ProgressData.html#a89143a717926c1fa891ba91f07ad7aa8">ProgressData::ReceiverFnc</a> callback interface. </p> <p class="definition">Definition at line <a class="el" href="ProgressData_8cc_source.html#l00135">135</a> of file <a class="el" href="ProgressData_8cc_source.html">ProgressData.cc</a>.</p> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a id="a2abac8b0f41d6e0948b89f2e6508e20f"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2abac8b0f41d6e0948b89f2e6508e20f">◆ </a></span>_weight</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classzypp_1_1ProgressData.html#a2fde90d6cf8ea72b4a3be3185d45fe5d">ProgressData::value_type</a> zypp::CombinedProgressData::_weight</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">private</span></span> </td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="ProgressData_8h_source.html#l00417">417</a> of file <a class="el" href="ProgressData_8h_source.html">ProgressData.h</a>.</p> </div> </div> <a id="a6c252fe6e54d9dc2de5d30c638133030"></a> <h2 class="memtitle"><span class="permalink"><a href="#a6c252fe6e54d9dc2de5d30c638133030">◆ </a></span>_last_value</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classzypp_1_1ProgressData.html#a2fde90d6cf8ea72b4a3be3185d45fe5d">ProgressData::value_type</a> zypp::CombinedProgressData::_last_value</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">private</span></span> </td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="ProgressData_8h_source.html#l00418">418</a> of file <a class="el" href="ProgressData_8h_source.html">ProgressData.h</a>.</p> </div> </div> <a id="a04b6784da55861b0ba9e921a3d6df855"></a> <h2 class="memtitle"><span class="permalink"><a href="#a04b6784da55861b0ba9e921a3d6df855">◆ </a></span>_pd</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classzypp_1_1ProgressData.html">ProgressData</a>& zypp::CombinedProgressData::_pd</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">private</span></span> </td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="ProgressData_8h_source.html#l00419">419</a> of file <a class="el" href="ProgressData_8h_source.html">ProgressData.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li>zypp/<a class="el" href="ProgressData_8h_source.html">ProgressData.h</a></li> <li>zypp/<a class="el" href="ProgressData_8cc_source.html">ProgressData.cc</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="namespacezypp.html">zypp</a></li><li class="navelem"><a class="el" href="classzypp_1_1CombinedProgressData.html">CombinedProgressData</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.8.15 </li> </ul> </div> </body> </html>