libs/contract/doc/html/boost/contract/call_if__idm45123870853712.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct template call_if_statement&lt;true, Then, void&gt;</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.call_if_hpp" title="Header &lt;boost/contract/call_if.hpp&gt;">
   9 <link rel="prev" href="call_if__idm45123870893360.html" title="Struct template call_if_statement&lt;true, Then, ThenResult&gt;">
  10 <link rel="next" href="call_if_c.html" title="Function template call_if_c">
  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="call_if__idm45123870893360.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.call_if_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="call_if_c.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.contract.call_if__idm45123870853712"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Struct template call_if_statement&lt;true, Then, void&gt;</span></h2>
  29 <p>boost::contract::call_if_statement&lt;true, Then, void&gt; &#8212; Template specialization to handle static predicates that are <code class="computeroutput">true</code> for then-branch functor template calls that return void. </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.call_if_hpp" title="Header &lt;boost/contract/call_if.hpp&gt;">boost/contract/call_if.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Then<span class="special">&gt;</span>
  35 <span class="keyword">struct</span> <a class="link" href="call_if__idm45123870853712.html" title="Struct template call_if_statement&lt;true, Then, void&gt;">call_if_statement</a><span class="special">&lt;</span><span class="keyword">true</span><span class="special">,</span> <span class="identifier">Then</span><span class="special">,</span> <span class="keyword">void</span><span class="special">&gt;</span> <span class="special">{</span>
  36   <span class="comment">// <a class="link" href="call_if__idm45123870853712.html#boost.contract.call_if__idm45123870853712construct-copy-destruct">construct/copy/destruct</a></span>
  37   <span class="keyword">explicit</span> <a class="link" href="call_if__idm45123870853712.html#idm45123870822624-bb"><span class="identifier">call_if_statement</span></a><span class="special">(</span><span class="identifier">Then</span><span class="special">)</span><span class="special">;</span>
  38
  39   <span class="comment">// <a class="link" href="call_if__idm45123870853712.html#idm45123870845408-bb">public member functions</a></span>
  40   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Else<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="call_if__idm45123870853712.html#idm45123870844848-bb"><span class="identifier">else_</span></a><span class="special">(</span><span class="identifier">Else</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  41   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">bool</span> ElseIfPred<span class="special">,</span> <span class="keyword">typename</span> ElseIfThen<span class="special">&gt;</span>
  42     <a class="link" href="call_if_statement.html" title="Struct template call_if_statement">call_if_statement</a><span class="special">&lt;</span> <span class="keyword">true</span><span class="special">,</span> <span class="identifier">Then</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">&gt;</span> <a class="link" href="call_if__idm45123870853712.html#idm45123870839024-bb"><span class="identifier">else_if_c</span></a><span class="special">(</span><span class="identifier">ElseIfThen</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  43   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ElseIfPred<span class="special">,</span> <span class="keyword">typename</span> ElseIfThen<span class="special">&gt;</span>
  44     <a class="link" href="call_if_statement.html" title="Struct template call_if_statement">call_if_statement</a><span class="special">&lt;</span> <span class="keyword">true</span><span class="special">,</span> <span class="identifier">Then</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">&gt;</span> <a class="link" href="call_if__idm45123870853712.html#idm45123870830768-bb"><span class="identifier">else_if</span></a><span class="special">(</span><span class="identifier">ElseIfThen</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  45 <span class="special">}</span><span class="special">;</span></pre></div>
  46 <div class="refsect1">
  47 <a name="idm45751731250896"></a><h2>Description</h2>
  48 <p>Usually this class template is instantiated only via the return value of  <code class="computeroutput"><a class="link" href="call_if.html" title="Function template call_if">boost::contract::call_if</a></code> and <code class="computeroutput"><a class="link" href="call_if_c.html" title="Function template call_if_c">boost::contract::call_if_c</a></code>.</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.assertion_requirements__templates_" title="Assertion Requirements (Templates)">
  51         Assertion Requirements</a></p>
  52 <p>
  53 </p>
  54 <p>
  55
  56 </p>
  57 <div class="refsect2">
  58 <a name="idm45751731245440"></a><h3>Template Parameters</h3>
  59 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  60 <pre class="literallayout"><span class="keyword">typename</span> Then</pre>
  61 <p>Type of functor template to call when the static predicate if <code class="computeroutput">true</code> (as it is for this template specialization). </p>
  62 </li></ol></div>
  63 </div>
  64 <div class="refsect2">
  65 <a name="idm45751731241568"></a><h3>
  66 <a name="boost.contract.call_if__idm45123870853712construct-copy-destruct"></a><code class="computeroutput">call_if_statement</code>
  67         public
  68        construct/copy/destruct</h3>
  69 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  70 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45123870822624-bb"></a><span class="identifier">call_if_statement</span><span class="special">(</span><span class="identifier">Then</span> f<span class="special">)</span><span class="special">;</span></pre>Construct this object with the then-branch functor template. <p>
  71 </p>
  72 <div class="variablelist"><table border="0" class="variablelist compact">
  73 <colgroup>
  74 <col align="left" valign="top">
  75 <col>
  76 </colgroup>
  77 <tbody><tr>
  78 <td><p><span class="term">Parameters:</span></p></td>
  79 <td><div class="variablelist"><table border="0" class="variablelist compact">
  80 <colgroup>
  81 <col align="left" valign="top">
  82 <col>
  83 </colgroup>
  84 <tbody><tr>
  85 <td><p><span class="term"><code class="computeroutput">f</code></span></p></td>
  86 <td><p>Then-branch nullary functor template. The functor template call <code class="computeroutput">f()</code> is actually compiled and executed for this template specialization (because the if-statement static predicate is <code class="computeroutput">true</code>). The return type of <code class="computeroutput">f()</code> must be <code class="computeroutput">void</code> for this template specialization (because the then-branch functor template calls return void). </p></td>
  87 </tr></tbody>
  88 </table></div></td>
  89 </tr></tbody>
  90 </table></div>
  91 </li></ol></div>
  92 </div>
  93 <div class="refsect2">
  94 <a name="idm45751731227808"></a><h3>
  95 <a name="idm45123870845408-bb"></a><code class="computeroutput">call_if_statement</code> public member functions</h3>
  96 <div class="orderedlist"><ol class="orderedlist" type="1">
  97 <li class="listitem">
  98 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Else<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45123870844848-bb"></a><span class="identifier">else_</span><span class="special">(</span><span class="identifier">Else</span> <span class="keyword">const</span> <span class="special">&amp;</span> f<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Specify the else-branch functor template. <p>
  99 </p>
 100 <div class="variablelist"><table border="0" class="variablelist compact">
 101 <colgroup>
 102 <col align="left" valign="top">
 103 <col>
 104 </colgroup>
 105 <tbody><tr>
 106 <td><p><span class="term">Parameters:</span></p></td>
 107 <td><div class="variablelist"><table border="0" class="variablelist compact">
 108 <colgroup>
 109 <col align="left" valign="top">
 110 <col>
 111 </colgroup>
 112 <tbody><tr>
 113 <td><p><span class="term"><code class="computeroutput">f</code></span></p></td>
 114 <td><p>Else-branch nullary functor template. The functor template call <code class="computeroutput">f()</code> is never compiled and executed for this template specialization (because the if-statement static predicate is <code class="computeroutput">true</code>). The return type of <code class="computeroutput">f()</code> must be <code class="computeroutput">void</code> for this template specialization (because the then-branch functor template calls return void). </p></td>
 115 </tr></tbody>
 116 </table></div></td>
 117 </tr></tbody>
 118 </table></div>
 119 </li>
 120 <li class="listitem">
 121 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">bool</span> ElseIfPred<span class="special">,</span> <span class="keyword">typename</span> ElseIfThen<span class="special">&gt;</span>
 122   <a class="link" href="call_if_statement.html" title="Struct template call_if_statement">call_if_statement</a><span class="special">&lt;</span> <span class="keyword">true</span><span class="special">,</span> <span class="identifier">Then</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">&gt;</span> <a name="idm45123870839024-bb"></a><span class="identifier">else_if_c</span><span class="special">(</span><span class="identifier">ElseIfThen</span> <span class="keyword">const</span> <span class="special">&amp;</span> f<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Specify an else-if-branch functor template (using a static boolean predicate). <p>
 123
 124
 125 </p>
 126 <div class="variablelist"><table border="0" class="variablelist compact">
 127 <colgroup>
 128 <col align="left" valign="top">
 129 <col>
 130 </colgroup>
 131 <tbody>
 132 <tr>
 133 <td><p><span class="term">Parameters:</span></p></td>
 134 <td><div class="variablelist"><table border="0" class="variablelist compact">
 135 <colgroup>
 136 <col align="left" valign="top">
 137 <col>
 138 </colgroup>
 139 <tbody><tr>
 140 <td><p><span class="term"><code class="computeroutput">f</code></span></p></td>
 141 <td><p>Else-if-branch nullary functor template. The functor template call <code class="computeroutput">f()</code> is never compiled and executed for this template specialization (because the if-statement static predicate is <code class="computeroutput">true</code>). The return type of <code class="computeroutput">f()</code> must be <code class="computeroutput">void</code> for this template specialization (because the then-branch functor template calls return void).</p></td>
 142 </tr></tbody>
 143 </table></div></td>
 144 </tr>
 145 <tr>
 146 <td><p><span class="term">Template Parameters:</span></p></td>
 147 <td><div class="variablelist"><table border="0" class="variablelist compact">
 148 <colgroup>
 149 <col align="left" valign="top">
 150 <col>
 151 </colgroup>
 152 <tbody><tr>
 153 <td><p><span class="term"><code class="computeroutput">ElseIfPred</code></span></p></td>
 154 <td><p>Static boolean predicate selecting which functor template call to compile and execute.</p></td>
 155 </tr></tbody>
 156 </table></div></td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term">Returns:</span></p></td>
 160 <td><p>A call-if statement so the else statement and additional else-if statements can be specified if needed. Eventually, it will return void for this template specialization (because the then-branch functor template calls return void). </p></td>
 161 </tr>
 162 </tbody>
 163 </table></div>
 164 </li>
 165 <li class="listitem">
 166 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ElseIfPred<span class="special">,</span> <span class="keyword">typename</span> ElseIfThen<span class="special">&gt;</span>
 167   <a class="link" href="call_if_statement.html" title="Struct template call_if_statement">call_if_statement</a><span class="special">&lt;</span> <span class="keyword">true</span><span class="special">,</span> <span class="identifier">Then</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">&gt;</span> <a name="idm45123870830768-bb"></a><span class="identifier">else_if</span><span class="special">(</span><span class="identifier">ElseIfThen</span> <span class="keyword">const</span> <span class="special">&amp;</span> f<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Specify an else-if-branch functor template (using a nullary boolean meta-function). <p>
 168
 169
 170 </p>
 171 <div class="variablelist"><table border="0" class="variablelist compact">
 172 <colgroup>
 173 <col align="left" valign="top">
 174 <col>
 175 </colgroup>
 176 <tbody>
 177 <tr>
 178 <td><p><span class="term">Parameters:</span></p></td>
 179 <td><div class="variablelist"><table border="0" class="variablelist compact">
 180 <colgroup>
 181 <col align="left" valign="top">
 182 <col>
 183 </colgroup>
 184 <tbody><tr>
 185 <td><p><span class="term"><code class="computeroutput">f</code></span></p></td>
 186 <td><p>Else-if-branch nullary functor template. The functor template call <code class="computeroutput">f()</code> is never compiled and executed for this template specialization (because the if-statement static predicate is <code class="computeroutput">true</code>). The return type of <code class="computeroutput">f()</code> must be <code class="computeroutput">void</code> for this template specialization (because the then-branch functor template calls return void).</p></td>
 187 </tr></tbody>
 188 </table></div></td>
 189 </tr>
 190 <tr>
 191 <td><p><span class="term">Template Parameters:</span></p></td>
 192 <td><div class="variablelist"><table border="0" class="variablelist compact">
 193 <colgroup>
 194 <col align="left" valign="top">
 195 <col>
 196 </colgroup>
 197 <tbody><tr>
 198 <td><p><span class="term"><code class="computeroutput">ElseIfPred</code></span></p></td>
 199 <td><p>Nullary boolean meta-function selecting which functor template call to compile and execute.</p></td>
 200 </tr></tbody>
 201 </table></div></td>
 202 </tr>
 203 <tr>
 204 <td><p><span class="term">Returns:</span></p></td>
 205 <td><p>A call-if statement so the else statement and additional else-if statements can be specified if needed. Eventually, it will return void for this template specialization (because the then-branch functor template calls return void). </p></td>
 206 </tr>
 207 </tbody>
 208 </table></div>
 209 </li>
 210 </ol></div>
 211 </div>
 212 </div>
 213 </div>
 214 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 215 <td align="left"></td>
 216 <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2018 Lorenzo Caminiti<p>
 217         Distributed under the Boost Software License, Version 1.0 (see accompanying
 218         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>)
 219       </p>
 220 </div></td>
 221 </tr></table>
 222 <hr>
 223 <div class="spirit-nav">
 224 <a accesskey="p" href="call_if__idm45123870893360.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.call_if_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="call_if_c.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 225 </div>
 226 </body>
 227 </html>