Home Explore Help
Register Sign In
devn00b
/
EQ2EMu
9
3
Fork 0
Files Issues 59 Pull Requests 0 Wiki
Tree: 37313e0645
Branches Tags
EQ2EMu
/
EQ2
/
source
/
depends
/
boost_1_72_0
/
libs
/
test
/
doc
/
html
/
boost
/
unit_test
/
progress_monitor_t.html

progress_monitor_t.html 12 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104 
  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>Class progress_monitor_t</title>
    5. 

  5. <link rel="stylesheet" href="../../boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
    7. 

  7. <link rel="home" href="../../index.html" title="Boost.Test">
    8. 

  8. <link rel="up" href="../../header/boost/test/progress_monitor_hpp.html" title="Header &lt;boost/test/progress_monitor.hpp&gt;">
    9. 

  9. <link rel="prev" href="../../header/boost/test/progress_monitor_hpp.html" title="Header &lt;boost/test/progress_monitor.hpp&gt;">
    10. 

  10. <link rel="next" href="../../header/boost/test/results_collector_hpp.html" title="Header &lt;boost/test/results_collector.hpp&gt;">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr>
    14. 

  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
    15. 

  15. <td align="center"><a href="../../../../../../index.html">Home</a></td>
    16. 

  16. <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
    17. 

  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
    18. 

  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
    19. 

  19. <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
    20. 

  20. </tr></table>
    21. 

  21. <hr>
    22. 

  22. <div class="spirit-nav">
    23. 

  23. <a accesskey="p" href="../../header/boost/test/progress_monitor_hpp.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/test/progress_monitor_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="../../header/boost/test/results_collector_hpp.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
    24. 

  24. </div>
    25. 

  25. <div class="refentry">
    26. 

  26. <a name="boost.unit_test.progress_monitor_t"></a><div class="titlepage"></div>
    27. 

  27. <div class="refnamediv">
    28. 

  28. <h2><span class="refentrytitle">Class progress_monitor_t</span></h2>
    29. 

  29. <p>boost::unit_test::progress_monitor_t &#8212; This class implements test observer interface and updates test progress as test units finish or get aborted. </p>
    30. 

  30. </div>
    31. 

  31. <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
    32. 

  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/progress_monitor_hpp.html" title="Header &lt;boost/test/progress_monitor.hpp&gt;">boost/test/progress_monitor.hpp</a>&gt;
    33. 

  33. 

  34. </span>
    35. 

  35. <span class="keyword">class</span> <a class="link" href="progress_monitor_t.html" title="Class progress_monitor_t">progress_monitor_t</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">unit_test</span><span class="special">::</span><span class="identifier">test_observer</span> <span class="special">{</span>
    36. 

  36. <span class="keyword">public</span><span class="special">:</span>
    37. 

  37. 

  38.   <span class="comment">// <a class="link" href="progress_monitor_t.html#idm46279113368400-bb">public member functions</a></span>
    39. 

  39.   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="progress_monitor_t.html#idm46279113367840-bb"><span class="identifier">test_finish</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
    40. 

  40.   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="progress_monitor_t.html#idm46279113365360-bb"><span class="identifier">test_unit_start</span></a><span class="special">(</span><a class="link" href="test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
    41. 

  41.   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="progress_monitor_t.html#idm46279113362512-bb"><span class="identifier">test_unit_skipped</span></a><span class="special">(</span><a class="link" href="test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
    42. 

  42.   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="progress_monitor_t.html#idm46279113360128-bb"><span class="identifier">test_unit_timed_out</span></a><span class="special">(</span><a class="link" href="test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
    43. 

  43.   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="progress_monitor_t.html#idm46279113357168-bb"><span class="identifier">test_unit_aborted</span></a><span class="special">(</span><a class="link" href="test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
    44. 

  44.   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="progress_monitor_t.html#idm46279113352160-bb"><span class="identifier">assertion_result</span></a><span class="special">(</span><span class="identifier">unit_test</span><span class="special">::</span><span class="identifier">assertion_result</span><span class="special">)</span><span class="special">;</span>
    45. 

  45.   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="progress_monitor_t.html#idm46279113350336-bb"><span class="identifier">exception_caught</span></a><span class="special">(</span><a class="link" href="../execution_exception.html" title="Class execution_exception">execution_exception</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
    46. 

  46. <span class="special">}</span><span class="special">;</span></pre></div>
    47. 

  47. <div class="refsect1">
    48. 

  48. <a name="idm45313888056800"></a><h2>Description</h2>
    49. 

  49. <div class="refsect2">
    50. 

  50. <a name="idm45313888056384"></a><h3>
    51. 

  51. <a name="idm46279113368400-bb"></a><code class="computeroutput">progress_monitor_t</code> public member functions</h3>
    52. 

  52. <div class="orderedlist"><ol class="orderedlist" type="1">
    53. 

  53. <li class="listitem">
    54. 

  54. <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113367840-bb"></a><span class="identifier">test_finish</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Called after the framework ends executing the test cases. <div class="note"><table border="0" summary="Note">
    55. 

  55. <tr>
    56. 

  56. <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
    57. 

  57. <th align="left">Note</th>
    58. 

  58. </tr>
    59. 

  59. <tr><td align="left" valign="top"><p>The call is made with a reversed priority order. </p></td></tr>
    60. 

  60. </table></div>
    61. 

  61. <p>
    62. 

  62. </p>
    63. 

  63. </li>
    64. 

  64. <li class="listitem">
    65. 

  65. <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113365360-bb"></a><span class="identifier">test_unit_start</span><span class="special">(</span><a class="link" href="test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>Called before the framework starts executing a test unit. <p>
    66. 

  66. </p>
    67. 

  67. </li>
    68. 

  68. <li class="listitem">
    69. 

  69. <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113362512-bb"></a><span class="identifier">test_unit_skipped</span><span class="special">(</span><a class="link" href="test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>backward compatibility </li>
    70. 

  70. <li class="listitem">
    71. 

  71. <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113360128-bb"></a><span class="identifier">test_unit_timed_out</span><span class="special">(</span><a class="link" href="test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>Called when the test timed out. <p>This function is called to signal that a test unit (case or suite) timed out. A valid test unit is available through boost::unit_test::framework::current_test_unit </p>
    72. 

  72. </li>
    73. 

  73. <li class="listitem">
    74. 

  74. <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113357168-bb"></a><span class="identifier">test_unit_aborted</span><span class="special">(</span><a class="link" href="test_unit.html" title="Class test_unit">test_unit</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>Called when a test unit indicates a fatal error. <p>A fatal error happens when</p>
    75. 

  75. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    76. 

  76. <li class="listitem"><p>a strong assertion (with <code class="computeroutput">REQUIRE</code>) fails, which indicates that the test case cannot continue</p></li>
    77. 

  77. <li class="listitem"><p>an unexpected exception is caught by the Boost.Test framework </p></li>
    78. 

  78. </ul></div>
    79. 

  79. <p>
    80. 

  80. </p>
    81. 

  81. </li>
    82. 

  82. <li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113352160-bb"></a><span class="identifier">assertion_result</span><span class="special">(</span><span class="identifier">unit_test</span><span class="special">::</span><span class="identifier">assertion_result</span><span class="special">)</span><span class="special">;</span></pre></li>
    83. 

  83. <li class="listitem">
    84. 

  84. <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279113350336-bb"></a><span class="identifier">exception_caught</span><span class="special">(</span><a class="link" href="../execution_exception.html" title="Class execution_exception">execution_exception</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>Called when an exception is intercepted. <p>In case an exception is intercepted, this call happens before the call to test_unit_aborted in order to log additional data about the exception. </p>
    85. 

  85. </li>
    86. 

  86. </ol></div>
    87. 

  87. </div>
    88. 

  88. </div>
    89. 

  89. </div>
    90. 

  90. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    91. 

  91. <td align="left"></td>
    92. 

  92. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
    93. 

  93.       contributors<p>
    94. 

  94.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    95. 

  95.         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>)
    96. 

  96.       </p>
    97. 

  97. </div></td>
    98. 

  98. </tr></table>
    99. 

  99. <hr>
    100. 

  100. <div class="spirit-nav">
    101. 

  101. <a accesskey="p" href="../../header/boost/test/progress_monitor_hpp.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/test/progress_monitor_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="../../header/boost/test/results_collector_hpp.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
    102. 

  102. </div>
    103. 

  103. </body>
    104. 

  104. </html>
    105.