1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template basic_settings</title> 5<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../index.html" title="Chapter 1. Boost.Log v2"> 8<link rel="up" href="../../utilities.html#header.boost.log.utility.setup.settings_hpp" title="Header <boost/log/utility/setup/settings.hpp>"> 9<link rel="prev" href="init_from_stream.html" title="Function template init_from_stream"> 10<link rel="next" href="basic_settings_section.html" title="Class template basic_settings_section"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td></tr></table> 14<hr> 15<div class="spirit-nav"> 16<a accesskey="p" href="init_from_stream.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.setup.settings_hpp"><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="basic_settings_section.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 17</div> 18<div class="refentry"> 19<a name="boost.log.basic_settings"></a><div class="titlepage"></div> 20<div class="refnamediv"> 21<h2><span class="refentrytitle">Class template basic_settings</span></h2> 22<p>boost::log::basic_settings — The class represents settings container. </p> 23</div> 24<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 25<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../utilities.html#header.boost.log.utility.setup.settings_hpp" title="Header <boost/log/utility/setup/settings.hpp>">boost/log/utility/setup/settings.hpp</a>> 26 27</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">></span> 28<span class="keyword">class</span> <a class="link" href="basic_settings.html" title="Class template basic_settings">basic_settings</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">log</span><span class="special">::</span><span class="identifier">basic_settings_section</span><span class="special"><</span> <span class="identifier">CharT</span> <span class="special">></span> <span class="special">{</span> 29<span class="keyword">public</span><span class="special">:</span> 30 <span class="comment">// types</span> 31 <span class="keyword">typedef</span> <a class="link" href="basic_settings_section.html" title="Class template basic_settings_section">basic_settings_section</a><span class="special"><</span> <span class="identifier">CharT</span> <span class="special">></span> <a name="boost.log.basic_settings.section"></a><span class="identifier">section</span><span class="special">;</span> <span class="comment">// Section type. </span> 32 <span class="keyword">typedef</span> <span class="identifier">section</span><span class="special">::</span><span class="identifier">property_tree_type</span> <a name="boost.log.basic_settings.property_tree_type"></a><span class="identifier">property_tree_type</span><span class="special">;</span> <span class="comment">// Property tree type. </span> 33 34 <span class="comment">// <a class="link" href="basic_settings.html#boost.log.basic_settingsconstruct-copy-destruct">construct/copy/destruct</a></span> 35 <a class="link" href="basic_settings.html#idm46079572956160-bb"><span class="identifier">basic_settings</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 36 <a class="link" href="basic_settings.html#idm46079572955408-bb"><span class="identifier">basic_settings</span></a><span class="special">(</span><a class="link" href="basic_settings.html" title="Class template basic_settings">basic_settings</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 37 <a class="link" href="basic_settings.html#idm46079572953728-bb"><span class="identifier">basic_settings</span></a><span class="special">(</span>this_type <span class="special">&&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 38 <span class="keyword">explicit</span> <a class="link" href="basic_settings.html#idm46079572951776-bb"><span class="identifier">basic_settings</span></a><span class="special">(</span><span class="identifier">property_tree_type</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 39 <a class="link" href="basic_settings.html" title="Class template basic_settings">basic_settings</a> <span class="special">&</span> <a class="link" href="basic_settings.html#idm46079572949312-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_settings.html" title="Class template basic_settings">basic_settings</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 40 <a class="link" href="basic_settings.html" title="Class template basic_settings">basic_settings</a> <span class="special">&</span> <a class="link" href="basic_settings.html#idm46079572947040-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_settings.html" title="Class template basic_settings">basic_settings</a> <span class="special">&&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 41 <a class="link" href="basic_settings.html#idm46079572950016-bb"><span class="special">~</span><span class="identifier">basic_settings</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 42<span class="special">}</span><span class="special">;</span></pre></div> 43<div class="refsect1"> 44<a name="idm44984850138400"></a><h2>Description</h2> 45<p>All settings are presented as a number of named parameters divided into named sections. The parameters values are stored as strings. Individual parameters may be queried via subscript operators, like this:</p> 46<p><code class="computeroutput"><pre class="programlisting"> 47<span class="identifier">optional</span><span class="special"><</span> <span class="identifier">string</span> <span class="special">></span> <span class="identifier">param</span> <span class="special">=</span> <span class="identifier">settings</span><span class="special">[</span><span class="string">"Section1"</span><span class="special">]</span><span class="special">[</span><span class="string">"Param1"</span><span class="special">]</span><span class="special">;</span> <span class="comment">// reads parameter "Param1" in section "Section1"</span> 48 <span class="comment">// returns an empty value if no such parameter exists</span> 49<span class="identifier">settings</span><span class="special">[</span><span class="string">"Section2"</span><span class="special">]</span><span class="special">[</span><span class="string">"Param2"</span><span class="special">]</span> <span class="special">=</span> <span class="number">10</span><span class="special">;</span> <span class="comment">// sets the parameter "Param2" in section "Section2"</span> 50 <span class="comment">// to value "10"</span> 51</pre></code></p> 52<p>There are also other methods to work with parameters. </p> 53<div class="refsect2"> 54<a name="idm44984850119072"></a><h3> 55<a name="boost.log.basic_settingsconstruct-copy-destruct"></a><code class="computeroutput">basic_settings</code> 56 public 57 construct/copy/destruct</h3> 58<div class="orderedlist"><ol class="orderedlist" type="1"> 59<li class="listitem"> 60<pre class="literallayout"><a name="idm46079572956160-bb"></a><span class="identifier">basic_settings</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 61<p>Default constructor. Creates an empty settings container. </p> 62</li> 63<li class="listitem"> 64<pre class="literallayout"><a name="idm46079572955408-bb"></a><span class="identifier">basic_settings</span><span class="special">(</span><a class="link" href="basic_settings.html" title="Class template basic_settings">basic_settings</a> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span><span class="special">;</span></pre> 65<p>Copy constructor. </p> 66</li> 67<li class="listitem"> 68<pre class="literallayout"><a name="idm46079572953728-bb"></a><span class="identifier">basic_settings</span><span class="special">(</span>this_type <span class="special">&&</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 69<p>Move constructor. </p> 70</li> 71<li class="listitem"> 72<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46079572951776-bb"></a><span class="identifier">basic_settings</span><span class="special">(</span><span class="identifier">property_tree_type</span> <span class="keyword">const</span> <span class="special">&</span> tree<span class="special">)</span><span class="special">;</span></pre> 73<p>Initializing constructor. Creates a settings container with the copy of the specified property tree. </p> 74</li> 75<li class="listitem"> 76<pre class="literallayout"><a class="link" href="basic_settings.html" title="Class template basic_settings">basic_settings</a> <span class="special">&</span> <a name="idm46079572949312-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_settings.html" title="Class template basic_settings">basic_settings</a> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span><span class="special">;</span></pre> 77<p>Copy assignment operator. </p> 78</li> 79<li class="listitem"> 80<pre class="literallayout"><a class="link" href="basic_settings.html" title="Class template basic_settings">basic_settings</a> <span class="special">&</span> <a name="idm46079572947040-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_settings.html" title="Class template basic_settings">basic_settings</a> <span class="special">&&</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 81<p>Move assignment operator. </p> 82</li> 83<li class="listitem"> 84<pre class="literallayout"><a name="idm46079572950016-bb"></a><span class="special">~</span><span class="identifier">basic_settings</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 85<p>Destructor </p> 86</li> 87</ol></div> 88</div> 89</div> 90</div> 91<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 92<td align="left"></td> 93<td align="right"><div class="copyright-footer">Copyright © 2007-2019 Andrey Semashev<p> 94 Distributed under the Boost Software License, Version 1.0. (See accompanying 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 </p> 97</div></td> 98</tr></table> 99<hr> 100<div class="spirit-nav"> 101<a accesskey="p" href="init_from_stream.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.setup.settings_hpp"><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="basic_settings_section.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 102</div> 103</body> 104</html> 105
