libs/contract/doc/html/boost/contract/old_value_copy.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct template old_value_copy</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.old_hpp" title="Header &lt;boost/contract/old.hpp&gt;">
   9 <link rel="prev" href="old_value.html" title="Class old_value">
  10 <link rel="next" href="null_old.html" title="Function null_old">
  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="old_value.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.old_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="null_old.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.contract.old_value_copy"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Struct template old_value_copy</span></h2>
  29 <p>boost::contract::old_value_copy &#8212; Trait to copy an old value. </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.old_hpp" title="Header &lt;boost/contract/old.hpp&gt;">boost/contract/old.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  35 <span class="keyword">struct</span> <a class="link" href="old_value_copy.html" title="Struct template old_value_copy">old_value_copy</a> <span class="special">{</span>
  36   <span class="comment">// <a class="link" href="old_value_copy.html#boost.contract.old_value_copyconstruct-copy-destruct">construct/copy/destruct</a></span>
  37   <span class="keyword">explicit</span> <a class="link" href="old_value_copy.html#idm45394998977872-bb"><span class="identifier">old_value_copy</span></a><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  38
  39   <span class="comment">// <a class="link" href="old_value_copy.html#idm45394998981760-bb">public member functions</a></span>
  40   <span class="identifier">T</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a class="link" href="old_value_copy.html#idm45394998981200-bb"><span class="identifier">old</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  41 <span class="special">}</span><span class="special">;</span></pre></div>
  42 <div class="refsect1">
  43 <a name="idm45707994289216"></a><h2>Description</h2>
  44 <p>By default, the implementation of this trait uses <code class="computeroutput">T's</code> copy constructor to make one single copy of the specified value. However, programmers can specialize this trait to copy old values using user-specific operations different from <code class="computeroutput">T's</code> copy constructor. The default implementation of this trait is equivalent to:</p>
  45 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span>
  46 <span class="keyword">class</span> <span class="identifier">old_value_copy</span> <span class="special">{</span>
  47 <span class="keyword">public</span><span class="special">:</span>
  48     <span class="keyword">explicit</span> <span class="identifier">old_value_copy</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">old</span><span class="special">)</span> <span class="special">:</span>
  49         <span class="identifier">old_</span><span class="special">(</span><span class="identifier">old</span><span class="special">)</span> <span class="comment">// One single copy of value using T's copy constructor.</span>
  50     <span class="special">{</span><span class="special">}</span>
  51
  52     <span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">old</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">old_</span><span class="special">;</span> <span class="special">}</span>
  53
  54 <span class="keyword">private</span><span class="special">:</span>
  55     <span class="identifier">T</span> <span class="keyword">const</span> <span class="identifier">old_</span><span class="special">;</span> <span class="comment">// The old value copy.</span>
  56 <span class="special">}</span><span class="special">;</span>
  57 </pre>
  58 <p>This library will instantiate and use this trait only on old value types <code class="computeroutput">T</code> that are copyable (i.e., for which <code class="computeroutput">boost::contract::is_old_value_copyable&lt;T&gt;::value</code> is <code class="computeroutput">true</code>).</p>
  59 <p><span class="bold"><strong>See Also:</strong></span></p>
  60 <p> <a class="link" href="../../boost_contract/extras.html#boost_contract.extras.old_value_requirements__templates_" title="Old Value Requirements (Templates)">
  61         Old Value Requirements</a> </p>
  62 <p>
  63 </p>
  64 <p>
  65 </p>
  66 <div class="refsect2">
  67 <a name="idm45707994252416"></a><h3>
  68 <a name="boost.contract.old_value_copyconstruct-copy-destruct"></a><code class="computeroutput">old_value_copy</code>
  69         public
  70        construct/copy/destruct</h3>
  71 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  72 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45394998977872-bb"></a><span class="identifier">old_value_copy</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&amp;</span> old<span class="special">)</span><span class="special">;</span></pre>Construct this object by making one single copy of the specified old value. <p>This is the only operation within this library that actually copies old values. This ensures this library makes one and only one copy of an old value (if they actually need to be copied, see <code class="computeroutput"><code class="computeroutput"><a class="link" href="../../BOOST_CONTRACT_NO_OLDS.html" title="Macro BOOST_CONTRACT_NO_OLDS">BOOST_CONTRACT_NO_OLDS</a></code></code>).</p>
  73 <p>
  74 </p>
  75 <div class="variablelist"><table border="0" class="variablelist compact">
  76 <colgroup>
  77 <col align="left" valign="top">
  78 <col>
  79 </colgroup>
  80 <tbody><tr>
  81 <td><p><span class="term">Parameters:</span></p></td>
  82 <td><div class="variablelist"><table border="0" class="variablelist compact">
  83 <colgroup>
  84 <col align="left" valign="top">
  85 <col>
  86 </colgroup>
  87 <tbody><tr>
  88 <td><p><span class="term"><code class="computeroutput">old</code></span></p></td>
  89 <td><p>The old value to copy. </p></td>
  90 </tr></tbody>
  91 </table></div></td>
  92 </tr></tbody>
  93 </table></div>
  94 </li></ol></div>
  95 </div>
  96 <div class="refsect2">
  97 <a name="idm45707994238272"></a><h3>
  98 <a name="idm45394998981760-bb"></a><code class="computeroutput">old_value_copy</code> public member functions</h3>
  99 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 100 <pre class="literallayout"><span class="identifier">T</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a name="idm45394998981200-bb"></a><span class="identifier">old</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Return a (constant) reference to the old value that was copied. <p>Contract assertions should not change the state of the program so the old value copy is returned as <code class="computeroutput">const</code> (see  <a class="link" href="../../boost_contract/contract_programming_overview.html#boost_contract.contract_programming_overview.constant_correctness" title="Constant-Correctness">
 101 Constant Correctness</a>). </p>
 102 </li></ol></div>
 103 </div>
 104 </div>
 105 </div>
 106 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 107 <td align="left"></td>
 108 <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
 109         Distributed under the Boost Software License, Version 1.0 (see accompanying
 110         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>)
 111       </p>
 112 </div></td>
 113 </tr></table>
 114 <hr>
 115 <div class="spirit-nav">
 116 <a accesskey="p" href="old_value.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.old_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="null_old.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 117 </div>
 118 </body>
 119 </html>