diff options
Diffstat (limited to 'doc/html/boost/program_options/variables_map.html')
-rw-r--r-- | doc/html/boost/program_options/variables_map.html | 90 |
1 files changed, 32 insertions, 58 deletions
diff --git a/doc/html/boost/program_options/variables_map.html b/doc/html/boost/program_options/variables_map.html index 79bdecac59..ceb2bddd26 100644 --- a/doc/html/boost/program_options/variables_map.html +++ b/doc/html/boost/program_options/variables_map.html @@ -3,11 +3,11 @@ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class variables_map</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<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="abstract_variables_map.html" title="Class abstract_variables_map"> -<link rel="next" href="store_id1166357.html" title="Function store"> +<link rel="next" href="store_idp112499504.html" title="Function store"> </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="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="store_id1166357.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="store_idp112499504.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.variables_map"></a><div class="titlepage"></div> @@ -32,89 +32,63 @@ <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="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>">boost/program_options/variables_map.hpp</a>> </span> -<span class="keyword">class</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">abstract_variables_map</span> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">:</span> <span class="keyword">public</span> boost::program_options::abstract_variables_map, + <span class="keyword">public</span> std::map< std::string, variable_value > +<span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="variables_map.html#boost.program_options.variables_mapconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="variables_map.html#id1168712-bb"><span class="identifier">variables_map</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="variables_map.html#id1168713-bb"><span class="identifier">variables_map</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="variables_map.html#idp202958384-bb"><span class="identifier">variables_map</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="variables_map.html#idp202958672-bb"><span class="identifier">variables_map</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="variables_map.html#id1169280-bb">public member functions</a></span> - <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="variables_map.html#id1169283-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="variables_map.html#id1168698-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="variables_map.html#id1168705-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="variables_map.html#idp207787920-bb">public member functions</a></span> + <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="variables_map.html#idp207788448-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="variables_map.html#idp106135936-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="variables_map.html#idp202957376-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="variables_map.html#id1168722-bb">private member functions</a></span> - <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="variables_map.html#id1166301-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="variables_map.html#idp107871088-bb">private member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="variables_map.html#idp107871664-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="variables_map.html#id1166320-bb">friend functions</a></span> + <span class="comment">// <a class="link" href="variables_map.html#idp158262512-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="variables_map.html#id1166322-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="variables_map.html#idp158263072-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="id2587108"></a><h2>Description</h2> +<a name="idp347829840"></a><h2>Description</h2> <p>Concrete variables map which store variables in real map.</p> <p>This class is derived from std::map<std::string, variable_value>, so you can use all map operators to examine its content. </p> <div class="refsect2"> -<a name="id2587124"></a><h3> +<a name="idp347831136"></a><h3> <a name="boost.program_options.variables_mapconstruct-copy-destruct"></a><code class="computeroutput">variables_map</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="id1168712-bb"></a><span class="identifier">variables_map</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="id1168713-bb"></a><span class="identifier">variables_map</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span> next<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp202958384-bb"></a><span class="identifier">variables_map</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp202958672-bb"></a><span class="identifier">variables_map</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span> next<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="id2587218"></a><h3> -<a name="id1169280-bb"></a><code class="computeroutput">variables_map</code> public member functions</h3> +<a name="idp347843008"></a><h3> +<a name="idp207787920-bb"></a><code class="computeroutput">variables_map</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="id1169283-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Obtains the value of variable 'name', from *this and possibly from the chain of variable maps.</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> -<p>if there's no value in *this.</p> -<div class="itemizedlist"><ul class="itemizedlist" type="circle"> -<li class="listitem"><p>if there's next variable map, returns value from it</p></li> -<li class="listitem"><p>otherwise, returns empty value</p></li> -</ul></div> -<p> -</p> -</li></ul></div> -<p> -</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> -<p>if there's defaulted value</p> -<div class="itemizedlist"><ul class="itemizedlist" type="circle"> -<li class="listitem"><p>if there's next varaible map, which has a non-defauled value, return that</p></li> -<li class="listitem"><p>otherwise, return value from *this</p></li> -</ul></div> -<p> -</p> -</li></ul></div> -<p> -</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>if there's a non-defauled value, returns it. </p></li></ul></div> -<p> -</p> -</li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id1168698-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id1168705-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="idp207788448-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp106135936-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp202957376-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="id2587443"></a><h3> -<a name="id1168722-bb"></a><code class="computeroutput">variables_map</code> private member functions</h3> +<a name="idp347864464"></a><h3> +<a name="idp107871088-bb"></a><code class="computeroutput">variables_map</code> private member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="id1166301-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="idp107871664-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Implementation of abstract_variables_map::get which does 'find' in *this. </p> </li></ol></div> </div> <div class="refsect2"> -<a name="id2587543"></a><h3> -<a name="id1166320-bb"></a><code class="computeroutput">variables_map</code> friend functions</h3> +<a name="idp347877248"></a><h3> +<a name="idp158262512-bb"></a><code class="computeroutput">variables_map</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="id1166322-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> xm<span class="special">,</span> +<a name="idp158263072-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> xm<span class="special">,</span> <span class="keyword">bool</span> utf8<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> @@ -131,7 +105,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<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="store_id1166357.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="store_idp112499504.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |