libs/test/doc/html/boost/unit_test/unit_test_log_t.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class unit_test_log_t</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/unit_test_log_hpp.html" title="Header &lt;boost/test/unit_test_log.hpp&gt;">
   9 <link rel="prev" href="log/end.html" title="Struct end">
  10 <link rel="next" href="../../BOOST_TEST_LOG_ENTRY.html" title="Macro BOOST_TEST_LOG_ENTRY">
  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="log/end.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/test/unit_test_log_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="../../BOOST_TEST_LOG_ENTRY.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.unit_test.unit_test_log_t"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class unit_test_log_t</span></h2>
  29 <p>boost::unit_test::unit_test_log_t &#8212; Manages the sets of loggers, their streams and log levels. </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/unit_test_log_hpp.html" title="Header &lt;boost/test/unit_test_log.hpp&gt;">boost/test/unit_test_log.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">class</span> <a class="link" href="unit_test_log_t.html" title="Class unit_test_log_t">unit_test_log_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 <span class="keyword">public</span><span class="special">:</span>
  37
  38   <span class="comment">// <a class="link" href="unit_test_log_t.html#idm46279112694352-bb">public member functions</a></span>
  39   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112693792-bb"><span class="identifier">test_start</span></a><span class="special">(</span><span class="identifier">counter_t</span><span class="special">)</span><span class="special">;</span>
  40   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112691232-bb"><span class="identifier">test_finish</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  41   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112688752-bb"><span class="identifier">test_aborted</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  42   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112685776-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>
  43   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112682928-bb"><span class="identifier">test_unit_finish</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="keyword">unsigned</span> <span class="keyword">long</span><span class="special">)</span><span class="special">;</span>
  44   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112679424-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="identifier">const_string</span><span class="special">)</span><span class="special">;</span>
  45   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112676640-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>
  46   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112671632-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>
  47   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112668672-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>
  48   <span class="keyword">virtual</span> <span class="keyword">int</span> <a class="link" href="unit_test_log_t.html#idm46279112665712-bb"><span class="identifier">priority</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  49   <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112664176-bb"><span class="identifier">set_stream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  50   <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112661856-bb"><span class="identifier">set_stream</span></a><span class="special">(</span><span class="identifier">output_format</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  51   <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">*</span> <a class="link" href="unit_test_log_t.html#idm46279112657440-bb"><span class="identifier">get_stream</span></a><span class="special">(</span><span class="identifier">output_format</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  52   <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112653408-bb"><span class="identifier">set_threshold_level</span></a><span class="special">(</span><span class="identifier">log_level</span><span class="special">)</span><span class="special">;</span>
  53   <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112651072-bb"><span class="identifier">set_threshold_level</span></a><span class="special">(</span><span class="identifier">output_format</span><span class="special">,</span> <span class="identifier">log_level</span><span class="special">)</span><span class="special">;</span>
  54   <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112646640-bb"><span class="identifier">add_format</span></a><span class="special">(</span><span class="identifier">output_format</span><span class="special">)</span><span class="special">;</span>
  55   <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112643360-bb"><span class="identifier">set_format</span></a><span class="special">(</span><span class="identifier">output_format</span><span class="special">)</span><span class="special">;</span>
  56   <a class="link" href="unit_test_log_formatter.html" title="Class unit_test_log_formatter">unit_test_log_formatter</a> <span class="special">*</span> <a class="link" href="unit_test_log_t.html#idm46279112641072-bb"><span class="identifier">get_formatter</span></a><span class="special">(</span><span class="identifier">output_format</span><span class="special">)</span><span class="special">;</span>
  57   <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112636720-bb"><span class="identifier">set_formatter</span></a><span class="special">(</span><a class="link" href="unit_test_log_formatter.html" title="Class unit_test_log_formatter">unit_test_log_formatter</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  58   <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112628912-bb"><span class="identifier">add_formatter</span></a><span class="special">(</span><a class="link" href="unit_test_log_formatter.html" title="Class unit_test_log_formatter">unit_test_log_formatter</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  59   <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112623296-bb"><span class="identifier">set_checkpoint</span></a><span class="special">(</span><span class="identifier">const_string</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span>
  60                       <span class="identifier">const_string</span> <span class="special">=</span> <span class="identifier">const_string</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  61   <a class="link" href="unit_test_log_t.html" title="Class unit_test_log_t">unit_test_log_t</a> <span class="special">&amp;</span> <a class="link" href="unit_test_log_t.html#idm46279112620096-bb"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><a class="link" href="log/begin.html" title="Struct begin">log::begin</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  62   <a class="link" href="unit_test_log_t.html" title="Class unit_test_log_t">unit_test_log_t</a> <span class="special">&amp;</span> <a class="link" href="unit_test_log_t.html#idm46279112617984-bb"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><a class="link" href="log/end.html" title="Struct end">log::end</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  63   <a class="link" href="unit_test_log_t.html" title="Class unit_test_log_t">unit_test_log_t</a> <span class="special">&amp;</span> <a class="link" href="unit_test_log_t.html#idm46279112615872-bb"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">log_level</span><span class="special">)</span><span class="special">;</span>
  64   <a class="link" href="unit_test_log_t.html" title="Class unit_test_log_t">unit_test_log_t</a> <span class="special">&amp;</span> <a class="link" href="unit_test_log_t.html#idm46279112614048-bb"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">const_string</span><span class="special">)</span><span class="special">;</span>
  65   <a class="link" href="unit_test_log_t.html" title="Class unit_test_log_t">unit_test_log_t</a> <span class="special">&amp;</span> <a class="link" href="unit_test_log_t.html#idm46279112612224-bb"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">lazy_ostream</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  66   <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="unit_test_log_t.html#idm46279112610400-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">log_level</span><span class="special">)</span><span class="special">;</span>
  67   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112608736-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>
  68   <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112606352-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>
  69
  70   <span class="comment">// <a class="link" href="unit_test_log_t.html#idm46279112604368-bb">private member functions</a></span>
  71   <span class="keyword">bool</span> <a class="link" href="unit_test_log_t.html#idm46279112603792-bb"><span class="identifier">log_entry_start</span></a><span class="special">(</span><span class="identifier">output_format</span><span class="special">)</span><span class="special">;</span>
  72   <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112602256-bb"><span class="identifier">log_entry_context</span></a><span class="special">(</span><span class="identifier">log_level</span><span class="special">)</span><span class="special">;</span>
  73   <span class="keyword">void</span> <a class="link" href="unit_test_log_t.html#idm46279112600720-bb"><span class="identifier">clear_entry_context</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  74 <span class="special">}</span><span class="special">;</span></pre></div>
  75 <div class="refsect1">
  76 <a name="idm45313884327408"></a><h2>Description</h2>
  77 <p>The Boost.Test framework allows for having several formatters/loggers at the same time, each of which having their own log level and output stream.</p>
  78 <p>This class serves the purpose of</p>
  79 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  80 <li class="listitem"><p>exposing an interface to the test framework (as a <a class="link" href="test_observer.html" title="Class test_observer">boost::unit_test::test_observer</a>)</p></li>
  81 <li class="listitem"><p>exposing an interface to the testing tools</p></li>
  82 <li class="listitem"><p>managing several loggers</p></li>
  83 </ul></div>
  84 <p>
  85 </p>
  86 <div class="note"><table border="0" summary="Note">
  87 <tr>
  88 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  89 <th align="left">Note</th>
  90 </tr>
  91 <tr><td align="left" valign="top"><p>Accesses to the functions exposed by this class are made through the singleton <code class="computeroutput">boost::unit_test::unit_test_log</code>.</p></td></tr>
  92 </table></div>
  93 <p>
  94 Users/developers willing to implement their own formatter need to:</p>
  95 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  96 <li class="listitem"><p>implement a <a class="link" href="unit_test_log_formatter.html" title="Class unit_test_log_formatter">boost::unit_test::unit_test_log_formatter</a> that will output the desired format</p></li>
  97 <li class="listitem"><p>register the formatter during a eg. global fixture using the method <code class="computeroutput">set_formatter</code> (though the framework singleton).</p></li>
  98 </ul></div>
  99 <p>
 100 </p>
 101 <div class="warning"><table border="0" summary="Warning">
 102 <tr>
 103 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../doc/src/images/warning.png"></td>
 104 <th align="left">Warning</th>
 105 </tr>
 106 <tr><td align="left" valign="top"><p>this observer has a higher priority than the <a class="link" href="results_collector_t.html" title="Class results_collector_t">boost::unit_test::results_collector_t</a>. This means that the various <a class="link" href="test_results.html" title="Class test_results">boost::unit_test::test_results</a> associated to each test unit may not be available at the time the <code class="computeroutput">test_unit_start</code>, <code class="computeroutput">test_unit_finish</code> ... are called.</p></td></tr>
 107 </table></div>
 108 <p>
 109 </p>
 110 <p><span class="bold"><strong>See Also:</strong></span></p>
 111 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 112 <li class="listitem"><p><a class="link" href="test_observer.html" title="Class test_observer">boost::unit_test::test_observer</a></p></li>
 113 <li class="listitem"><p><a class="link" href="unit_test_log_formatter.html" title="Class unit_test_log_formatter">boost::unit_test::unit_test_log_formatter</a> </p></li>
 114 </ul></div>
 115 <p>
 116 </p>
 117 <p>
 118 </p>
 119 <p>
 120 </p>
 121 <div class="refsect2">
 122 <a name="idm45313884310592"></a><h3>
 123 <a name="idm46279112694352-bb"></a><code class="computeroutput">unit_test_log_t</code> public member functions</h3>
 124 <div class="orderedlist"><ol class="orderedlist" type="1">
 125 <li class="listitem">
 126 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279112693792-bb"></a><span class="identifier">test_start</span><span class="special">(</span><span class="identifier">counter_t</span><span class="special">)</span><span class="special">;</span></pre>Called before the framework starts executing the test cases. <p>
 127 </p>
 128 </li>
 129 <li class="listitem">
 130 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279112691232-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">
 131 <tr>
 132 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
 133 <th align="left">Note</th>
 134 </tr>
 135 <tr><td align="left" valign="top"><p>The call is made with a reversed priority order. </p></td></tr>
 136 </table></div>
 137 <p>
 138 </p>
 139 </li>
 140 <li class="listitem">
 141 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279112688752-bb"></a><span class="identifier">test_aborted</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Called when a critical error is detected. <p>The critical errors are mainly the signals sent by the system and caught by the Boost.Test framework. Since the running binary may be in incoherent/instable state, the test execution is aborted and all remaining tests are discarded.</p>
 142 <div class="note"><table border="0" summary="Note">
 143 <tr>
 144 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
 145 <th align="left">Note</th>
 146 </tr>
 147 <tr><td align="left" valign="top"><p>may be called before test_observer::test_unit_finish() </p></td></tr>
 148 </table></div>
 149 <p>
 150 </p>
 151 </li>
 152 <li class="listitem">
 153 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279112685776-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>
 154 </p>
 155 </li>
 156 <li class="listitem">
 157 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279112682928-bb"></a><span class="identifier">test_unit_finish</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="keyword">unsigned</span> <span class="keyword">long</span><span class="special">)</span><span class="special">;</span></pre>Called at each end of a test unit. <p>
 158 </p>
 159 </li>
 160 <li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279112679424-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="identifier">const_string</span><span class="special">)</span><span class="special">;</span></pre></li>
 161 <li class="listitem">
 162 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279112676640-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>
 163 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 164 <li class="listitem"><p>a strong assertion (with <code class="computeroutput">REQUIRE</code>) fails, which indicates that the test case cannot continue</p></li>
 165 <li class="listitem"><p>an unexpected exception is caught by the Boost.Test framework </p></li>
 166 </ul></div>
 167 <p>
 168 </p>
 169 </li>
 170 <li class="listitem">
 171 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279112671632-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>
 172 </li>
 173 <li class="listitem">
 174 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279112668672-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>
 175 </li>
 176 <li class="listitem">
 177 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">int</span> <a name="idm46279112665712-bb"></a><span class="identifier">priority</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>The priority indicates the order at which this observer is initialized and tore down in the UTF framework. The order is lowest to highest priority. </li>
 178 <li class="listitem">
 179 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46279112664176-bb"></a><span class="identifier">set_stream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>Sets the stream for all loggers. <p>This will override the log sink/stream of all loggers, whether enabled or not. </p>
 180 </li>
 181 <li class="listitem">
 182 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46279112661856-bb"></a><span class="identifier">set_stream</span><span class="special">(</span><span class="identifier">output_format</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>Sets the stream for specific logger. <div class="note"><table border="0" summary="Note">
 183 <tr>
 184 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
 185 <th align="left">Note</th>
 186 </tr>
 187 <tr><td align="left" valign="top"><p>Has no effect if the specified format is not found </p></td></tr>
 188 </table></div>
 189 <p>
 190 </p>
 191 <p><b>Since Boost 1.62 .&#160;</b></p>
 192 <p>
 193 </p>
 194 </li>
 195 <li class="listitem">
 196 <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">*</span> <a name="idm46279112657440-bb"></a><span class="identifier">get_stream</span><span class="special">(</span><span class="identifier">output_format</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a pointer to the stream associated to specific logger. <div class="note"><table border="0" summary="Note">
 197 <tr>
 198 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
 199 <th align="left">Note</th>
 200 </tr>
 201 <tr><td align="left" valign="top"><p>Returns a null pointer if the format is not found </p></td></tr>
 202 </table></div>
 203 <p>
 204 </p>
 205 <p><b>Since Boost 1.67 .&#160;</b></p>
 206 <p>
 207 </p>
 208 </li>
 209 <li class="listitem">
 210 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46279112653408-bb"></a><span class="identifier">set_threshold_level</span><span class="special">(</span><span class="identifier">log_level</span><span class="special">)</span><span class="special">;</span></pre>Sets the threshold level for all loggers/formatters. <p>This will override the log level of all loggers, whether enabled or not. </p>
 211 </li>
 212 <li class="listitem">
 213 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46279112651072-bb"></a><span class="identifier">set_threshold_level</span><span class="special">(</span><span class="identifier">output_format</span><span class="special">,</span> <span class="identifier">log_level</span><span class="special">)</span><span class="special">;</span></pre>Sets the threshold/log level of a specific format. <div class="note"><table border="0" summary="Note">
 214 <tr>
 215 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
 216 <th align="left">Note</th>
 217 </tr>
 218 <tr><td align="left" valign="top"><p>Has no effect if the specified format is not found </p></td></tr>
 219 </table></div>
 220 <p>
 221 </p>
 222 <p><b>Since Boost 1.62 .&#160;</b></p>
 223 <p>
 224 </p>
 225 </li>
 226 <li class="listitem">
 227 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46279112646640-bb"></a><span class="identifier">add_format</span><span class="special">(</span><span class="identifier">output_format</span><span class="special">)</span><span class="special">;</span></pre>Add a format to the set of loggers. <p>Adding a logger means that the specified logger is enabled. The log level is managed by the formatter itself and specifies what events are forwarded to the underlying formatter. </p>
 228 <p><b>Since Boost 1.62 .&#160;</b></p>
 229 <p>
 230 </p>
 231 </li>
 232 <li class="listitem">
 233 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46279112643360-bb"></a><span class="identifier">set_format</span><span class="special">(</span><span class="identifier">output_format</span><span class="special">)</span><span class="special">;</span></pre>Sets the format of the logger. <p>This will become the only active format of the logs. </p>
 234 </li>
 235 <li class="listitem">
 236 <pre class="literallayout"><a class="link" href="unit_test_log_formatter.html" title="Class unit_test_log_formatter">unit_test_log_formatter</a> <span class="special">*</span> <a name="idm46279112641072-bb"></a><span class="identifier">get_formatter</span><span class="special">(</span><span class="identifier">output_format</span><span class="special">)</span><span class="special">;</span></pre>Returns the logger instance for a specific format. <p>
 237 </p>
 238 <p><b>Since Boost 1.62 .&#160;</b></p>
 239 <p>
 240 </p>
 241 <div class="variablelist"><table border="0" class="variablelist compact">
 242 <colgroup>
 243 <col align="left" valign="top">
 244 <col>
 245 </colgroup>
 246 <tbody><tr>
 247 <td><p><span class="term">Returns:</span></p></td>
 248 <td><p>the logger/formatter instance, or <code class="computeroutput"></code>(unit_test_log_formatter*)0 if the format is not found. </p></td>
 249 </tr></tbody>
 250 </table></div>
 251 </li>
 252 <li class="listitem">
 253 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46279112636720-bb"></a><span class="identifier">set_formatter</span><span class="special">(</span><a class="link" href="unit_test_log_formatter.html" title="Class unit_test_log_formatter">unit_test_log_formatter</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span></pre>Sets the logger instance. <p>The specified logger becomes the unique active one. The custom log formatter has the format <code class="computeroutput">OF_CUSTOM_LOGGER</code>. If such a format exists already, its formatter gets replaced by the one given in argument.</p>
 254 <p>The log level and output stream of the new formatter are taken from the currently active logger. In case several loggers are active, the order of priority is CUSTOM, HRF, XML, and JUNIT. If (unit_test_log_formatter*)0 is given as argument, the custom logger (if any) is removed.</p>
 255 <div class="note"><table border="0" summary="Note">
 256 <tr>
 257 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
 258 <th align="left">Note</th>
 259 </tr>
 260 <tr><td align="left" valign="top">
 261 <p>The ownership of the pointer is transfered to the Boost.Test framework. This call is equivalent to</p>
 262 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 263 <li class="listitem"><p>a call to <code class="computeroutput">add_formatter</code> </p></li>
 264 <li class="listitem"><p>a call to <code class="computeroutput">set_format(OF_CUSTOM_LOGGER)</code> </p></li>
 265 <li class="listitem"><p>a configuration of the newly added logger with a previously configured stream and log level. </p></li>
 266 </ul></div>
 267 <p>
 268 </p>
 269 </td></tr>
 270 </table></div>
 271 <p>
 272 </p>
 273 </li>
 274 <li class="listitem">
 275 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46279112628912-bb"></a><span class="identifier">add_formatter</span><span class="special">(</span><a class="link" href="unit_test_log_formatter.html" title="Class unit_test_log_formatter">unit_test_log_formatter</a> <span class="special">*</span> the_formatter<span class="special">)</span><span class="special">;</span></pre>Adds a custom log formatter to the set of formatters. <p>The specified logger is added with the format <code class="computeroutput">OF_CUSTOM_LOGGER</code>, such that it can be futher selected or its stream/log level can be specified. If there is already a custom logger (with <code class="computeroutput">OF_CUSTOM_LOGGER</code>), then the existing one gets replaced by the one given in argument. The provided logger is added with an enabled state. If (unit_test_log_formatter*)0 is given as argument, the custom logger (if any) is removed and no other action is performed.</p>
 276 <div class="note"><table border="0" summary="Note">
 277 <tr>
 278 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
 279 <th align="left">Note</th>
 280 </tr>
 281 <tr><td align="left" valign="top"><p>The ownership of the pointer is transfered to the Boost.Test framework. </p></td></tr>
 282 </table></div>
 283 <p>
 284 </p>
 285 <p><b>Since Boost 1.62 .&#160;</b></p>
 286 <p>
 287 </p>
 288 </li>
 289 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46279112623296-bb"></a><span class="identifier">set_checkpoint</span><span class="special">(</span><span class="identifier">const_string</span> file<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> line_num<span class="special">,</span>
 290                     <span class="identifier">const_string</span> msg <span class="special">=</span> <span class="identifier">const_string</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li>
 291 <li class="listitem"><pre class="literallayout"><a class="link" href="unit_test_log_t.html" title="Class unit_test_log_t">unit_test_log_t</a> <span class="special">&amp;</span> <a name="idm46279112620096-bb"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><a class="link" href="log/begin.html" title="Struct begin">log::begin</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre></li>
 292 <li class="listitem"><pre class="literallayout"><a class="link" href="unit_test_log_t.html" title="Class unit_test_log_t">unit_test_log_t</a> <span class="special">&amp;</span> <a name="idm46279112617984-bb"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><a class="link" href="log/end.html" title="Struct end">log::end</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre></li>
 293 <li class="listitem"><pre class="literallayout"><a class="link" href="unit_test_log_t.html" title="Class unit_test_log_t">unit_test_log_t</a> <span class="special">&amp;</span> <a name="idm46279112615872-bb"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><span class="identifier">log_level</span><span class="special">)</span><span class="special">;</span></pre></li>
 294 <li class="listitem"><pre class="literallayout"><a class="link" href="unit_test_log_t.html" title="Class unit_test_log_t">unit_test_log_t</a> <span class="special">&amp;</span> <a name="idm46279112614048-bb"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><span class="identifier">const_string</span><span class="special">)</span><span class="special">;</span></pre></li>
 295 <li class="listitem"><pre class="literallayout"><a class="link" href="unit_test_log_t.html" title="Class unit_test_log_t">unit_test_log_t</a> <span class="special">&amp;</span> <a name="idm46279112612224-bb"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><span class="identifier">lazy_ostream</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre></li>
 296 <li class="listitem"><pre class="literallayout"><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idm46279112610400-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">log_level</span><span class="special">)</span><span class="special">;</span></pre></li>
 297 <li class="listitem">
 298 <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279112608736-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>
 299 <li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46279112606352-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>
 300 </ol></div>
 301 </div>
 302 <div class="refsect2">
 303 <a name="idm45313884086288"></a><h3>
 304 <a name="idm46279112604368-bb"></a><code class="computeroutput">unit_test_log_t</code> private member functions</h3>
 305 <div class="orderedlist"><ol class="orderedlist" type="1">
 306 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm46279112603792-bb"></a><span class="identifier">log_entry_start</span><span class="special">(</span><span class="identifier">output_format</span> log_format<span class="special">)</span><span class="special">;</span></pre></li>
 307 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46279112602256-bb"></a><span class="identifier">log_entry_context</span><span class="special">(</span><span class="identifier">log_level</span> l<span class="special">)</span><span class="special">;</span></pre></li>
 308 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46279112600720-bb"></a><span class="identifier">clear_entry_context</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
 309 </ol></div>
 310 </div>
 311 </div>
 312 </div>
 313 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 314 <td align="left"></td>
 315 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
 316       contributors<p>
 317         Distributed under the Boost Software License, Version 1.0. (See accompanying
 318         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>)
 319       </p>
 320 </div></td>
 321 </tr></table>
 322 <hr>
 323 <div class="spirit-nav">
 324 <a accesskey="p" href="log/end.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/test/unit_test_log_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="../../BOOST_TEST_LOG_ENTRY.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 325 </div>
 326 </body>
 327 </html>