doc/html/boost/type_erasure/binding.html

   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=US-ASCII">
   5 <title>Class template binding</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="../../boost_typeerasure/reference.html#header.boost.type_erasure.binding_hpp" title="Header &lt;boost/type_erasure/binding.hpp&gt;">
  10 <link rel="prev" href="dynamic_binding.html" title="Class template dynamic_binding">
  11 <link rel="next" href="binding_of.html" title="Function template binding_of">
  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="dynamic_binding.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_typeerasure/reference.html#header.boost.type_erasure.binding_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="binding_of.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.type_erasure.binding"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class template binding</span></h2>
  30 <p>boost::type_erasure::binding</p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <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="../../boost_typeerasure/reference.html#header.boost.type_erasure.binding_hpp" title="Header &lt;boost/type_erasure/binding.hpp&gt;">boost/type_erasure/binding.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Concept<span class="special">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="binding.html" title="Class template binding">binding</a> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// <a class="link" href="binding.html#boost.type_erasure.bindingconstruct-copy-destruct">construct/copy/destruct</a></span>
  39   <a class="link" href="binding.html#idp758603472-bb"><span class="identifier">binding</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  40   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Map<span class="special">&gt;</span> <span class="keyword">explicit</span> <a class="link" href="binding.html#idp758606320-bb"><span class="identifier">binding</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Map</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  41   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Map<span class="special">&gt;</span> <a class="link" href="binding.html#idp758610736-bb"><span class="identifier">binding</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="static_binding.html" title="Struct template static_binding">static_binding</a><span class="special">&lt;</span> <span class="identifier">Map</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  42   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Concept2<span class="special">,</span> <span class="keyword">typename</span> Map<span class="special">&gt;</span>
  43     <a class="link" href="binding.html#idp758615328-bb"><span class="identifier">binding</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binding.html" title="Class template binding">binding</a><span class="special">&lt;</span> <span class="identifier">Concept2</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Map</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  44   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Concept2<span class="special">,</span> <span class="keyword">typename</span> Map<span class="special">&gt;</span>
  45     <a class="link" href="binding.html#idp758621248-bb"><span class="identifier">binding</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binding.html" title="Class template binding">binding</a><span class="special">&lt;</span> <span class="identifier">Concept2</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="static_binding.html" title="Struct template static_binding">static_binding</a><span class="special">&lt;</span> <span class="identifier">Map</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  46   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Placeholders<span class="special">,</span> <span class="keyword">typename</span> Map<span class="special">&gt;</span>
  47     <a class="link" href="binding.html#idp758627616-bb"><span class="identifier">binding</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="dynamic_binding.html" title="Class template dynamic_binding">dynamic_binding</a><span class="special">&lt;</span> <span class="identifier">Placeholders</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span>
  48             <span class="keyword">const</span> <a class="link" href="static_binding.html" title="Struct template static_binding">static_binding</a><span class="special">&lt;</span> <span class="identifier">Map</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  49
  50   <span class="comment">// <a class="link" href="binding.html#idp758592592-bb">friend functions</a></span>
  51   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="binding.html#idp758593152-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binding.html" title="Class template binding">binding</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="binding.html" title="Class template binding">binding</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  52   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="binding.html#idp758597888-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binding.html" title="Class template binding">binding</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="binding.html" title="Class template binding">binding</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  53 <span class="special">}</span><span class="special">;</span></pre></div>
  54 <div class="refsect1">
  55 <a name="idp565224432"></a><h2>Description</h2>
  56 <p>Stores the binding of a <code class="computeroutput">Concept</code> to a set of actual types. <code class="computeroutput">Concept</code> is interpreted in the same way as with <a class="link" href="any.html" title="Class template any">any</a>. </p>
  57 <div class="refsect2">
  58 <a name="idp565227328"></a><h3>
  59 <a name="boost.type_erasure.bindingconstruct-copy-destruct"></a><code class="computeroutput">binding</code>
  60         public
  61        construct/copy/destruct</h3>
  62 <div class="orderedlist"><ol class="orderedlist" type="1">
  63 <li class="listitem">
  64 <pre class="literallayout"><a name="idp758603472-bb"></a><span class="identifier">binding</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  65 <p>
  66
  67 </p>
  68 <div class="variablelist"><table border="0" class="variablelist compact">
  69 <colgroup>
  70 <col align="left" valign="top">
  71 <col>
  72 </colgroup>
  73 <tbody>
  74 <tr>
  75 <td><p><span class="term">Requires:</span></p></td>
  76 <td><p><a class="link" href="relaxed.html" title="Struct relaxed">relaxed</a> must be in <code class="computeroutput">Concept</code>.</p></td>
  77 </tr>
  78 <tr>
  79 <td><p><span class="term">Throws:</span></p></td>
  80 <td>Nothing. </td>
  81 </tr>
  82 </tbody>
  83 </table></div>
  84 </li>
  85 <li class="listitem">
  86 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Map<span class="special">&gt;</span> <span class="keyword">explicit</span> <a name="idp758606320-bb"></a><span class="identifier">binding</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Map</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>
  87 <p>
  88
  89 </p>
  90 <div class="variablelist"><table border="0" class="variablelist compact">
  91 <colgroup>
  92 <col align="left" valign="top">
  93 <col>
  94 </colgroup>
  95 <tbody>
  96 <tr>
  97 <td><p><span class="term">Requires:</span></p></td>
  98 <td><p><code class="computeroutput">Map</code> must be an MPL map with an entry for each placeholder referred to by <code class="computeroutput">Concept</code>.</p></td>
  99 </tr>
 100 <tr>
 101 <td><p><span class="term">Throws:</span></p></td>
 102 <td>Nothing. </td>
 103 </tr>
 104 </tbody>
 105 </table></div>
 106 </li>
 107 <li class="listitem">
 108 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Map<span class="special">&gt;</span> <a name="idp758610736-bb"></a><span class="identifier">binding</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="static_binding.html" title="Struct template static_binding">static_binding</a><span class="special">&lt;</span> <span class="identifier">Map</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>
 109 <p>
 110
 111 </p>
 112 <div class="variablelist"><table border="0" class="variablelist compact">
 113 <colgroup>
 114 <col align="left" valign="top">
 115 <col>
 116 </colgroup>
 117 <tbody>
 118 <tr>
 119 <td><p><span class="term">Requires:</span></p></td>
 120 <td><p><code class="computeroutput">Map</code> must be an MPL map with an entry for each placeholder referred to by <code class="computeroutput">Concept</code>.</p></td>
 121 </tr>
 122 <tr>
 123 <td><p><span class="term">Throws:</span></p></td>
 124 <td>Nothing. </td>
 125 </tr>
 126 </tbody>
 127 </table></div>
 128 </li>
 129 <li class="listitem">
 130 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Concept2<span class="special">,</span> <span class="keyword">typename</span> Map<span class="special">&gt;</span>
 131   <a name="idp758615328-bb"></a><span class="identifier">binding</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binding.html" title="Class template binding">binding</a><span class="special">&lt;</span> <span class="identifier">Concept2</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Map</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>
 132 <p>Converts from another set of bindings.</p>
 133 <p>
 134
 135 </p>
 136 <div class="variablelist"><table border="0" class="variablelist compact">
 137 <colgroup>
 138 <col align="left" valign="top">
 139 <col>
 140 </colgroup>
 141 <tbody>
 142 <tr>
 143 <td><p><span class="term">Requires:</span></p></td>
 144 <td><p>Map must be an MPL map with an entry for each placeholder referred to by <code class="computeroutput">Concept</code>. The mapped type should be the corresponding placeholder in Concept2.</p></td>
 145 </tr>
 146 <tr>
 147 <td><p><span class="term">Throws:</span></p></td>
 148 <td>std::bad_alloc </td>
 149 </tr>
 150 </tbody>
 151 </table></div>
 152 </li>
 153 <li class="listitem">
 154 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Concept2<span class="special">,</span> <span class="keyword">typename</span> Map<span class="special">&gt;</span>
 155   <a name="idp758621248-bb"></a><span class="identifier">binding</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binding.html" title="Class template binding">binding</a><span class="special">&lt;</span> <span class="identifier">Concept2</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="static_binding.html" title="Struct template static_binding">static_binding</a><span class="special">&lt;</span> <span class="identifier">Map</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>
 156 <p>Converts from another set of bindings.</p>
 157 <p>
 158
 159 </p>
 160 <div class="variablelist"><table border="0" class="variablelist compact">
 161 <colgroup>
 162 <col align="left" valign="top">
 163 <col>
 164 </colgroup>
 165 <tbody>
 166 <tr>
 167 <td><p><span class="term">Requires:</span></p></td>
 168 <td><p>Map must be an MPL map with an entry for each placeholder referred to by <code class="computeroutput">Concept</code>. The mapped type should be the corresponding placeholder in Concept2.</p></td>
 169 </tr>
 170 <tr>
 171 <td><p><span class="term">Throws:</span></p></td>
 172 <td>std::bad_alloc </td>
 173 </tr>
 174 </tbody>
 175 </table></div>
 176 </li>
 177 <li class="listitem">
 178 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Placeholders<span class="special">,</span> <span class="keyword">typename</span> Map<span class="special">&gt;</span>
 179   <a name="idp758627616-bb"></a><span class="identifier">binding</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="dynamic_binding.html" title="Class template dynamic_binding">dynamic_binding</a><span class="special">&lt;</span> <span class="identifier">Placeholders</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">,</span>
 180           <span class="keyword">const</span> <a class="link" href="static_binding.html" title="Struct template static_binding">static_binding</a><span class="special">&lt;</span> <span class="identifier">Map</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>
 181 <p>Converts from another set of bindings.</p>
 182 <p>
 183
 184 </p>
 185 <div class="variablelist"><table border="0" class="variablelist compact">
 186 <colgroup>
 187 <col align="left" valign="top">
 188 <col>
 189 </colgroup>
 190 <tbody>
 191 <tr>
 192 <td><p><span class="term">Requires:</span></p></td>
 193 <td><p>Map must be an MPL map with an entry for each placeholder referred to by <code class="computeroutput">Concept</code>. The mapped type should be the corresponding placeholder in Concept2.</p></td>
 194 </tr>
 195 <tr>
 196 <td><p><span class="term">Throws:</span></p></td>
 197 <td>std::bad_alloc </td>
 198 </tr>
 199 </tbody>
 200 </table></div>
 201 </li>
 202 </ol></div>
 203 </div>
 204 <div class="refsect2">
 205 <a name="idp565321216"></a><h3>
 206 <a name="idp758592592-bb"></a><code class="computeroutput">binding</code> friend functions</h3>
 207 <div class="orderedlist"><ol class="orderedlist" type="1">
 208 <li class="listitem">
 209 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp758593152-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binding.html" title="Class template binding">binding</a> <span class="special">&amp;</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="binding.html" title="Class template binding">binding</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 210 <p>
 211
 212 </p>
 213 <div class="variablelist"><table border="0" class="variablelist compact">
 214 <colgroup>
 215 <col align="left" valign="top">
 216 <col>
 217 </colgroup>
 218 <tbody>
 219 <tr>
 220 <td><p><span class="term">Returns:</span></p></td>
 221 <td><p>true iff the sets of types that the placeholders bind to are the same for both arguments.</p></td>
 222 </tr>
 223 <tr>
 224 <td><p><span class="term">Throws:</span></p></td>
 225 <td>Nothing. </td>
 226 </tr>
 227 </tbody>
 228 </table></div>
 229 </li>
 230 <li class="listitem">
 231 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp758597888-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binding.html" title="Class template binding">binding</a> <span class="special">&amp;</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="binding.html" title="Class template binding">binding</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 232 <p>
 233
 234 </p>
 235 <div class="variablelist"><table border="0" class="variablelist compact">
 236 <colgroup>
 237 <col align="left" valign="top">
 238 <col>
 239 </colgroup>
 240 <tbody>
 241 <tr>
 242 <td><p><span class="term">Returns:</span></p></td>
 243 <td><p>true iff the arguments do not map to identical sets of types.</p></td>
 244 </tr>
 245 <tr>
 246 <td><p><span class="term">Throws:</span></p></td>
 247 <td>Nothing. </td>
 248 </tr>
 249 </tbody>
 250 </table></div>
 251 </li>
 252 </ol></div>
 253 </div>
 254 </div>
 255 </div>
 256 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 257 <td align="left"></td>
 258 <td align="right"><div class="copyright-footer">Copyright &#169; 2011-2013 Steven Watanabe<p>
 259         Distributed under the Boost Software License, Version 1.0. (See accompanying
 260         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 261       </p>
 262 </div></td>
 263 </tr></table>
 264 <hr>
 265 <div class="spirit-nav">
 266 <a accesskey="p" href="dynamic_binding.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_typeerasure/reference.html#header.boost.type_erasure.binding_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="binding_of.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 267 </div>
 268 </body>
 269 </html>