diff options
| author | nobody <nobody@localhost> | 2005-12-05 14:04:06 +0000 |
|---|---|---|
| committer | nobody <nobody@localhost> | 2005-12-05 14:04:06 +0000 |
| commit | c822d41b96b5920e6ce9609138122f07015e678d (patch) | |
| tree | cd74172648c61565baaadfa8c00b80b862b377b6 /doc/html/abstract_variables_map.html | |
| parent | ce5e16b6ae28e66369cdcfc6c416db64fd0298ba (diff) | |
| parent | 9c74a4ecc721ad2636d9f22a4be43f307aac7942 (diff) | |
| download | boost-c822d41b96b5920e6ce9609138122f07015e678d.tar.gz | |
This commit was manufactured by cvs2svn to create tag
'Version_1_33_1'.
[SVN r31916]
Diffstat (limited to 'doc/html/abstract_variables_map.html')
| -rw-r--r-- | doc/html/abstract_variables_map.html | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/doc/html/abstract_variables_map.html b/doc/html/abstract_variables_map.html new file mode 100644 index 0000000000..076984a5c3 --- /dev/null +++ b/doc/html/abstract_variables_map.html @@ -0,0 +1,107 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>Class abstract_variables_map</title> +<link rel="stylesheet" href="boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +<link rel="start" href="index.html" title="The Boost C++ Libraries"> +<link rel="up" href="program_options/reference.html#id2524541" title="Header <boost/program_options/variables_map.hpp>"> +<link rel="prev" href="variable_value.html" title="Class variable_value"> +<link rel="next" href="variables_map.html" title="Class variables_map"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td> +<td align="center"><a href="../../index.htm">Home</a></td> +<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../people/people.htm">People</a></td> +<td align="center"><a href="../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="variable_value.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id2524541"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="variables_map.html"><img src="images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="abstract_variables_map"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class abstract_variables_map</span></h2> +<p>boost::program_options::abstract_variables_map — </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="bold"><strong>class</strong></span> abstract_variables_map { +<span class="bold"><strong>public</strong></span>: + <span class="emphasis"><em>// <a href="abstract_variables_map.html#abstract_variables_mapconstruct-copy-destruct">construct/copy/destruct</a></em></span> + <a href="abstract_variables_map.html#id2363244-bb">abstract_variables_map</a>(); + <a href="abstract_variables_map.html#id2363247-bb">abstract_variables_map</a>(<span class="bold"><strong>const</strong></span> <a href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> *); + <a href="abstract_variables_map.html#id2434664-bb">~abstract_variables_map</a>(); + + <span class="emphasis"><em>// <a href="abstract_variables_map.html#id2517131-bb">public member functions</a></em></span> + <span class="type"><span class="bold"><strong>const</strong></span> <a href="variable_value.html" title="Class variable_value">variable_value</a> &</span> <a href="abstract_variables_map.html#id2517135-bb"><span class="bold"><strong>operator</strong></span>[]</a>(<span class="bold"><strong>const</strong></span> std::string &) <span class="bold"><strong>const</strong></span>; + <span class="type"><span class="bold"><strong>void</strong></span></span> <a href="abstract_variables_map.html#id2373603-bb">next</a>(<a href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> *) ; + + <span class="emphasis"><em>// <a href="abstract_variables_map.html#id2434666-bb">private member functions</a></em></span> + <span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>const</strong></span> <a href="variable_value.html" title="Class variable_value">variable_value</a> &</span> <a href="abstract_variables_map.html#id2434670-bb">get</a>(<span class="bold"><strong>const</strong></span> std::string &) <span class="bold"><strong>const</strong></span>; +};</pre></div> +<div class="refsect1" lang="en"> +<a name="id2729003"></a><h2>Description</h2> +<p>Implements string->string mapping with convenient value casting facilities. </p> +<div class="refsect2" lang="en"> +<a name="id2729012"></a><h3> +<a name="abstract_variables_mapconstruct-copy-destruct"></a><code class="computeroutput">abstract_variables_map</code> construct/copy/destruct</h3> +<div class="orderedlist"><ol type="1"> +<li><pre class="literallayout"><a name="id2363244-bb"></a>abstract_variables_map();</pre></li> +<li><pre class="literallayout"><a name="id2363247-bb"></a>abstract_variables_map(<span class="bold"><strong>const</strong></span> <a href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> * next);</pre></li> +<li><pre class="literallayout"><a name="id2434664-bb"></a>~abstract_variables_map();</pre></li> +</ol></div> +</div> +<div class="refsect2" lang="en"> +<a name="id2729088"></a><h3> +<a name="id2517131-bb"></a><code class="computeroutput">abstract_variables_map</code> public member functions</h3> +<div class="orderedlist"><ol type="1"> +<li> +<pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <a href="variable_value.html" title="Class variable_value">variable_value</a> &</span> <a name="id2517135-bb"></a><span class="bold"><strong>operator</strong></span>[](<span class="bold"><strong>const</strong></span> std::string & name) <span class="bold"><strong>const</strong></span>;</pre> +<p>Obtains the value of variable 'name', from *this and possibly from the chain of variable maps.</p> +<div class="itemizedlist"><ul type="disc"><li> +<p>if there's no value in *this.</p> +<div class="itemizedlist"><ul type="circle"> +<li><p>if there's next variable map, returns value from it</p></li> +<li><p>otherwise, returns empty value</p></li> +</ul></div> +</li></ul></div> +<div class="itemizedlist"><ul type="disc"><li> +<p>if there's defaulted value</p> +<div class="itemizedlist"><ul type="circle"> +<li><p>if there's next varaible map, which has a non-defauled value, return that</p></li> +<li><p>otherwise, return value from *this</p></li> +</ul></div> +</li></ul></div> +<div class="itemizedlist"><ul type="disc"><li><p>if there's a non-defauled value, returns it. </p></li></ul></div> +</li> +<li> +<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2373603-bb"></a>next(<a href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> * next) ;</pre> +<p>Sets next variable map, which will be used to find variables not found in *this. </p> +</li> +</ol></div> +</div> +<div class="refsect2" lang="en"> +<a name="id2729226"></a><h3> +<a name="id2434666-bb"></a><code class="computeroutput">abstract_variables_map</code> private member functions</h3> +<div class="orderedlist"><ol type="1"><li> +<pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> <span class="bold"><strong>const</strong></span> <a href="variable_value.html" title="Class variable_value">variable_value</a> &</span> <a name="id2434670-bb"></a>get(<span class="bold"><strong>const</strong></span> std::string & name) <span class="bold"><strong>const</strong></span>;</pre> +<p>Returns value of variable 'name' stored in *this, or empty value otherwise. </p> +</li></ol></div> +</div> +</div> +</div> +<table width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2002-2004 Vladimir Prus</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="variable_value.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="program_options/reference.html#id2524541"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="variables_map.html"><img src="images/next.png" alt="Next"></a> +</div> +</body> +</html> |