doc/html/boost/function_base.html

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