libs/contract/doc/html/boost/contract/bad_virtual_result_cast.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class bad_virtual_result_cast</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.core.exception_hpp" title="Header &lt;boost/contract/core/exception.hpp&gt;">
   9 <link rel="prev" href="assertion_failure.html" title="Class assertion_failure">
  10 <link rel="next" href="exception.html" title="Class exception">
  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="assertion_failure.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.core.exception_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="exception.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.contract.bad_virtual_result_cast"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class bad_virtual_result_cast</span></h2>
  29 <p>boost::contract::bad_virtual_result_cast &#8212; Exception thrown when inconsistent return values are passed to overridden virtual public functions. </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.core.exception_hpp" title="Header &lt;boost/contract/core/exception.hpp&gt;">boost/contract/core/exception.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">class</span> <a class="link" href="bad_virtual_result_cast.html" title="Class bad_virtual_result_cast">bad_virtual_result_cast</a> <span class="special">:</span>
  36   <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">bad_cast</span>, <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">contract</span><span class="special">::</span><span class="identifier">exception</span>
  37 <span class="special">{</span>
  38 <span class="keyword">public</span><span class="special">:</span>
  39   <span class="comment">// <a class="link" href="bad_virtual_result_cast.html#boost.contract.bad_virtual_result_castconstruct-copy-destruct">construct/copy/destruct</a></span>
  40   <span class="keyword">explicit</span> <a class="link" href="bad_virtual_result_cast.html#idm45394999479088-bb"><span class="identifier">bad_virtual_result_cast</span></a><span class="special">(</span><span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  41   <a class="link" href="bad_virtual_result_cast.html#idm45394999475504-bb"><span class="special">~</span><span class="identifier">bad_virtual_result_cast</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="bad_virtual_result_cast.html#idm45394999483408-bb">public member functions</a></span>
  44   <span class="keyword">virtual</span> <span class="keyword">char</span> <span class="keyword">const</span>  <span class="special">*</span> <a class="link" href="bad_virtual_result_cast.html#idm45394999482848-bb"><span class="identifier">what</span></a><span class="special">(</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="idm45707996119728"></a><h2>Description</h2>
  48 <p>This exception is thrown when programmers pass to this library return value parameters for public function overrides in derived classes that are not consistent with the return type parameter passed for the virtual public function being overridden from the base classes. This allows this library to give more descriptive error messages in such cases of misuse.</p>
  49 <p>This exception is internally thrown by this library and programmers should not need to throw it from user code.</p>
  50 <p><span class="bold"><strong>See Also:</strong></span></p>
  51 <p> <a class="link" href="../../boost_contract/tutorial.html#boost_contract.tutorial.public_function_overrides__subcontracting_" title="Public Function Overrides (Subcontracting)">
  52         Public Function Overrides</a> </p>
  53 <p>
  54 </p>
  55 <p>
  56 </p>
  57 <div class="refsect2">
  58 <a name="idm45707996116064"></a><h3>
  59 <a name="boost.contract.bad_virtual_result_castconstruct-copy-destruct"></a><code class="computeroutput">bad_virtual_result_cast</code>
  60         public
  61        construct/copy/destruct</h3>
  62 <div class="orderedlist"><ol class="orderedlist" type="1">
  63 <li class="listitem">
  64 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45394999479088-bb"></a><span class="identifier">bad_virtual_result_cast</span><span class="special">(</span><span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span> from_type_name<span class="special">,</span>
  65                                  <span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span> to_type_name<span class="special">)</span><span class="special">;</span></pre>Construct this object with the name of the from- and to- result types. <p>
  66 </p>
  67 <div class="variablelist"><table border="0" class="variablelist compact">
  68 <colgroup>
  69 <col align="left" valign="top">
  70 <col>
  71 </colgroup>
  72 <tbody><tr>
  73 <td><p><span class="term">Parameters:</span></p></td>
  74 <td><div class="variablelist"><table border="0" class="variablelist compact">
  75 <colgroup>
  76 <col align="left" valign="top">
  77 <col>
  78 </colgroup>
  79 <tbody>
  80 <tr>
  81 <td><p><span class="term"><code class="computeroutput">from_type_name</code></span></p></td>
  82 <td><p>Name of the from-type (source of the cast). </p></td>
  83 </tr>
  84 <tr>
  85 <td><p><span class="term"><code class="computeroutput">to_type_name</code></span></p></td>
  86 <td><p>Name of the to-type (destination of the cast). </p></td>
  87 </tr>
  88 </tbody>
  89 </table></div></td>
  90 </tr></tbody>
  91 </table></div>
  92 </li>
  93 <li class="listitem">
  94 <pre class="literallayout"><a name="idm45394999475504-bb"></a><span class="special">~</span><span class="identifier">bad_virtual_result_cast</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destruct this object. <p><span class="bold"><strong>Throws:</strong></span> This is declared <code class="computeroutput">noexcept</code> (or <code class="computeroutput">throw()</code> before C++11). </p>
  95 </li>
  96 </ol></div>
  97 </div>
  98 <div class="refsect2">
  99 <a name="idm45707996093488"></a><h3>
 100 <a name="idm45394999483408-bb"></a><code class="computeroutput">bad_virtual_result_cast</code> public member functions</h3>
 101 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 102 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">char</span> <span class="keyword">const</span>  <span class="special">*</span> <a name="idm45394999482848-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Description for this error (containing both from- and to- type names). <p><span class="bold"><strong>Throws:</strong></span> This is declared <code class="computeroutput">noexcept</code> (or <code class="computeroutput">throw()</code> before C++11). </p>
 103 </li></ol></div>
 104 </div>
 105 </div>
 106 </div>
 107 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 108 <td align="left"></td>
 109 <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
 110         Distributed under the Boost Software License, Version 1.0 (see accompanying
 111         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>)
 112       </p>
 113 </div></td>
 114 </tr></table>
 115 <hr>
 116 <div class="spirit-nav">
 117 <a accesskey="p" href="assertion_failure.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.core.exception_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="exception.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 118 </div>
 119 </body>
 120 </html>