assertion_result.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Class assertion_result</title>
  5. <link rel="stylesheet" href="../../boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
  7. <link rel="home" href="../../index.html" title="Boost.Test">
  8. <link rel="up" href="../../header/boost/test/tools/assertion_result_hpp.html" title="Header &lt;boost/test/tools/assertion_result.hpp&gt;">
  9. <link rel="prev" href="../../header/boost/test/tools/assertion_result_hpp.html" title="Header &lt;boost/test/tools/assertion_result.hpp&gt;">
  10. <link rel="next" href="assertion_result/dummy.html" title="Struct dummy">
  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="../../header/boost/test/tools/assertion_result_hpp.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/test/tools/assertion_result_hpp.html"><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="assertion_result/dummy.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="refentry">
  26. <a name="boost.test_tools.assertion_result"></a><div class="titlepage"></div>
  27. <div class="refnamediv">
  28. <h2><span class="refentrytitle">Class assertion_result</span></h2>
  29. <p>boost::test_tools::assertion_result &#8212; Type used for storing the result of an assertion. </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="../../header/boost/test/tools/assertion_result_hpp.html" title="Header &lt;boost/test/tools/assertion_result.hpp&gt;">boost/test/tools/assertion_result.hpp</a>&gt;
  33. </span>
  34. <span class="keyword">class</span> <a class="link" href="assertion_result.html" title="Class assertion_result">assertion_result</a> <span class="special">{</span>
  35. <span class="keyword">public</span><span class="special">:</span>
  36. <span class="comment">// member classes/structs/unions</span>
  37. <span class="keyword">struct</span> <a class="link" href="assertion_result/dummy.html" title="Struct dummy">dummy</a> <span class="special">{</span>
  38. <span class="comment">// <a class="link" href="assertion_result/dummy.html#idm46279113210080-bb">public member functions</a></span>
  39. <span class="keyword">void</span> <a class="link" href="assertion_result/dummy.html#idm46279113209520-bb"><span class="identifier">nonnull</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  40. <span class="special">}</span><span class="special">;</span>
  41. <span class="comment">// <a class="link" href="assertion_result.html#boost.test_tools.assertion_resultconstruct-copy-destruct">construct/copy/destruct</a></span>
  42. <a class="link" href="assertion_result.html#idm46279113199952-bb"><span class="identifier">assertion_result</span></a><span class="special">(</span><span class="keyword">bool</span><span class="special">)</span><span class="special">;</span>
  43. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BoolConvertable<span class="special">&gt;</span> <a class="link" href="assertion_result.html#idm46279113198976-bb"><span class="identifier">assertion_result</span></a><span class="special">(</span><span class="identifier">BoolConvertable</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  44. <span class="keyword">void</span> <a class="link" href="assertion_result.html#idm46279113197152-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">bool</span><span class="special">)</span><span class="special">;</span>
  45. <span class="comment">// <a class="link" href="assertion_result.html#idm46279113208512-bb">public member functions</a></span>
  46. <span class="keyword">bool</span> <a class="link" href="assertion_result.html#idm46279113207952-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  47. <a class="link" href="assertion_result.html#idm46279113206832-bb"><span class="keyword">operator</span> <span class="identifier">safe_bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  48. <a class="link" href="assertion_result.html#idm46279113205712-bb"><span class="identifier">BOOST_READONLY_PROPERTY</span></a><span class="special">(</span><span class="keyword">bool</span><span class="special">,</span> <span class="special">(</span><a class="link" href="assertion_result.html" title="Class assertion_result">assertion_result</a><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  49. <span class="keyword">bool</span> <a class="link" href="assertion_result.html#idm46279113203200-bb"><span class="identifier">has_empty_message</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  50. <span class="identifier">wrap_stringstream</span> <span class="special">&amp;</span> <a class="link" href="assertion_result.html#idm46279113202080-bb"><span class="identifier">message</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  51. <span class="identifier">const_string</span> <a class="link" href="assertion_result.html#idm46279113201232-bb"><span class="identifier">message</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  52. <span class="special">}</span><span class="special">;</span></pre></div>
  53. <div class="refsect1">
  54. <a name="idm45313887292640"></a><h2>Description</h2>
  55. <div class="refsect2">
  56. <a name="idm45313887292224"></a><h3>
  57. <a name="boost.test_tools.assertion_resultconstruct-copy-destruct"></a><code class="computeroutput">assertion_result</code>
  58. public
  59. construct/copy/destruct</h3>
  60. <div class="orderedlist"><ol class="orderedlist" type="1">
  61. <li class="listitem"><pre class="literallayout"><a name="idm46279113199952-bb"></a><span class="identifier">assertion_result</span><span class="special">(</span><span class="keyword">bool</span> pv_<span class="special">)</span><span class="special">;</span></pre></li>
  62. <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BoolConvertable<span class="special">&gt;</span>
  63. <a name="idm46279113198976-bb"></a><span class="identifier">assertion_result</span><span class="special">(</span><span class="identifier">BoolConvertable</span> <span class="keyword">const</span> <span class="special">&amp;</span> pv_<span class="special">)</span><span class="special">;</span></pre></li>
  64. <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46279113197152-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">bool</span> pv_<span class="special">)</span><span class="special">;</span></pre></li>
  65. </ol></div>
  66. </div>
  67. <div class="refsect2">
  68. <a name="idm45313887272000"></a><h3>
  69. <a name="idm46279113208512-bb"></a><code class="computeroutput">assertion_result</code> public member functions</h3>
  70. <div class="orderedlist"><ol class="orderedlist" type="1">
  71. <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm46279113207952-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  72. <li class="listitem"><pre class="literallayout"><a name="idm46279113206832-bb"></a><span class="keyword">operator</span> <span class="identifier">safe_bool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  73. <li class="listitem"><pre class="literallayout"> <a name="idm46279113205712-bb"></a><span class="identifier">BOOST_READONLY_PROPERTY</span><span class="special">(</span><span class="keyword">bool</span><span class="special">,</span> <span class="special">(</span><a class="link" href="assertion_result.html" title="Class assertion_result">assertion_result</a><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li>
  74. <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm46279113203200-bb"></a><span class="identifier">has_empty_message</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  75. <li class="listitem"><pre class="literallayout"><span class="identifier">wrap_stringstream</span> <span class="special">&amp;</span> <a name="idm46279113202080-bb"></a><span class="identifier">message</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  76. <li class="listitem"><pre class="literallayout"><span class="identifier">const_string</span> <a name="idm46279113201232-bb"></a><span class="identifier">message</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  77. </ol></div>
  78. </div>
  79. </div>
  80. </div>
  81. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  82. <td align="left"></td>
  83. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  84. contributors<p>
  85. Distributed under the Boost Software License, Version 1.0. (See accompanying
  86. file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  87. </p>
  88. </div></td>
  89. </tr></table>
  90. <hr>
  91. <div class="spirit-nav">
  92. <a accesskey="p" href="../../header/boost/test/tools/assertion_result_hpp.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/test/tools/assertion_result_hpp.html"><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="assertion_result/dummy.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  93. </div>
  94. </body>
  95. </html>