1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Class function_base</title> 6<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../function/reference.html#header.boost.function_hpp" title="Header <boost/function.hpp>"> 10<link rel="prev" href="bad_function_call.html" title="Class bad_function_call"> 11<link rel="next" href="functionN.html" title="Class template functionN"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> 16<td align="center"><a href="../../../index.html">Home</a></td> 17<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="bad_function_call.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../function/reference.html#header.boost.function_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="functionN.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.function_base"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class function_base</span></h2> 30<p>boost::function_base — The common base class for all Boost.Function 31 objects. Objects of type function_base may not be created 32 directly.</p> 33</div> 34<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 35<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../function/reference.html#header.boost.function_hpp" title="Header <boost/function.hpp>">boost/function.hpp</a>> 36 37</span> 38<span class="keyword">class</span> <a class="link" href="function_base.html" title="Class function_base">function_base</a> <span class="special">{</span> 39<span class="keyword">public</span><span class="special">:</span> 40 41 <span class="comment">// <a class="link" href="function_base.html#id-1_3_17_6_2_1_2_2-bb">capacity</a></span> 42 <span class="keyword">bool</span> <a class="link" href="function_base.html#id-1_3_17_6_2_1_2_2_1-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 43 44 <span class="comment">// <a class="link" href="function_base.html#id-1_3_17_6_2_1_2_3-bb">target access</a></span> 45 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Functor<span class="special">></span> <span class="identifier">Functor</span><span class="special">*</span> <a class="link" href="function_base.html#id-1_3_17_6_2_1_2_3_1_1-bb"><span class="identifier">target</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 46 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Functor<span class="special">></span> <span class="keyword">const</span> <span class="identifier">Functor</span><span class="special">*</span> <a class="link" href="function_base.html#id-1_3_17_6_2_1_2_3_1_2-bb"><span class="identifier">target</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 47 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Functor<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="function_base.html#id-1_3_17_6_2_1_2_3_2-bb"><span class="identifier">contains</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Functor</span><span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 48 <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span><span class="special">&</span> <a class="link" href="function_base.html#id-1_3_17_6_2_1_2_3_3-bb"><span class="identifier">target_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 49<span class="special">}</span><span class="special">;</span></pre></div> 50<div class="refsect1"> 51<a name="id-1.3.17.6.3.4.4"></a><h2>Description</h2> 52<div class="refsect2"> 53<a name="id-1.3.17.6.3.4.4.2"></a><h3> 54<a name="id-1_3_17_6_2_1_2_2-bb"></a><code class="computeroutput">function_base</code> capacity</h3> 55<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 56<pre class="literallayout"><span class="keyword">bool</span> <a name="id-1_3_17_6_2_1_2_2_1-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 57<div class="variablelist"><table border="0" class="variablelist compact"> 58<colgroup> 59<col align="left" valign="top"> 60<col> 61</colgroup> 62<tbody> 63<tr> 64<td><p><span class="term">Returns:</span></p></td> 65<td> 66<code class="computeroutput">false</code> if <code class="computeroutput">this</code> has a target, and <code class="computeroutput">true</code> otherwise.</td> 67</tr> 68<tr> 69<td><p><span class="term">Throws:</span></p></td> 70<td>Will not throw.</td> 71</tr> 72</tbody> 73</table></div> 74</li></ol></div> 75</div> 76<div class="refsect2"> 77<a name="id-1.3.17.6.3.4.4.3"></a><h3> 78<a name="id-1_3_17_6_2_1_2_3-bb"></a><code class="computeroutput">function_base</code> target access</h3> 79<div class="orderedlist"><ol class="orderedlist" type="1"> 80<li class="listitem"> 81<pre class="literallayout"><a name="id-1_3_17_6_2_1_2_3_1-bb"></a><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Functor<span class="special">></span> <span class="identifier">Functor</span><span class="special">*</span> <a name="id-1_3_17_6_2_1_2_3_1_1-bb"></a><span class="identifier">target</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> 82<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Functor<span class="special">></span> <span class="keyword">const</span> <span class="identifier">Functor</span><span class="special">*</span> <a name="id-1_3_17_6_2_1_2_3_1_2-bb"></a><span class="identifier">target</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 83<div class="variablelist"><table border="0" class="variablelist compact"> 84<colgroup> 85<col align="left" valign="top"> 86<col> 87</colgroup> 88<tbody> 89<tr> 90<td><p><span class="term">Returns:</span></p></td> 91<td>If <code class="computeroutput">this</code> stores a target of type 92 <code class="computeroutput">Functor</code>, returns the address of the 93 target. Otherwise, returns the NULL 94 pointer.</td> 95</tr> 96<tr> 97<td><p><span class="term">Throws:</span></p></td> 98<td>Will not throw.</td> 99</tr> 100</tbody> 101</table></div> 102</li> 103<li class="listitem"> 104<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Functor<span class="special">></span> <span class="keyword">bool</span> <a name="id-1_3_17_6_2_1_2_3_2-bb"></a><span class="identifier">contains</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Functor</span><span class="special">&</span> f<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 105<div class="variablelist"><table border="0" class="variablelist compact"> 106<colgroup> 107<col align="left" valign="top"> 108<col> 109</colgroup> 110<tbody><tr> 111<td><p><span class="term">Returns:</span></p></td> 112<td> 113<code class="computeroutput">true</code> if <code class="computeroutput">this-><a class="link" href="function_base.html#id-1_3_17_6_2_1_2_3_1-bb">target</a><Functor>()</code> is non-NULL and <code class="computeroutput"><a class="link" href="function_equal.html" title="Function template function_equal">function_equal</a>(*(this->target<Functor>()), f)</code> 114</td> 115</tr></tbody> 116</table></div> 117</li> 118<li class="listitem"> 119<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span><span class="special">&</span> <a name="id-1_3_17_6_2_1_2_3_3-bb"></a><span class="identifier">target_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 120<div class="variablelist"><table border="0" class="variablelist compact"> 121<colgroup> 122<col align="left" valign="top"> 123<col> 124</colgroup> 125<tbody> 126<tr> 127<td><p><span class="term">Returns:</span></p></td> 128<td> 129<code class="computeroutput">typeid</code> of the target function object, or <code class="computeroutput">typeid(void)</code> if <code class="computeroutput">this-><a class="link" href="function_base.html#id-1_3_17_6_2_1_2_2_1-bb">empty</a>()</code>. Works even with RTTI off.</td> 130</tr> 131<tr> 132<td><p><span class="term">Throws:</span></p></td> 133<td>Will not throw.</td> 134</tr> 135</tbody> 136</table></div> 137</li> 138</ol></div> 139</div> 140</div> 141</div> 142<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 143<td align="left"></td> 144<td align="right"><div class="copyright-footer">Copyright © 2001-2004 Douglas Gregor<p>Use, modification and distribution is subject to the Boost 145 Software License, Version 1.0. (See accompanying file 146 <code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</p> 147</div></td> 148</tr></table> 149<hr> 150<div class="spirit-nav"> 151<a accesskey="p" href="bad_function_call.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../function/reference.html#header.boost.function_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="functionN.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> 152</div> 153</body> 154</html> 155
