Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > media > main-release > by-pkgid > bd29e346140bd3fbcbf1674e576e565a > files > 249

libsigc++2.0-doc-2.2.7-1mdv2010.1.x86_64.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>libsigc++: sigc::signal&lt; T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7 &gt;::accumulated&lt; T_accumulator &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespacesigc.html">sigc</a>::<a class="el" href="classsigc_1_1signal.html">signal</a>::<a class="el" href="classsigc_1_1signal_1_1accumulated.html">accumulated</a>
  </div>
</div>
<div class="contents">
<h1>sigc::signal&lt; T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7 &gt;::accumulated&lt; T_accumulator &gt; Class Template Reference<br/>
<small>
[<a class="el" href="group__signal.html">Signals</a>]</small>
</h1><!-- doxytag: class="sigc::signal::accumulated" --><!-- doxytag: inherits="sigc::signal7" -->
<p>Convenience wrapper for the numbered <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">sigc::signal</a># templates. <a href="#_details">More...</a></p>

<p><code>#include &lt;sigc++/signal.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sigc::signal&lt; T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7 &gt;::accumulated&lt; T_accumulator &gt;:</div>
<div class="dynsection">
<div class="center"><img src="classsigc_1_1signal_1_1accumulated__inherit__graph.png" border="0" usemap="#sigc_1_1signal_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__arg5_00_01T__arg6_00_01T__arg7_01_4_1_1accumulated_3_01T__accumulator_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="sigc_1_1signal_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__arg5_00_01T__arg6_00_01T__arg7_01_4_1_1accumulated_3_01T__accumulator_01_4_inherit__map" id="sigc_1_1signal_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__arg5_00_01T__arg6_00_01T__arg7_01_4_1_1accumulated_3_01T__accumulator_01_4_inherit__map">
<area shape="rect" href="classsigc_1_1signal7.html" title="Signal declaration." alt="" coords="348,5,988,32"/><area shape="rect" href="structsigc_1_1signal__base.html" title="Base class for the sigc::signal# templates." alt="" coords="169,5,297,32"/><area shape="rect" href="structsigc_1_1trackable.html" title="Base class for objects with auto&#45;disconnection." alt="" coords="7,5,119,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classsigc_1_1signal_1_1accumulated-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a032428476a190d9dea6313f70e5b8a10"></a><!-- doxytag: member="sigc::signal::accumulated::accumulated" ref="a032428476a190d9dea6313f70e5b8a10" args="(const accumulated &amp;src)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>accumulated</b> (const <a class="el" href="classsigc_1_1signal_1_1accumulated.html">accumulated</a>&amp; src)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template &lt;class T_return, class T_arg1 = nil, class T_arg2 = nil, class T_arg3 = nil, class T_arg4 = nil, class T_arg5 = nil, class T_arg6 = nil, class T_arg7 = nil&gt;<br/>
template &lt;class T_accumulator&gt;<br/>
 class sigc::signal&lt; T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7 &gt;::accumulated&lt; T_accumulator &gt;</h3>

<p>Convenience wrapper for the numbered <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">sigc::signal</a># templates. </p>
<p>Like <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">sigc::signal</a> but the additional template parameter <em>T_accumulator</em> defines the accumulator type that should be used.</p>
<p>An accumulator is a functor that uses a pair of special iterators to step through a list of slots and calculate a return value from the results of the <a class="el" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">slot</a> invokations. The iterators' <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01143.html#ga547f511a7a33f8780e230af2fc64e34b">operator*()</a> executes the <a class="el" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">slot</a>. The return value is buffered, so that in an expression like </p>
<div class="fragment"><pre class="fragment"> a = (*i) * (*i); </pre></div><p> the <a class="el" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">slot</a> is executed only once. The accumulator must define its return value as <code>result_type</code>.</p>
<dl class="user"><dt><b>Example 1:</b></dt><dd>This accumulator calculates the arithmetic mean value: <div class="fragment"><pre class="fragment"> <span class="keyword">struct </span>arithmetic_mean_accumulator
   {
     <span class="keyword">typedef</span> <span class="keywordtype">double</span> result_type;
     <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T_iterator&gt;
     result_type <a class="code" href="classsigc_1_1signal7.html#a11b73bd2c5d40e02eab78b38ce0d097d" title="Triggers the emission of the signal (see emit()).">operator()</a>(T_iterator first, T_iterator last)<span class="keyword"> const</span>
<span class="keyword"> </span>{
       result_type value_ = 0;
       <span class="keywordtype">int</span> n_ = 0;
       <span class="keywordflow">for</span> (; first != last; ++first, ++n_)
         value_ += *first;
       <span class="keywordflow">return</span> value_ / n_;
     }
   };
</pre></div></dd></dl>
<dl class="user"><dt><b>Example 2:</b></dt><dd>This accumulator stops <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">signal</a> emission when a <a class="el" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">slot</a> returns zero: <div class="fragment"><pre class="fragment"> <span class="keyword">struct </span>interruptable_accumulator
   {
     <span class="keyword">typedef</span> <span class="keywordtype">bool</span> result_type;
     <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T_iterator&gt;
     result_type <a class="code" href="classsigc_1_1signal7.html#a11b73bd2c5d40e02eab78b38ce0d097d" title="Triggers the emission of the signal (see emit()).">operator()</a>(T_iterator first, T_iterator last)<span class="keyword"> const</span>
<span class="keyword"> </span>{
       <span class="keywordflow">for</span> (; first != last; ++first, ++n_)
         <span class="keywordflow">if</span> (!*first) <span class="keywordflow">return</span> <span class="keyword">false</span>;
       <span class="keywordflow">return</span> <span class="keyword">true</span>;
     }
   };
</pre></div> </dd></dl>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 21:44:45 2010 for libsigc++ by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>