libs/contract/doc/html/BOOST_CONTRACT_OVERRIDE.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Macro BOOST_CONTRACT_OVERRIDE</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="index.html" title="Chapter&#160;1.&#160;Boost.Contract 1.0.0">
   8 <link rel="up" href="reference.html#header.boost.contract.override_hpp" title="Header &lt;boost/contract/override.hpp&gt;">
   9 <link rel="prev" href="BOOST_CO_idm45394998912688.html" title="Macro BOOST_CONTRACT_NAMED_OVERRIDE">
  10 <link rel="next" href="BOOST_CONTRACT_OVERRIDES.html" title="Macro BOOST_CONTRACT_OVERRIDES">
  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="BOOST_CO_idm45394998912688.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.contract.override_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="BOOST_CONTRACT_OVERRIDES.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="BOOST_CONTRACT_OVERRIDE"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Macro BOOST_CONTRACT_OVERRIDE</span></h2>
  29 <p>BOOST_CONTRACT_OVERRIDE &#8212; Declare an override type trait named <code class="computeroutput">override_<span class="emphasis"><em>func_name</em></span></code>. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <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="reference.html#header.boost.contract.override_hpp" title="Header &lt;boost/contract/override.hpp&gt;">boost/contract/override.hpp</a>&gt;
  33
  34 </span>BOOST_CONTRACT_OVERRIDE(func_name)</pre></div>
  35 <div class="refsect1">
  36 <a name="idm45707994046032"></a><h2>Description</h2>
  37 <p>Declare the override type trait named <code class="computeroutput">override_<span class="emphasis"><em>func_name</em></span></code> to pass as an explicit template parameter to <code class="computeroutput"><a class="link" href="boost/contract/public_f_idm45394998885120.html" title="Function template public_function">boost::contract::public_function</a></code> for public function overrides. Use <code class="computeroutput"><a class="link" href="BOOST_CO_idm45394998912688.html" title="Macro BOOST_CONTRACT_NAMED_OVERRIDE">BOOST_CONTRACT_NAMED_OVERRIDE</a></code> to generate an override type trait with a name different than <code class="computeroutput">override_<span class="emphasis"><em>func_name</em></span></code> (usually not needed).</p>
  38 <p><span class="bold"><strong>See Also:</strong></span></p>
  39 <p> <a class="link" href="boost_contract/tutorial.html#boost_contract.tutorial.public_function_overrides__subcontracting_" title="Public Function Overrides (Subcontracting)">
  40         Public Function Overrides</a></p>
  41 <p>
  42 </p>
  43 <p>
  44
  45 </p>
  46 <div class="variablelist"><table border="0" class="variablelist compact">
  47 <colgroup>
  48 <col align="left" valign="top">
  49 <col>
  50 </colgroup>
  51 <tbody><tr>
  52 <td><p><span class="term">Parameters:</span></p></td>
  53 <td><div class="variablelist"><table border="0" class="variablelist compact">
  54 <colgroup>
  55 <col align="left" valign="top">
  56 <col>
  57 </colgroup>
  58 <tbody><tr>
  59 <td><p><span class="term"><code class="computeroutput">func_name</code></span></p></td>
  60 <td><p>Function name of the public function override. This macro is called just once even if the function name is overloaded (the same override type trait is used for all overloaded functions with the same name, see  <a class="link" href="boost_contract/advanced.html#boost_contract.advanced.function_overloads" title="Function Overloads"> Function Overloads</a>). (This is not a variadic macro parameter but it should never contain any comma because it is an identifier.) </p></td>
  61 </tr></tbody>
  62 </table></div></td>
  63 </tr></tbody>
  64 </table></div>
  65 </div>
  66 </div>
  67 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  68 <td align="left"></td>
  69 <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
  70         Distributed under the Boost Software License, Version 1.0 (see accompanying
  71         file LICENSE_1_0.txt or a copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  72       </p>
  73 </div></td>
  74 </tr></table>
  75 <hr>
  76 <div class="spirit-nav">
  77 <a accesskey="p" href="BOOST_CO_idm45394998912688.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.contract.override_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="BOOST_CONTRACT_OVERRIDES.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  78 </div>
  79 </body>
  80 </html>