Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / test / doc / html / boost / unit_test / test_results.html
index e4153c0..647b0a3 100644 (file)
 <span class="keyword">class</span> <a class="link" href="test_results.html" title="Class test_results">test_results</a> <span class="special">{</span>
 <span class="keyword">public</span><span class="special">:</span>
   <span class="comment">// <a class="link" href="test_results.html#boost.unit_test.test_resultsconstruct-copy-destruct">construct/copy/destruct</a></span>
-  <a class="link" href="test_results.html#idm45665013107632-bb"><span class="identifier">test_results</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="test_results.html#idm46279113259472-bb"><span class="identifier">test_results</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="test_results.html#idm45665013130816-bb">public member functions</a></span>
-  <span class="keyword">typedef</span> <a class="link" href="test_results.html#idm45665013130256-bb"><span class="identifier">BOOST_READONLY_PROPERTY</span></a><span class="special">(</span><span class="identifier">counter_t</span><span class="special">,</span> 
+  <span class="comment">// <a class="link" href="test_results.html#idm46279113282656-bb">public member functions</a></span>
+  <span class="keyword">typedef</span> <a class="link" href="test_results.html#idm46279113282096-bb"><span class="identifier">BOOST_READONLY_PROPERTY</span></a><span class="special">(</span><span class="identifier">counter_t</span><span class="special">,</span> 
                                   <span class="special">(</span><a class="link" href="results_collector_t.html" title="Class results_collector_t">results_collector_t</a><span class="special">)</span><span class="special">(</span><a class="link" href="test_results.html" title="Class test_results">test_results</a><span class="special">)</span><span class="special">(</span><span class="identifier">results_collect_helper</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">typedef</span> <a class="link" href="test_results.html#idm45665013126800-bb"><span class="identifier">BOOST_READONLY_PROPERTY</span></a><span class="special">(</span><span class="keyword">bool</span><span class="special">,</span> 
+  <span class="keyword">typedef</span> <a class="link" href="test_results.html#idm46279113278640-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="results_collector_t.html" title="Class results_collector_t">results_collector_t</a><span class="special">)</span><span class="special">(</span><a class="link" href="test_results.html" title="Class test_results">test_results</a><span class="special">)</span><span class="special">(</span><span class="identifier">results_collect_helper</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">bool</span> <a class="link" href="test_results.html#idm45665013123344-bb"><span class="identifier">passed</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="keyword">bool</span> <a class="link" href="test_results.html#idm45665013121920-bb"><span class="identifier">skipped</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="keyword">bool</span> <a class="link" href="test_results.html#idm45665013119952-bb"><span class="identifier">aborted</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="keyword">int</span> <a class="link" href="test_results.html#idm45665013118496-bb"><span class="identifier">result_code</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="keyword">void</span> <a class="link" href="test_results.html#idm45665013112448-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><a class="link" href="test_results.html" title="Class test_results">test_results</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">void</span> <a class="link" href="test_results.html#idm45665013108960-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">bool</span> <a class="link" href="test_results.html#idm46279113275184-bb"><span class="identifier">passed</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="keyword">bool</span> <a class="link" href="test_results.html#idm46279113273760-bb"><span class="identifier">skipped</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="keyword">bool</span> <a class="link" href="test_results.html#idm46279113271792-bb"><span class="identifier">aborted</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="keyword">int</span> <a class="link" href="test_results.html#idm46279113270336-bb"><span class="identifier">result_code</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="keyword">void</span> <a class="link" href="test_results.html#idm46279113264288-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><a class="link" href="test_results.html" title="Class test_results">test_results</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">void</span> <a class="link" href="test_results.html#idm46279113260800-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
   <span class="comment">// public data members</span>
   <span class="identifier">counter_prop</span> <span class="identifier">p_test_suites</span><span class="special">;</span>  <span class="comment">// Number of test suites. </span>
   <span class="identifier">bool_prop</span> <span class="identifier">p_timed_out</span><span class="special">;</span>  <span class="comment">// Indicates that the test unit has timed out. </span>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idm45734497900960"></a><h2>Description</h2>
+<a name="idm45313887690016"></a><h2>Description</h2>
 <p>This class is a collection of attributes describing a test result.</p>
 <p>The attributes presented as public properties on an instance of the class. In addition summary conclusion methods are presented to generate simple answer to pass/fail question </p>
 <div class="refsect2">
-<a name="idm45734497899760"></a><h3>
+<a name="idm45313887688816"></a><h3>
 <a name="boost.unit_test.test_resultsconstruct-copy-destruct"></a><code class="computeroutput">test_results</code> 
         public
        construct/copy/destruct</h3>
-<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm45665013107632-bb"></a><span class="identifier">test_results</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
+<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm46279113259472-bb"></a><span class="identifier">test_results</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
 </div>
 <div class="refsect2">
-<a name="idm45734497893952"></a><h3>
-<a name="idm45665013130816-bb"></a><code class="computeroutput">test_results</code> public member functions</h3>
+<a name="idm45313887683040"></a><h3>
+<a name="idm46279113282656-bb"></a><code class="computeroutput">test_results</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">typedef</span> <a name="idm45665013130256-bb"></a><span class="identifier">BOOST_READONLY_PROPERTY</span><span class="special">(</span><span class="identifier">counter_t</span><span class="special">,</span> 
+<pre class="literallayout"><span class="keyword">typedef</span> <a name="idm46279113282096-bb"></a><span class="identifier">BOOST_READONLY_PROPERTY</span><span class="special">(</span><span class="identifier">counter_t</span><span class="special">,</span> 
                                 <span class="special">(</span><a class="link" href="results_collector_t.html" title="Class results_collector_t">results_collector_t</a><span class="special">)</span><span class="special">(</span><a class="link" href="test_results.html" title="Class test_results">test_results</a><span class="special">)</span><span class="special">(</span><span class="identifier">results_collect_helper</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Type representing counter like public property. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">typedef</span> <a name="idm45665013126800-bb"></a><span class="identifier">BOOST_READONLY_PROPERTY</span><span class="special">(</span><span class="keyword">bool</span><span class="special">,</span> 
+<pre class="literallayout"><span class="keyword">typedef</span> <a name="idm46279113278640-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="results_collector_t.html" title="Class results_collector_t">results_collector_t</a><span class="special">)</span><span class="special">(</span><a class="link" href="test_results.html" title="Class test_results">test_results</a><span class="special">)</span><span class="special">(</span><span class="identifier">results_collect_helper</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Type representing boolean like public property. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">bool</span> <a name="idm45665013123344-bb"></a><span class="identifier">passed</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if test unit passed. </li>
+<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46279113275184-bb"></a><span class="identifier">passed</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if test unit passed. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">bool</span> <a name="idm45665013121920-bb"></a><span class="identifier">skipped</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if test unit skipped. <p>For test suites, this indicates if the test suite itself has been marked as skipped, and not if the test suite contains any skipped test. </p>
+<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46279113273760-bb"></a><span class="identifier">skipped</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if test unit skipped. <p>For test suites, this indicates if the test suite itself has been marked as skipped, and not if the test suite contains any skipped test. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">bool</span> <a name="idm45665013119952-bb"></a><span class="identifier">aborted</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if the test unit was aborted (hard failure) </li>
+<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46279113271792-bb"></a><span class="identifier">aborted</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if the test unit was aborted (hard failure) </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">int</span> <a name="idm45665013118496-bb"></a><span class="identifier">result_code</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Produces result code for the test unit execution. <p>This methhod return one of the result codes defined in <code class="computeroutput">boost/cstdlib.hpp</code> 
+<pre class="literallayout"><span class="keyword">int</span> <a name="idm46279113270336-bb"></a><span class="identifier">result_code</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Produces result code for the test unit execution. <p>This methhod return one of the result codes defined in <code class="computeroutput">boost/cstdlib.hpp</code> 
 </p>
 <div class="variablelist"><table border="0" class="variablelist compact">
 <colgroup>
 </table></div>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">void</span> <a name="idm45665013112448-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><a class="link" href="test_results.html" title="Class test_results">test_results</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>Combines the results of the current instance with another. <p>Only the counters are updated and the <code class="computeroutput">p_aborted</code> and <code class="computeroutput">p_skipped</code> are left unchanged. </p>
+<pre class="literallayout"><span class="keyword">void</span> <a name="idm46279113264288-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><a class="link" href="test_results.html" title="Class test_results">test_results</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>Combines the results of the current instance with another. <p>Only the counters are updated and the <code class="computeroutput">p_aborted</code> and <code class="computeroutput">p_skipped</code> are left unchanged. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">void</span> <a name="idm45665013108960-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Resets the current state of the result. </li>
+<pre class="literallayout"><span class="keyword">void</span> <a name="idm46279113260800-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Resets the current state of the result. </li>
 </ol></div>
 </div>
 </div>
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 <td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright &#169; 2001-2018 Boost.Test contributors<p>
+<td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
+      contributors<p>
         Distributed under the Boost Software License, Version 1.0. (See accompanying
         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>)
       </p>