Google Git
Sign in
nest-open-source / nest-learning-thermostat / 5.0 / boost / 317601cb979f96545d0e892ce7cfdf59f676ee0a / . / boost_1_45_0 / doc / html / boost / property_tree / string_path.html
blob: ddee44c86de0e55337796f976e7433a3787bf4be [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template string_path</title>
<link rel="stylesheet" href="../../../../doc/src/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="../../property_tree/reference.html#header.boost.property_tree.string_path_hpp" title="Header &lt;boost/property_tree/string_path.hpp&gt;">
<link rel="prev" href="translator_between_std__id930843.html" title="Struct template translator_between&lt;std::basic_string&lt; Ch, Traits, Alloc &gt;, E&gt;">
<link rel="next" href="path_of_std_basic_strin_id904779.html" title="Struct template path_of&lt;std::basic_string&lt; Ch, Traits, Alloc &gt;&gt;">
</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="translator_between_std__id930843.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.string_path_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="path_of_std_basic_strin_id904779.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.property_tree.string_path"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template string_path</span></h2>
<p>boost::property_tree::string_path &#8212; Default path class. A path is a sequence of values. Groups of values are separated by the separator value, which defaults to '.' cast to the sequence's value type. The group of values is then passed to the translator to get a key. </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="comment">// In header: &lt;<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.string_path_hpp" title="Header &lt;boost/property_tree/string_path.hpp&gt;">boost/property_tree/string_path.hpp</a>&gt;
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> String<span class="special">,</span> <span class="keyword">typename</span> Translator<span class="special">&gt;</span>
<span class="keyword">class</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<span class="keyword">typedef</span> <span class="identifier">Translator</span><span class="special">::</span><span class="identifier">external_type</span> <a name="boost.property_tree.string_path.key_type"></a><span class="identifier">key_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">String</span><span class="special">::</span><span class="identifier">value_type</span> <a name="boost.property_tree.string_path.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>
<span class="comment">// <a class="link" href="string_path.html#boost.property_tree.string_pathconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="string_path.html#id958906-bb"><span class="identifier">string_path</span></a><span class="special">(</span><span class="identifier">char_type</span> <span class="special">=</span> <span class="identifier">char_type</span><span class="special">(</span><span class="char">'.'</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="string_path.html#id958917-bb"><span class="identifier">string_path</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">String</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span> <span class="special">=</span> <span class="identifier">char_type</span><span class="special">(</span><span class="char">'.'</span><span class="special">)</span><span class="special">,</span>
<span class="identifier">Translator</span> <span class="special">=</span> <span class="identifier">Translator</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="string_path.html#id958960-bb"><span class="identifier">string_path</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">char_type</span> <span class="special">=</span> <span class="identifier">char_type</span><span class="special">(</span><span class="char">'.'</span><span class="special">)</span><span class="special">,</span>
<span class="identifier">Translator</span> <span class="special">=</span> <span class="identifier">Translator</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="string_path.html#id989259-bb"><span class="identifier">string_path</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
string_path&amp; <a class="link" href="string_path.html#id904768-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="string_path.html#id930937-bb">private member functions</a></span>
<a class="link" href="string_path.html#id930941-bb"><span class="identifier">BOOST_STATIC_ASSERT</span></a><span class="special">(</span><span class="special">(</span><span class="identifier">is_same</span><span class="special">&lt;</span> <span class="identifier">String</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">::</span><span class="identifier">internal_type</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">s_c_iter</span> <a class="link" href="string_path.html#id930954-bb"><span class="identifier">cstart</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="comment">// <a class="link" href="string_path.html#id930961-bb">public member functions</a></span>
<span class="identifier">key_type</span> <a class="link" href="string_path.html#id930965-bb"><span class="identifier">reduce</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">bool</span> <a class="link" href="string_path.html#id958846-bb"><span class="identifier">empty</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="string_path.html#id958856-bb"><span class="identifier">single</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="string_path.html#id958868-bb"><span class="identifier">dump</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&amp;</span> <a class="link" href="string_path.html#id958875-bb"><span class="keyword">operator</span><span class="special">/=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id2144467"></a><h2>Description</h2>
<p>If instantiated with std::string and id_translator&lt;std::string&gt;, it accepts paths of the form "one.two.three.four".</p>
<p>
</p>
<div class="refsect2">
<a name="id2144482"></a><h3>
<a name="boost.property_tree.string_pathconstruct-copy-destruct"></a><code class="computeroutput">string_path</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="id958906-bb"></a><span class="identifier">string_path</span><span class="special">(</span><span class="identifier">char_type</span> separator <span class="special">=</span> <span class="identifier">char_type</span><span class="special">(</span><span class="char">'.'</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Create an empty path. </li>
<li class="listitem">
<pre class="literallayout"><a name="id958917-bb"></a><span class="identifier">string_path</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">String</span> <span class="special">&amp;</span> value<span class="special">,</span> <span class="identifier">char_type</span> separator <span class="special">=</span> <span class="identifier">char_type</span><span class="special">(</span><span class="char">'.'</span><span class="special">)</span><span class="special">,</span>
<span class="identifier">Translator</span> tr <span class="special">=</span> <span class="identifier">Translator</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Create a path by parsing the given string. <p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">separator</code></span></p></td>
<td><p>The separator used in parsing. Defaults to '.'. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">tr</code></span></p></td>
<td><p>The translator used by this path to convert the individual parts to keys. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">value</code></span></p></td>
<td><p>A sequence, possibly with separators, that describes the path, e.g. "one.two.three". </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><a name="id958960-bb"></a><span class="identifier">string_path</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span> value<span class="special">,</span> <span class="identifier">char_type</span> separator <span class="special">=</span> <span class="identifier">char_type</span><span class="special">(</span><span class="char">'.'</span><span class="special">)</span><span class="special">,</span>
<span class="identifier">Translator</span> tr <span class="special">=</span> <span class="identifier">Translator</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>Create a path by parsing the given string. <p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">separator</code></span></p></td>
<td><p>The separator used in parsing. Defaults to '.'. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">tr</code></span></p></td>
<td><p>The translator used by this path to convert the individual parts to keys. </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">value</code></span></p></td>
<td><p>A zero-terminated array of values. Only use if zero- termination makes sense for your type, and your sequence supports construction from it. Intended for string literals. </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem"><pre class="literallayout"><a name="id989259-bb"></a><span class="identifier">string_path</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&amp;</span> o<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout">string_path&amp; <a name="id904768-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&amp;</span> o<span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
<div class="refsect2">
<a name="id2144984"></a><h3>
<a name="id930937-bb"></a><code class="computeroutput">string_path</code> private member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"> <a name="id930941-bb"></a><span class="identifier">BOOST_STATIC_ASSERT</span><span class="special">(</span><span class="special">(</span><span class="identifier">is_same</span><span class="special">&lt;</span> <span class="identifier">String</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Translator</span><span class="special">::</span><span class="identifier">internal_type</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">s_c_iter</span> <a name="id930954-bb"></a><span class="identifier">cstart</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
</ol></div>
</div>
<div class="refsect2">
<a name="id2145133"></a><h3>
<a name="id930961-bb"></a><code class="computeroutput">string_path</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="identifier">key_type</span> <a name="id930965-bb"></a><span class="identifier">reduce</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Take a single element off the path at the front and return it. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="id958846-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Test if the path is empty. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="id958856-bb"></a><span class="identifier">single</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Test if the path contains a single element, i.e. no separators. </li>
<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id958868-bb"></a><span class="identifier">dump</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&amp;</span> <a name="id958875-bb"></a><span class="keyword">operator</span><span class="special">/=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="string_path.html" title="Class template string_path">string_path</a> <span class="special">&amp;</span> o<span class="special">)</span><span class="special">;</span></pre>Append a second path to this one. <p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Requires:</span></p></td>
<td><p>o's separator is the same as this one's, or o has no separators </p></td>
</tr></tbody>
</table></div>
</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 &#169; 2008 Marcin Kalicinski<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt 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="translator_between_std__id930843.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.string_path_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="path_of_std_basic_strin_id904779.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>