libs/contract/doc/html/boost/contract/old_value.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class old_value</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_ptr_if_copyable.html" title="Class template old_ptr_if_copyable">
  10 <link rel="next" href="old_value_copy.html" title="Struct template old_value_copy">
  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_ptr_if_copyable.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="old_value_copy.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.contract.old_value"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class old_value</span></h2>
  29 <p>boost::contract::old_value &#8212; Convert user-specified expressions to old values. </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>
  35 <span class="keyword">class</span> <a class="link" href="old_value.html" title="Class old_value">old_value</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="old_value.html#boost.contract.old_valueconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  39     <a class="link" href="old_value.html#idm45394999003184-bb"><span class="identifier">old_value</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>
  40               <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if</span><span class="special">&lt;</span> <a class="link" href="is_old_value_copyable.html" title="Struct template is_old_value_copyable">boost::contract::is_old_value_copyable</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</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> T<span class="special">&gt;</span>
  42     <a class="link" href="old_value.html#idm45394998995648-bb"><span class="identifier">old_value</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>
  43               <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">disable_if</span><span class="special">&lt;</span> <a class="link" href="is_old_value_copyable.html" title="Struct template is_old_value_copyable">boost::contract::is_old_value_copyable</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
  44 <span class="special">}</span><span class="special">;</span></pre></div>
  45 <div class="refsect1">
  46 <a name="idm45707994373936"></a><h2>Description</h2>
  47 <p>This class is usually only implicitly used by this library and it does not explicitly appear in user code.</p>
  48 <p>On older compilers that cannot correctly deduce the <code class="computeroutput"><a class="link" href="is_old_value_copyable.html" title="Struct template is_old_value_copyable">boost::contract::is_old_value_copyable</a></code> trait used in the declaration of this class, programmers can manually specialize that trait to make sure that only old value types that are copyable are actually copied.</p>
  49 <p><span class="bold"><strong>See Also:</strong></span></p>
  50 <p> <a class="link" href="../../boost_contract/extras.html#boost_contract.extras.old_value_requirements__templates_" title="Old Value Requirements (Templates)">
  51         Old Value Requirements</a> </p>
  52 <p>
  53 </p>
  54 <p>
  55 </p>
  56 <div class="refsect2">
  57 <a name="idm45707994369056"></a><h3>
  58 <a name="boost.contract.old_valueconstruct-copy-destruct"></a><code class="computeroutput">old_value</code>
  59         public
  60        construct/copy/destruct</h3>
  61 <div class="orderedlist"><ol class="orderedlist" type="1">
  62 <li class="listitem">
  63 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  64   <a name="idm45394999003184-bb"></a><span class="identifier">old_value</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>
  65             <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">enable_if</span><span class="special">&lt;</span> <a class="link" href="is_old_value_copyable.html" title="Struct template is_old_value_copyable">boost::contract::is_old_value_copyable</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre>Construct this object from the specified old value when the old value type is copy constructible. <p>The specified old value <code class="computeroutput">old</code> is copied (one time only) using <code class="computeroutput"><code class="computeroutput"><a class="link" href="old_value_copy.html" title="Struct template old_value_copy">boost::contract::old_value_copy</a></code></code>, in which case the related old value pointer will not be null (but no copy is made if postconditions and exception guarantees are not being checked, 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>
  66 <p>
  67
  68 </p>
  69 <div class="variablelist"><table border="0" class="variablelist compact">
  70 <colgroup>
  71 <col align="left" valign="top">
  72 <col>
  73 </colgroup>
  74 <tbody>
  75 <tr>
  76 <td><p><span class="term">Parameters:</span></p></td>
  77 <td><div class="variablelist"><table border="0" class="variablelist compact">
  78 <colgroup>
  79 <col align="left" valign="top">
  80 <col>
  81 </colgroup>
  82 <tbody><tr>
  83 <td><p><span class="term"><code class="computeroutput">old</code></span></p></td>
  84 <td><p>Old value to be copied.</p></td>
  85 </tr></tbody>
  86 </table></div></td>
  87 </tr>
  88 <tr>
  89 <td><p><span class="term">Template Parameters:</span></p></td>
  90 <td><div class="variablelist"><table border="0" class="variablelist compact">
  91 <colgroup>
  92 <col align="left" valign="top">
  93 <col>
  94 </colgroup>
  95 <tbody><tr>
  96 <td><p><span class="term"><code class="computeroutput">T</code></span></p></td>
  97 <td><p>Old value type. </p></td>
  98 </tr></tbody>
  99 </table></div></td>
 100 </tr>
 101 </tbody>
 102 </table></div>
 103 </li>
 104 <li class="listitem">
 105 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
 106   <a name="idm45394998995648-bb"></a><span class="identifier">old_value</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>
 107             <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">disable_if</span><span class="special">&lt;</span> <a class="link" href="is_old_value_copyable.html" title="Struct template is_old_value_copyable">boost::contract::is_old_value_copyable</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre>Construct this object from the specified old value when the old value type is not copyable. <p>The specified old value <code class="computeroutput">old</code> cannot be copied in this case so it is not copied and the related old value pointer will always be null (thus calls to this constructor have no effect and they will likely be optimized away by most compilers).</p>
 108 <p>
 109
 110 </p>
 111 <div class="variablelist"><table border="0" class="variablelist compact">
 112 <colgroup>
 113 <col align="left" valign="top">
 114 <col>
 115 </colgroup>
 116 <tbody>
 117 <tr>
 118 <td><p><span class="term">Parameters:</span></p></td>
 119 <td><div class="variablelist"><table border="0" class="variablelist compact">
 120 <colgroup>
 121 <col align="left" valign="top">
 122 <col>
 123 </colgroup>
 124 <tbody><tr>
 125 <td><p><span class="term"><code class="computeroutput">old</code></span></p></td>
 126 <td><p>Old value (that will not be copied in this case).</p></td>
 127 </tr></tbody>
 128 </table></div></td>
 129 </tr>
 130 <tr>
 131 <td><p><span class="term">Template Parameters:</span></p></td>
 132 <td><div class="variablelist"><table border="0" class="variablelist compact">
 133 <colgroup>
 134 <col align="left" valign="top">
 135 <col>
 136 </colgroup>
 137 <tbody><tr>
 138 <td><p><span class="term"><code class="computeroutput">T</code></span></p></td>
 139 <td><p>Old value type. </p></td>
 140 </tr></tbody>
 141 </table></div></td>
 142 </tr>
 143 </tbody>
 144 </table></div>
 145 </li>
 146 </ol></div>
 147 </div>
 148 </div>
 149 </div>
 150 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 151 <td align="left"></td>
 152 <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
 153         Distributed under the Boost Software License, Version 1.0 (see accompanying
 154         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>)
 155       </p>
 156 </div></td>
 157 </tr></table>
 158 <hr>
 159 <div class="spirit-nav">
 160 <a accesskey="p" href="old_ptr_if_copyable.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="old_value_copy.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 161 </div>
 162 </body>
 163 </html>