diff options
Diffstat (limited to 'doc/html/boost/program_options/variable_value.html')
| -rw-r--r-- | doc/html/boost/program_options/variable_value.html | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/doc/html/boost/program_options/variable_value.html b/doc/html/boost/program_options/variable_value.html index f9dcd48ceb..40f192473d 100644 --- a/doc/html/boost/program_options/variable_value.html +++ b/doc/html/boost/program_options/variable_value.html @@ -6,8 +6,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>"> -<link rel="prev" href="bool_switch.html" title="Function bool_switch"> -<link rel="next" href="abstract_variables_map.html" title="Class abstract_variables_map"> +<link rel="prev" href="abstract_variables_map.html" title="Class abstract_variables_map"> +<link rel="next" href="variables_map.html" title="Class variables_map"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -20,7 +20,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="bool_switch.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="abstract_variables_map.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="abstract_variables_map.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="variables_map.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.variable_value"></a><div class="titlepage"></div> @@ -35,67 +35,67 @@ <span class="keyword">class</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="variable_value.html#boost.program_options.variable_valueconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="variable_value.html#idp156762112-bb"><span class="identifier">variable_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="variable_value.html#idp156762400-bb"><span class="identifier">variable_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="variable_value.html#idp201929440-bb"><span class="identifier">variable_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="variable_value.html#idp201929728-bb"><span class="identifier">variable_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="variable_value.html#idp150792368-bb">friend functions</a></span> + <span class="comment">// <a class="link" href="variable_value.html#idp96737504-bb">friend functions</a></span> <span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> - <a class="link" href="variable_value.html#idp150792928-bb"><span class="identifier">store</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="variable_value.html#idp96738064-bb"><span class="identifier">store</span></a><span class="special">(</span><span class="keyword">const</span> basic_parsed_options<span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="variable_value.html#idp107695808-bb">public member functions</a></span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp107696368-bb"><span class="identifier">as</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp226556336-bb"><span class="identifier">as</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="variable_value.html#idp153350432-bb"><span class="identifier">empty</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="variable_value.html#idp97094640-bb"><span class="identifier">defaulted</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp206139840-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp156760672-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="variable_value.html#idp154233072-bb">public member functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp154233632-bb"><span class="identifier">as</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp151440624-bb"><span class="identifier">as</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="variable_value.html#idp211237408-bb"><span class="identifier">empty</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="variable_value.html#idp147154160-bb"><span class="identifier">defaulted</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp147155664-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp142377472-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp347587008"></a><h2>Description</h2> +<a name="idp341269776"></a><h2>Description</h2> <p>Class holding value of option. Contains details about how the value is set and allows to conveniently obtain the value. </p> <div class="refsect2"> -<a name="idp347587824"></a><h3> +<a name="idp341270592"></a><h3> <a name="boost.program_options.variable_valueconstruct-copy-destruct"></a><code class="computeroutput">variable_value</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp156762112-bb"></a><span class="identifier">variable_value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp156762400-bb"></a><span class="identifier">variable_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> xv<span class="special">,</span> <span class="keyword">bool</span> xdefaulted<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp201929440-bb"></a><span class="identifier">variable_value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp201929728-bb"></a><span class="identifier">variable_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> xv<span class="special">,</span> <span class="keyword">bool</span> xdefaulted<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp347601920"></a><h3> -<a name="idp150792368-bb"></a><code class="computeroutput">variable_value</code> friend functions</h3> +<a name="idp341284752"></a><h3> +<a name="idp96737504-bb"></a><code class="computeroutput">variable_value</code> friend functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> <pre class="literallayout"><span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> -<a name="idp150792928-bb"></a><span class="identifier">store</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span> options<span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span> m<span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span></pre> +<a name="idp96738064-bb"></a><span class="identifier">store</span><span class="special">(</span><span class="keyword">const</span> basic_parsed_options<span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span> options<span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span> m<span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span></pre> <p>Stores in 'm' all options that are defined in 'options'. If 'm' already has a non-defaulted value of an option, that value is not changed, even if 'options' specify some value. </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp347618000"></a><h3> -<a name="idp107695808-bb"></a><code class="computeroutput">variable_value</code> public member functions</h3> +<a name="idp341300064"></a><h3> +<a name="idp154233072-bb"></a><code class="computeroutput">variable_value</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a name="idp107696368-bb"></a><span class="identifier">as</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a name="idp154233632-bb"></a><span class="identifier">as</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>If stored value if of type T, returns that value. Otherwise, throws boost::bad_any_cast exception. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <span class="special">&</span> <a name="idp226556336-bb"></a><span class="identifier">as</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <span class="special">&</span> <a name="idp151440624-bb"></a><span class="identifier">as</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp153350432-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if no value is stored. </li> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp211237408-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if no value is stored. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp97094640-bb"></a><span class="identifier">defaulted</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp147154160-bb"></a><span class="identifier">defaulted</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns true if the value was not explicitly given, but has default value. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a name="idp206139840-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a name="idp147155664-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the contained value. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a name="idp156760672-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a name="idp142377472-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns the contained value. </p> </li> </ol></div> @@ -112,7 +112,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="bool_switch.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="abstract_variables_map.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="abstract_variables_map.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="variables_map.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |