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
115
116
117
118
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class variable_value</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.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">
</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="bool_switch.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="abstract_variables_map.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Class variable_value">
<a name="boost.program_options.variable_value"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class variable_value</span></h2>
<p>boost::program_options::variable_value</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.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>">boost/program_options/variables_map.hpp</a>>
</em></span>
<span class="bold"><strong>class</strong></span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> {
<span class="bold"><strong>public</strong></span>:
<span class="emphasis"><em>// <a class="link" href="variable_value.html#boost.program_options.variable_valueconstruct-copy-destruct">construct/copy/destruct</a></em></span>
<a class="link" href="variable_value.html#id935118-bb">variable_value</a>();
<a class="link" href="variable_value.html#id935119-bb">variable_value</a>(<span class="bold"><strong>const</strong></span> boost::any &, <span class="bold"><strong>bool</strong></span>);
<span class="emphasis"><em>// <a class="link" href="variable_value.html#id935037-bb">public member functions</a></em></span>
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T> <span class="type"><span class="bold"><strong>const</strong></span> T &</span> <a class="link" href="variable_value.html#id935040-bb">as</a>() <span class="bold"><strong>const</strong></span>;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T> <span class="type">T &</span> <a class="link" href="variable_value.html#id935058-bb">as</a>() ;
<span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="variable_value.html#id935077-bb">empty</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="variable_value.html#id935086-bb">defaulted</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>const</strong></span> boost::any &</span> <a class="link" href="variable_value.html#id935098-bb">value</a>() <span class="bold"><strong>const</strong></span>;
<span class="type">boost::any &</span> <a class="link" href="variable_value.html#id935108-bb">value</a>() ;
<span class="emphasis"><em>// <a class="link" href="variable_value.html#id935130-bb">friend functions</a></em></span>
<span class="type"><span class="bold"><strong>friend</strong></span> BOOST_PROGRAM_OPTIONS_DECL <span class="bold"><strong>void</strong></span></span>
<a class="link" href="variable_value.html#id935133-bb">store</a>(<span class="bold"><strong>const</strong></span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a>< <span class="bold"><strong>char</strong></span> > &, <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> &, <span class="bold"><strong>bool</strong></span>) ;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id1436536"></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" title="variable_value public construct/copy/destruct">
<a name="id1436543"></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="id935118-bb"></a>variable_value();</pre></li>
<li class="listitem"><pre class="literallayout"><a name="id935119-bb"></a>variable_value(<span class="bold"><strong>const</strong></span> boost::any & v, <span class="bold"><strong>bool</strong></span> defaulted);</pre></li>
</ol></div>
</div>
<div class="refsect2" title="variable_value public member functions">
<a name="id1436601"></a><h3>
<a name="id935037-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="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T> <span class="type"><span class="bold"><strong>const</strong></span> T &</span> <a name="id935040-bb"></a>as() <span class="bold"><strong>const</strong></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="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T> <span class="type">T &</span> <a name="id935058-bb"></a>as() ;</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="type"><span class="bold"><strong>bool</strong></span></span> <a name="id935077-bb"></a>empty() <span class="bold"><strong>const</strong></span>;</pre>Returns true if no value is stored. </li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id935086-bb"></a>defaulted() <span class="bold"><strong>const</strong></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="type"><span class="bold"><strong>const</strong></span> boost::any &</span> <a name="id935098-bb"></a>value() <span class="bold"><strong>const</strong></span>;</pre>
<p>Returns the contained value. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type">boost::any &</span> <a name="id935108-bb"></a>value() ;</pre>
<p>Returns the contained value. </p>
</li>
</ol></div>
</div>
<div class="refsect2" title="variable_value friend functions">
<a name="id1436798"></a><h3>
<a name="id935130-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="type"><span class="bold"><strong>friend</strong></span> BOOST_PROGRAM_OPTIONS_DECL <span class="bold"><strong>void</strong></span></span>
<a name="id935133-bb"></a>store(<span class="bold"><strong>const</strong></span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a>< <span class="bold"><strong>char</strong></span> > & options, <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> & m, <span class="bold"><strong>bool</strong></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>
</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="bool_switch.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="abstract_variables_map.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
