diff options
Diffstat (limited to 'doc/html/boost/program_options/variable_value.html')
-rw-r--r--[-rwxr-xr-x] | doc/html/boost/program_options/variable_value.html | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/doc/html/boost/program_options/variable_value.html b/doc/html/boost/program_options/variable_value.html index 07ed201d03..8684686b68 100755..100644 --- a/doc/html/boost/program_options/variable_value.html +++ b/doc/html/boost/program_options/variable_value.html @@ -35,68 +35,68 @@ <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#id1076324-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#id1076325-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#id1159154-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#id1159155-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#id760361-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#id760364-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#id760382-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#id760401-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#id1159368-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#id1159380-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#id1076313-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#id1162650-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#id1162653-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#id1162671-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#id1140663-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#id793437-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#id793449-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#id1159144-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#id1076336-bb">friend functions</a></span> + <span class="comment">// <a class="link" href="variable_value.html#id1159166-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#id1076339-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#id1159169-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> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="id2533304"></a><h2>Description</h2> +<a name="id2584833"></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="id2533311"></a><h3> +<a name="id2584841"></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="id1076324-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="id1076325-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="id1159154-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="id1159155-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="id2533426"></a><h3> -<a name="id760361-bb"></a><code class="computeroutput">variable_value</code> public member functions</h3> +<a name="id2584955"></a><h3> +<a name="id1162650-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="id760364-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="id1162653-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="id760382-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="id1162671-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="id760401-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="id1140663-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="id1159368-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="id793437-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="id1159380-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="id793449-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="id1076313-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="id1159144-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> </div> <div class="refsect2"> -<a name="id2533784"></a><h3> -<a name="id1076336-bb"></a><code class="computeroutput">variable_value</code> friend functions</h3> +<a name="id2585313"></a><h3> +<a name="id1159166-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="id1076339-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="id1159169-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> <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> |