diff options
| author | Anas Nashif <anas.nashif@intel.com> | 2013-08-26 08:15:55 -0400 |
|---|---|---|
| committer | Anas Nashif <anas.nashif@intel.com> | 2013-08-26 08:15:55 -0400 |
| commit | bb4dd8289b351fae6b55e303f189127a394a1edd (patch) | |
| tree | 77c9c35a31b1459dd7988c2448e797d142530c41 /doc/html/boost/program_options/value_semantic.html | |
| parent | 1a78a62555be32868418fe52f8e330c9d0f95d5a (diff) | |
| download | boost-bb4dd8289b351fae6b55e303f189127a394a1edd.tar.gz boost-bb4dd8289b351fae6b55e303f189127a394a1edd.tar.bz2 boost-bb4dd8289b351fae6b55e303f189127a394a1edd.zip | |
Imported Upstream version 1.51.0upstream/1.51.0
Diffstat (limited to 'doc/html/boost/program_options/value_semantic.html')
| -rw-r--r--[-rwxr-xr-x] | doc/html/boost/program_options/value_semantic.html | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/doc/html/boost/program_options/value_semantic.html b/doc/html/boost/program_options/value_semantic.html index 5a3e080ce6..cab8da69a2 100755..100644 --- a/doc/html/boost/program_options/value_semantic.html +++ b/doc/html/boost/program_options/value_semantic.html @@ -6,8 +6,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.76.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.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="positional_options_desc_id1150344.html" title="Class positional_options_description"> -<link rel="next" href="value_semantic_codecvt__id1161963.html" title="Class template value_semantic_codecvt_helper"> +<link rel="prev" href="positional_option_id789522.html" title="Class positional_options_description"> +<link rel="next" href="value_semantic_co_id791934.html" title="Class template value_semantic_codecvt_helper"> </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="positional_options_desc_id1150344.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semantic_codecvt__id1161963.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="positional_option_id789522.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semantic_co_id791934.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.value_semantic"></a><div class="titlepage"></div> @@ -35,63 +35,63 @@ <span class="keyword">class</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="value_semantic.html#boost.program_options.value_semanticconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="value_semantic.html#id1161962-bb"><span class="special">~</span><span class="identifier">value_semantic</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="value_semantic.html#id791933-bb"><span class="special">~</span><span class="identifier">value_semantic</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="value_semantic.html#id1142425-bb">public member functions</a></span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="value_semantic.html#id1142427-bb"><span class="identifier">name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">unsigned</span> <a class="link" href="value_semantic.html#id1142439-bb"><span class="identifier">min_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">unsigned</span> <a class="link" href="value_semantic.html#id1172494-bb"><span class="identifier">max_tokens</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="value_semantic.html#id1172506-bb"><span class="identifier">is_composing</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="value_semantic.html#id1161887-bb"><span class="identifier">is_required</span></a><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="value_semantic.html#id1161898-bb"><span class="identifier">parse</span></a><span class="special">(</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">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</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="special">,</span> <span class="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="value_semantic.html#id1161928-bb"><span class="identifier">apply_default</span></a><span class="special">(</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">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="value_semantic.html#id1161946-bb"><span class="identifier">notify</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">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="value_semantic.html#id788687-bb">public member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="value_semantic.html#id788690-bb"><span class="identifier">name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">unsigned</span> <a class="link" href="value_semantic.html#id788701-bb"><span class="identifier">min_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">unsigned</span> <a class="link" href="value_semantic.html#id1178912-bb"><span class="identifier">max_tokens</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="value_semantic.html#id1155385-bb"><span class="identifier">is_composing</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="value_semantic.html#id791858-bb"><span class="identifier">is_required</span></a><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="value_semantic.html#id791869-bb"><span class="identifier">parse</span></a><span class="special">(</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">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</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="special">,</span> <span class="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="value_semantic.html#id791899-bb"><span class="identifier">apply_default</span></a><span class="special">(</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">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="value_semantic.html#id791917-bb"><span class="identifier">notify</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">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="id2525881"></a><h2>Description</h2> +<a name="id2577262"></a><h2>Description</h2> <p>Class which specifies how the option's value is to be parsed and converted into C++ types. </p> <div class="refsect2"> -<a name="id2525888"></a><h3> +<a name="id2577269"></a><h3> <a name="boost.program_options.value_semanticconstruct-copy-destruct"></a><code class="computeroutput">value_semantic</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="id1161962-bb"></a><span class="special">~</span><span class="identifier">value_semantic</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="id791933-bb"></a><span class="special">~</span><span class="identifier">value_semantic</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> <div class="refsect2"> -<a name="id2525941"></a><h3> -<a name="id1142425-bb"></a><code class="computeroutput">value_semantic</code> public member functions</h3> +<a name="id2577322"></a><h3> +<a name="id788687-bb"></a><code class="computeroutput">value_semantic</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id1142427-bb"></a><span class="identifier">name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id788690-bb"></a><span class="identifier">name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the name of the option. The name is only meaningful for automatic help message. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">unsigned</span> <a name="id1142439-bb"></a><span class="identifier">min_tokens</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">unsigned</span> <a name="id788701-bb"></a><span class="identifier">min_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>The minimum number of tokens for this option that should be present on the command line. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">unsigned</span> <a name="id1172494-bb"></a><span class="identifier">max_tokens</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">unsigned</span> <a name="id1178912-bb"></a><span class="identifier">max_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>The maximum number of tokens for this option that should be present on the command line. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="id1172506-bb"></a><span class="identifier">is_composing</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="id1155385-bb"></a><span class="identifier">is_composing</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns true if values from different sources should be composed. Otherwise, value from the first source is used and values from other sources are discarded. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="id1161887-bb"></a><span class="identifier">is_required</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="id791858-bb"></a><span class="identifier">is_required</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns true if value must be given. Non-optional value </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="id1161898-bb"></a><span class="identifier">parse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <a name="id791869-bb"></a><span class="identifier">parse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">,</span> <span class="keyword">bool</span> utf8<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Parses a group of tokens that specify a value of option. Stores the result in 'value_store', using whatever representation is desired. May be be called several times if value of the same option is specified more than once. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="id1161928-bb"></a><span class="identifier">apply_default</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="id791899-bb"></a><span class="identifier">apply_default</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Called to assign default value to 'value_store'. Returns true if default value is assigned, and false if no default value exists. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="id1161946-bb"></a><span class="identifier">notify</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> value_store<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="id791917-bb"></a><span class="identifier">notify</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> value_store<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Called when final value of an option is determined. </p> </li> </ol></div> @@ -108,7 +108,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="positional_options_desc_id1150344.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semantic_codecvt__id1161963.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="positional_option_id789522.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semantic_co_id791934.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |