Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / test / doc / html / header / boost / test / unit_test_parameters_hpp.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Header &lt;boost/test/unit_test_parameters.hpp&gt;</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="../../../boost_test/reference.html" title="Reference">
9 <link rel="prev" href="../../../boost/unit_test/unit_test_log_formatter.html" title="Class unit_test_log_formatter">
10 <link rel="next" href="../../../boost/unit_test/runtime_config/stream_holder.html" title="Class stream_holder">
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="../../../boost/unit_test/unit_test_log_formatter.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_test/reference.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/unit_test/runtime_config/stream_holder.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
24 </div>
25 <div class="section">
26 <div class="titlepage"><div><div><h4 class="title">
27 <a name="header.boost.test.unit_test_parameters_hpp"></a>Header &lt;<a href="../../../../../../../boost/test/unit_test_parameters.hpp" target="_top">boost/test/unit_test_parameters.hpp</a>&gt;</h4></div></div></div>
28 <p>Provides access to various Unit Test Framework runtime parameters. </p>
29 <p>Primarily for use by the framework itself </p>
30 <pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
31   <span class="keyword">namespace</span> <span class="identifier">unit_test</span> <span class="special">{</span>
32     <span class="keyword">namespace</span> <span class="identifier">runtime_config</span> <span class="special">{</span>
33       <span class="keyword">class</span> <a class="link" href="../../../boost/unit_test/runtime_config/stream_holder.html" title="Class stream_holder">stream_holder</a><span class="special">;</span>
34
35       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_auto_start_dbg.html" title="Global btrt_auto_start_dbg">btrt_auto_start_dbg</a><span class="special">;</span>
36       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_break_exec_path.html" title="Global btrt_break_exec_path">btrt_break_exec_path</a><span class="special">;</span>
37       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_build_info.html" title="Global btrt_build_info">btrt_build_info</a><span class="special">;</span>
38       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_catch_sys_errors.html" title="Global btrt_catch_sys_errors">btrt_catch_sys_errors</a><span class="special">;</span>
39       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_color_output.html" title="Global btrt_color_output">btrt_color_output</a><span class="special">;</span>
40       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_detect_fp_except.html" title="Global btrt_detect_fp_except">btrt_detect_fp_except</a><span class="special">;</span>
41       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_detect_mem_leaks.html" title="Global btrt_detect_mem_leaks">btrt_detect_mem_leaks</a><span class="special">;</span>
42       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_list_content.html" title="Global btrt_list_content">btrt_list_content</a><span class="special">;</span>
43       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_list_labels.html" title="Global btrt_list_labels">btrt_list_labels</a><span class="special">;</span>
44       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_log_format.html" title="Global btrt_log_format">btrt_log_format</a><span class="special">;</span>
45       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_log_level.html" title="Global btrt_log_level">btrt_log_level</a><span class="special">;</span>
46       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_log_sink.html" title="Global btrt_log_sink">btrt_log_sink</a><span class="special">;</span>
47       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_combined_logger.html" title="Global btrt_combined_logger">btrt_combined_logger</a><span class="special">;</span>
48       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_output_format.html" title="Global btrt_output_format">btrt_output_format</a><span class="special">;</span>
49       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_random_seed.html" title="Global btrt_random_seed">btrt_random_seed</a><span class="special">;</span>
50       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_report_format.html" title="Global btrt_report_format">btrt_report_format</a><span class="special">;</span>
51       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_report_level.html" title="Global btrt_report_level">btrt_report_level</a><span class="special">;</span>
52       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_report_mem_leaks.html" title="Global btrt_report_mem_leaks">btrt_report_mem_leaks</a><span class="special">;</span>
53       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_report_sink.html" title="Global btrt_report_sink">btrt_report_sink</a><span class="special">;</span>
54       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_result_code.html" title="Global btrt_result_code">btrt_result_code</a><span class="special">;</span>
55       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_run_filters.html" title="Global btrt_run_filters">btrt_run_filters</a><span class="special">;</span>
56       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_save_test_pattern.html" title="Global btrt_save_test_pattern">btrt_save_test_pattern</a><span class="special">;</span>
57       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_show_progress.html" title="Global btrt_show_progress">btrt_show_progress</a><span class="special">;</span>
58       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_use_alt_stack.html" title="Global btrt_use_alt_stack">btrt_use_alt_stack</a><span class="special">;</span>
59       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_wait_for_debugger.html" title="Global btrt_wait_for_debugger">btrt_wait_for_debugger</a><span class="special">;</span>
60       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_help.html" title="Global btrt_help">btrt_help</a><span class="special">;</span>
61       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_usage.html" title="Global btrt_usage">btrt_usage</a><span class="special">;</span>
62       <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="../../../boost/unit_test/runtime_config/btrt_version.html" title="Global btrt_version">btrt_version</a><span class="special">;</span>
63       <span class="keyword">void</span> <a name="boost.unit_test.runtime_config.init"></a><span class="identifier">init</span><span class="special">(</span><span class="keyword">int</span> <span class="special">&amp;</span> argc<span class="special">,</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">*</span> argv<span class="special">)</span><span class="special">;</span>
64
65       <span class="comment">// Access to arguments. </span>
66       <span class="identifier">runtime</span><span class="special">::</span><span class="identifier">arguments_store</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a name="boost.unit_test.runtime_config.argument_store"></a><span class="identifier">argument_store</span><span class="special">(</span><span class="special">)</span><span class="special">;</span>
67       <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="identifier">T</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a name="boost.unit_test.runtime_config.get"></a><span class="identifier">get</span><span class="special">(</span><span class="identifier">runtime</span><span class="special">::</span><span class="identifier">cstring</span> parameter_name<span class="special">)</span><span class="special">;</span>
68       <span class="keyword">bool</span> <a name="boost.unit_test.runtime_config.has"></a><span class="identifier">has</span><span class="special">(</span><span class="identifier">runtime</span><span class="special">::</span><span class="identifier">cstring</span> parameter_name<span class="special">)</span><span class="special">;</span>
69
70       <span class="comment">// For public access. </span>
71       <span class="keyword">bool</span> <a name="boost.unit_test.runtime_config.save_pattern"></a><span class="identifier">save_pattern</span><span class="special">(</span><span class="special">)</span><span class="special">;</span>
72     <span class="special">}</span>
73   <span class="special">}</span>
74 <span class="special">}</span></pre>
75 </div>
76 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
77 <td align="left"></td>
78 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
79       contributors<p>
80         Distributed under the Boost Software License, Version 1.0. (See accompanying
81         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>)
82       </p>
83 </div></td>
84 </tr></table>
85 <hr>
86 <div class="spirit-nav">
87 <a accesskey="p" href="../../../boost/unit_test/unit_test_log_formatter.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_test/reference.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/unit_test/runtime_config/stream_holder.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
88 </div>
89 </body>
90 </html>