1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libsigc++ 2.0: sigc::signal< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7 >::accumulated< T_accumulator > Class Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/libsigc_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../index.html">Main Page</a>
<a class="qindex" href="modules.html">Groups</a>
<a class="qindex" href="namespaces.html"> Namespaces</a>
</center>
<hr width="100%"/>
<!-- Generated by Doxygen 1.3.9.1 -->
<h1>sigc::signal< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7 >::accumulated< T_accumulator > Class Template Reference<br>
<small>
[<a class="el" href="group__signal.html">Signals</a>]</small>
</h1>Convenience wrapper for the numbered <a class="el" href="classsigc_1_1signal.html">sigc::signal</a># templates.
<a href="#_details">More...</a>
<p>
Inheritance diagram for sigc::signal< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7 >::accumulated< T_accumulator >:<p><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"></center>
<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">
<area href="classsigc_1_1signal7.html" shape="rect" coords="54,158,662,182" alt="">
<area href="structsigc_1_1signal__base.html" shape="rect" coords="297,84,419,108" alt="">
<area href="structsigc_1_1trackable.html" shape="rect" coords="305,9,411,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classsigc_1_1signal_1_1accumulated-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1signal_1_1accumulated.html#a0">accumulated</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1signal_1_1accumulated.html#a1">accumulated</a> (const <a class="el" href="classsigc_1_1signal_1_1accumulated.html">accumulated</a>& src)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template <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><br>
template <class T_accumulator><br>
class sigc::signal< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7 >::accumulated< T_accumulator ></h3>
Convenience wrapper for the numbered <a class="el" href="classsigc_1_1signal.html">sigc::signal</a># templates.
<p>
Like <a class="el" href="classsigc_1_1signal.html">sigc::signal</a> but the additional template parameter <em>T_accumulator</em> defines the accumulator type that should be used.<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 slot invokations. The iterators' <a class="el" href="namespacesigc.html#a56">operator*()</a> executes the slot. The return value is buffered, so that in an expression like <div class="fragment"><pre class="fragment"> a = (* i)* (* i);
</pre></div>the slot is executed only once. The accumulator must define its return value as <code>result_type</code>.<p>
<dl compact><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><<span class="keyword">typename</span> T_iterator>
result_type <a class="code" href="classsigc_1_1signal7.html#a2">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 compact><dt><b>Example 2:</b></dt><dd>This accumulator stops signal emission when a slot 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><<span class="keyword">typename</span> T_iterator>
result_type <a class="code" href="classsigc_1_1signal7.html#a2">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>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="sigc::signal::accumulated::accumulated"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template <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> </td>
</tr>
<tr>
<td class="md" colspan="4">
template <class T_accumulator> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classsigc_1_1signal.html">sigc::signal</a><T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7>::<a class="el" href="classsigc_1_1signal_1_1accumulated.html">accumulated</a><T_accumulator>::<a class="el" href="classsigc_1_1signal_1_1accumulated.html">accumulated</a> </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="sigc::signal::accumulated::accumulated"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template <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> </td>
</tr>
<tr>
<td class="md" colspan="4">
template <class T_accumulator> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classsigc_1_1signal.html">sigc::signal</a><T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7>::<a class="el" href="classsigc_1_1signal_1_1accumulated.html">accumulated</a><T_accumulator>::<a class="el" href="classsigc_1_1signal_1_1accumulated.html">accumulated</a> </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">const <a class="el" href="classsigc_1_1signal_1_1accumulated.html">accumulated</a><T_accumulator>& </td>
<td class="mdname1" valign="top" nowrap> <em>src</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="signal_8h.html">signal.h</a></ul>
<hr><address><small>
Generated for libsigc++ 2.0 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.3.9.1 © 1997-2001</small></address>
</body>
</html>
|
