1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Macro BOOST_CONTRACT_INVARIANT_FUNC</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 1. Boost.Contract 1.0.0"> 8<link rel="up" href="reference.html#header.boost.contract.core.config_hpp" title="Header <boost/contract/core/config.hpp>"> 9<link rel="prev" href="BOOST_CO_idm46268585544864.html" title="Macro BOOST_CONTRACT_BASES_TYPEDEF"> 10<link rel="next" href="BOOST_CO_idm46268585527232.html" title="Macro BOOST_CONTRACT_STATIC_INVARIANT_FUNC"> 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_idm46268585544864.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.contract.core.config_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_CO_idm46268585527232.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="BOOST_CO_idm46268585536960"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Macro BOOST_CONTRACT_INVARIANT_FUNC</span></h2> 29<p>BOOST_CONTRACT_INVARIANT_FUNC — Define the name of the class invariant member function (<code class="computeroutput">invariant</code> by default). </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: <<a class="link" href="reference.html#header.boost.contract.core.config_hpp" title="Header <boost/contract/core/config.hpp>">boost/contract/core/config.hpp</a>> 33 34</span>BOOST_CONTRACT_INVARIANT_FUNC</pre></div> 35<div class="refsect1"> 36<a name="idm45988679712592"></a><h2>Description</h2> 37<p>This macro expands to the name of the <code class="computeroutput">const</code> and <code class="computeroutput">const volatile</code> member functions that check class invariants and volatile class invariants respectively:</p> 38<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">u</span> <span class="special">{</span> 39 <span class="keyword">friend</span> <span class="keyword">class</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">contract</span><span class="special">::</span><span class="identifier">access</span><span class="special">;</span> 40 41 <span class="keyword">void</span> <span class="identifier">BOOST_CONTRACT_INVARIANT_FUNC</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">{</span> 42 <span class="identifier">BOOST_CONTRACT_ASSERT</span><span class="special">(</span><span class="special">...</span><span class="special">)</span><span class="special">;</span> 43 <span class="special">...</span> 44 <span class="special">}</span> 45 46 <span class="keyword">void</span> <span class="identifier">BOOST_CONTRACT_INVARIANT_FUNC</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">volatile</span> <span class="special">{</span> 47 <span class="identifier">BOOST_CONTRACT_ASSERT</span><span class="special">(</span><span class="special">...</span><span class="special">)</span><span class="special">;</span> 48 <span class="special">...</span> 49 <span class="special">}</span> 50 51 <span class="special">...</span> 52<span class="special">}</span><span class="special">;</span> 53</pre> 54<p>When used this way, users can redefine this macro if the invariant functions must have a name different from <code class="computeroutput">invariant</code> (because of name clashes in user code, etc.).</p> 55<div class="note"><table border="0" summary="Note"> 56<tr> 57<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> 58<th align="left">Note</th> 59</tr> 60<tr><td align="left" valign="top"><p>C++ does not allow to overload member functions based on the <code class="computeroutput">static</code> classifier, so this macro must always be defined to be different than the function name defined for <code class="computeroutput"><a class="link" href="BOOST_CO_idm46268585527232.html" title="Macro BOOST_CONTRACT_STATIC_INVARIANT_FUNC">BOOST_CONTRACT_STATIC_INVARIANT_FUNC</a></code>.</p></td></tr> 61</table></div> 62<p> 63</p> 64<p><span class="bold"><strong>See Also:</strong></span></p> 65<p> <a class="link" href="boost_contract/tutorial.html#boost_contract.tutorial.class_invariants" title="Class Invariants"> Class Invariants</a>, <a class="link" href="boost_contract/extras.html#boost_contract.extras.volatile_public_functions" title="Volatile Public Functions"> 66 Volatile Public Functions</a> </p> 67<p> 68</p> 69<p> 70</p> 71</div> 72</div> 73<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 74<td align="left"></td> 75<td align="right"><div class="copyright-footer">Copyright © 2008-2019 Lorenzo Caminiti<p> 76 Distributed under the Boost Software License, Version 1.0 (see accompanying 77 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>) 78 </p> 79</div></td> 80</tr></table> 81<hr> 82<div class="spirit-nav"> 83<a accesskey="p" href="BOOST_CO_idm46268585544864.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.contract.core.config_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_CO_idm46268585527232.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 84</div> 85</body> 86</html> 87