1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class value_semantic</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<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_id883731.html" title="Class positional_options_description">
<link rel="next" href="value_semantic_codecvt__id980397.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>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="positional_options_desc_id883731.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="value_semantic_codecvt__id980397.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Class value_semantic">
<a name="boost.program_options.value_semantic"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class value_semantic</span></h2>
<p>boost::program_options::value_semantic</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="emphasis"><em>// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>">boost/program_options/value_semantic.hpp</a>>
</em></span>
<span class="bold"><strong>class</strong></span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> {
<span class="bold"><strong>public</strong></span>:
<span class="emphasis"><em>// <a class="link" href="value_semantic.html#boost.program_options.value_semanticconstruct-copy-destruct">construct/copy/destruct</a></em></span>
<a class="link" href="value_semantic.html#id980396-bb">~value_semantic</a>();
<span class="emphasis"><em>// <a class="link" href="value_semantic.html#id946442-bb">public member functions</a></em></span>
<span class="type">std::string</span> <a class="link" href="value_semantic.html#id946445-bb">name</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>unsigned</strong></span></span> <a class="link" href="value_semantic.html#id946457-bb">min_tokens</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>unsigned</strong></span></span> <a class="link" href="value_semantic.html#id946469-bb">max_tokens</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="value_semantic.html#id946480-bb">is_composing</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="value_semantic.html#id946493-bb">is_required</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="value_semantic.html#id946504-bb">parse</a>(boost::any &, <span class="bold"><strong>const</strong></span> std::vector< std::string > &, <span class="bold"><strong>bool</strong></span>) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="value_semantic.html#id984525-bb">apply_default</a>(boost::any &) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="value_semantic.html#id980380-bb">notify</a>(<span class="bold"><strong>const</strong></span> boost::any &) <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id1432643"></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" title="value_semantic public construct/copy/destruct">
<a name="id1432650"></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="id980396-bb"></a>~value_semantic();</pre></li></ol></div>
</div>
<div class="refsect2" title="value_semantic public member functions">
<a name="id1432683"></a><h3>
<a name="id946442-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="type">std::string</span> <a name="id946445-bb"></a>name() <span class="bold"><strong>const</strong></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="type"><span class="bold"><strong>unsigned</strong></span></span> <a name="id946457-bb"></a>min_tokens() <span class="bold"><strong>const</strong></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="type"><span class="bold"><strong>unsigned</strong></span></span> <a name="id946469-bb"></a>max_tokens() <span class="bold"><strong>const</strong></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="type"><span class="bold"><strong>bool</strong></span></span> <a name="id946480-bb"></a>is_composing() <span class="bold"><strong>const</strong></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="type"><span class="bold"><strong>bool</strong></span></span> <a name="id946493-bb"></a>is_required() <span class="bold"><strong>const</strong></span>;</pre>
<p>Returns true if value must be given. Non-optional value </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id946504-bb"></a>parse(boost::any & value_store,
<span class="bold"><strong>const</strong></span> std::vector< std::string > & new_tokens, <span class="bold"><strong>bool</strong></span> utf8) <span class="bold"><strong>const</strong></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="type"><span class="bold"><strong>bool</strong></span></span> <a name="id984525-bb"></a>apply_default(boost::any & value_store) <span class="bold"><strong>const</strong></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="type"><span class="bold"><strong>void</strong></span></span> <a name="id980380-bb"></a>notify(<span class="bold"><strong>const</strong></span> boost::any & value_store) <span class="bold"><strong>const</strong></span>;</pre>
<p>Called when final value of an option is determined. </p>
</li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0.
(See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at
<a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="positional_options_desc_id883731.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="value_semantic_codecvt__id980397.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
