diff options
Diffstat (limited to 'doc/html/boost_propertytree')
| -rw-r--r--[-rwxr-xr-x] | doc/html/boost_propertytree/accessing.html | 84 | ||||
| -rw-r--r--[-rwxr-xr-x] | doc/html/boost_propertytree/container.html | 0 | ||||
| -rw-r--r--[-rwxr-xr-x] | doc/html/boost_propertytree/parsers.html | 4 | ||||
| -rw-r--r--[-rwxr-xr-x] | doc/html/boost_propertytree/synopsis.html | 10 | ||||
| -rw-r--r--[-rwxr-xr-x] | doc/html/boost_propertytree/tutorial.html | 18 |
5 files changed, 58 insertions, 58 deletions
diff --git a/doc/html/boost_propertytree/accessing.html b/doc/html/boost_propertytree/accessing.html index 633c75b1d0..9c10a25db9 100755..100644 --- a/doc/html/boost_propertytree/accessing.html +++ b/doc/html/boost_propertytree/accessing.html @@ -30,23 +30,23 @@ <p> Property tree resembles (almost is) a standard container with value type of <code class="computeroutput"><span class="identifier">pair</span><span class="special"><</span><span class="identifier">string</span><span class="special">,</span> <span class="identifier">ptree</span><span class="special">></span></code>. - It has the usual member functions, such as <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1138604-bb">insert</a></code>, - <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id787886-bb">push_back</a></code>, - <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1144489-bb">find</a></code>, - <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1138672-bb">erase</a></code>, + It has the usual member functions, such as <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1156051-bb">insert</a></code>, + <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1156187-bb">push_back</a></code>, + <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id790275-bb">find</a></code>, + <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1156120-bb">erase</a></code>, etc. These can of course be used to populate and access the tree. For example the following code adds key <code class="computeroutput"><span class="string">"pi"</span></code> with data (almost) equal to mathematical <span class="emphasis"><em>pi</em></span> value: </p> <pre class="programlisting"><code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code> <span class="identifier">pt</span><span class="special">;</span> -<span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id787886-bb">push_back</a></code><span class="special">(</span><code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code><span class="special">::</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#boost.property_tree.basic_ptree.value_type">value_type</a></code><span class="special">(</span><span class="string">"pi"</span><span class="special">,</span> <code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code><span class="special">(</span><span class="string">"3.14159"</span><span class="special">)));</span> +<span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1156187-bb">push_back</a></code><span class="special">(</span><code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code><span class="special">::</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#boost.property_tree.basic_ptree.value_type">value_type</a></code><span class="special">(</span><span class="string">"pi"</span><span class="special">,</span> <code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code><span class="special">(</span><span class="string">"3.14159"</span><span class="special">)));</span> </pre> <p> To find the value of <code class="computeroutput"><span class="identifier">pi</span></code> we might do the following: </p> -<pre class="programlisting"><code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code><span class="special">::</span><code class="computeroutput">const_iterator</code> <span class="identifier">it</span> <span class="special">=</span> <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1144489-bb">find</a></code><span class="special">(</span><span class="string">"pi"</span><span class="special">);</span> -<span class="keyword">double</span> <span class="identifier">pi</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">lexical_cast</span><span class="special"><</span><span class="keyword">double</span><span class="special">>(</span><span class="identifier">it</span><span class="special">-></span><span class="identifier">second</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id788266-bb">data</a></code><span class="special">());</span> +<pre class="programlisting"><code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code><span class="special">::</span><code class="computeroutput">const_iterator</code> <span class="identifier">it</span> <span class="special">=</span> <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id790275-bb">find</a></code><span class="special">(</span><span class="string">"pi"</span><span class="special">);</span> +<span class="keyword">double</span> <span class="identifier">pi</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">lexical_cast</span><span class="special"><</span><span class="keyword">double</span><span class="special">>(</span><span class="identifier">it</span><span class="special">-></span><span class="identifier">second</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1156364-bb">data</a></code><span class="special">());</span> </pre> <p> This looks quite cumbersome, and would be even more so if <code class="computeroutput"><span class="identifier">pi</span></code> @@ -55,13 +55,13 @@ it: </p> <pre class="programlisting"><span class="identifier">ptree</span> <span class="identifier">pt</span><span class="special">;</span> -<span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147557-bb">put</a></code><span class="special">(</span><span class="string">"pi"</span><span class="special">,</span> <span class="number">3.14159</span><span class="special">);</span> <span class="comment">// put double</span> -<span class="keyword">double</span> <span class="identifier">pi</span> <span class="special">=</span> <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code><span class="special"><</span><span class="keyword">double</span><span class="special">>(</span><span class="string">"pi"</span><span class="special">);</span> <span class="comment">// get double</span> +<span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792532-bb">put</a></code><span class="special">(</span><span class="string">"pi"</span><span class="special">,</span> <span class="number">3.14159</span><span class="special">);</span> <span class="comment">// put double</span> +<span class="keyword">double</span> <span class="identifier">pi</span> <span class="special">=</span> <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code><span class="special"><</span><span class="keyword">double</span><span class="special">>(</span><span class="string">"pi"</span><span class="special">);</span> <span class="comment">// get double</span> </pre> <p> It doesn't get simpler than that. Basically, there are 2 families of member - functions, <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code> - and <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147557-bb">put</a></code>, + functions, <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code> + and <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792532-bb">put</a></code>, which allow intuitive access to data stored in the tree (direct children or not). </p> @@ -80,10 +80,10 @@ </p> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> - The throwing version (<code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code>): + The throwing version (<code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code>): <pre class="programlisting"><code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code> <span class="identifier">pt</span><span class="special">;</span> <span class="comment">/* ... */</span> -<span class="keyword">float</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code><span class="special"><</span><span class="keyword">float</span><span class="special">>(</span><span class="string">"a.path.to.float.value"</span><span class="special">);</span> +<span class="keyword">float</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code><span class="special"><</span><span class="keyword">float</span><span class="special">>(</span><span class="string">"a.path.to.float.value"</span><span class="special">);</span> </pre> This call locates the proper node in the tree and tries to translate its data string to a float value. If that fails, exception is thrown. If path @@ -93,10 +93,10 @@ to make common handling possible. </li> <li class="listitem"> - The default-value version (<code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code>): + The default-value version (<code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code>): <pre class="programlisting"><code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code> <span class="identifier">pt</span><span class="special">;</span> <span class="comment">/* ... */</span> -<span class="keyword">float</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code><span class="special">(</span><span class="string">"a.path.to.float.value"</span><span class="special">,</span> <span class="special">-</span><span class="number">1.f</span><span class="special">);</span> +<span class="keyword">float</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code><span class="special">(</span><span class="string">"a.path.to.float.value"</span><span class="special">,</span> <span class="special">-</span><span class="number">1.f</span><span class="special">);</span> </pre> It will do the same as above, but if it fails, it will return the default value specified by second parameter (here -1.f) instead of throwing. This @@ -105,10 +105,10 @@ not necessary here, because type is determined by the default value parameter. </li> <li class="listitem"> - The optional version (<code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147485-bb">get_optional</a></code>): + The optional version (<code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792460-bb">get_optional</a></code>): <pre class="programlisting"><code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code> <span class="identifier">pt</span><span class="special">;</span> <span class="comment">/* ... */</span> -<span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span><span class="keyword">float</span><span class="special">></span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147485-bb">get_optional</a></code><span class="special"><</span><span class="keyword">float</span><span class="special">>(</span><span class="string">"a.path.to.float.value"</span><span class="special">);</span> +<span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span><span class="keyword">float</span><span class="special">></span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792460-bb">get_optional</a></code><span class="special"><</span><span class="keyword">float</span><span class="special">>(</span><span class="string">"a.path.to.float.value"</span><span class="special">);</span> </pre> This version uses boost::optional class to handle extraction failure. On successful extraction, it will return boost::optional initialized with @@ -116,12 +116,12 @@ </li> </ol></div> <p> - To retrieve a value from this tree (not some subkey), use <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id788575-bb">get_value</a></code>, - <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id788575-bb">get_value</a></code> - (default-value version), and <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id788783-bb">get_value_optional</a></code>. - They have identical semantics to <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code> + To retrieve a value from this tree (not some subkey), use <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1164680-bb">get_value</a></code>, + <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1164680-bb">get_value</a></code> + (default-value version), and <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801228-bb">get_value_optional</a></code>. + They have identical semantics to <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code> functions, except they don't take the <code class="computeroutput"><a class="link" href="../boost/property_tree/string_path.html" title="Class template string_path">path</a></code> - parameter. Don't call <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code> + parameter. Don't call <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code> with and empty <code class="computeroutput"><a class="link" href="../boost/property_tree/string_path.html" title="Class template string_path">path</a></code> to do this as it will try to extract contents of subkey with empty name. </p> @@ -137,8 +137,8 @@ <span class="identifier">pt</span><span class="special">.</span><span class="identifier">get_optional</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="identifier">path</span><span class="special">(</span><span class="string">"p.a.t.h/t.o/v.a.l.u.e"</span><span class="special">,</span> <span class="char">'/'</span><span class="special">));</span> </pre> <p> - Note: the special overloads of <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code> - and <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147485-bb">get_optional</a></code> + Note: the special overloads of <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code> + and <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792460-bb">get_optional</a></code> taking a separator character that existed in pre-release versions of PropertyTree have been removed. This is because the overloads conflicted with using per-call data translators. @@ -149,46 +149,46 @@ Ways of Putting Data</a> </h4> <p> - To complement <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code>, - there are <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147557-bb">put</a></code> - and <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1076636-bb">add</a></code>. - Contrary to <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code>, + To complement <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code>, + there are <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792532-bb">put</a></code> + and <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792632-bb">add</a></code>. + Contrary to <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code>, they have only one variant each. This is because there is no need to deal with missing values when adding data. If the supplied value cannot be converted to the tree's data type, the functions will throw <code class="computeroutput"><a class="link" href="../boost/property_tree/ptree_bad_data.html" title="Class ptree_bad_data">ptree_bad_data</a></code>. </p> <pre class="programlisting"><code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code> <span class="identifier">pt</span><span class="special">;</span> -<span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147557-bb">put</a></code><span class="special">(</span><span class="string">"a.path.to.float.value"</span><span class="special">,</span> <span class="number">3.14f</span><span class="special">);</span> +<span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792532-bb">put</a></code><span class="special">(</span><span class="string">"a.path.to.float.value"</span><span class="special">,</span> <span class="number">3.14f</span><span class="special">);</span> <span class="comment">// Overwrites the value</span> -<span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147557-bb">put</a></code><span class="special">(</span><span class="string">"a.path.to.float.value"</span><span class="special">,</span> <span class="number">2.72f</span><span class="special">);</span> +<span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792532-bb">put</a></code><span class="special">(</span><span class="string">"a.path.to.float.value"</span><span class="special">,</span> <span class="number">2.72f</span><span class="special">);</span> <span class="comment">// Adds a second node with the new value.</span> -<span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1076636-bb">add</a></code><span class="special">(</span><span class="string">"a.path.to.float.value"</span><span class="special">,</span> <span class="number">3.14f</span><span class="special">);</span> +<span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792632-bb">add</a></code><span class="special">(</span><span class="string">"a.path.to.float.value"</span><span class="special">,</span> <span class="number">3.14f</span><span class="special">);</span> </pre> <p> - Calling <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147557-bb">put</a></code> - will insert a new value at specified path, so that a call to <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code> - specifying the same path will retrieve it. Further, <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147557-bb">put</a></code> + Calling <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792532-bb">put</a></code> + will insert a new value at specified path, so that a call to <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code> + specifying the same path will retrieve it. Further, <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792532-bb">put</a></code> will insert any missing path elements during path traversal. For example, calling - <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147557-bb">put</a><span class="special">(</span><span class="string">"key1.key2.key3"</span><span class="special">,</span> <span class="number">3.14f</span><span class="special">)</span></code> + <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792532-bb">put</a><span class="special">(</span><span class="string">"key1.key2.key3"</span><span class="special">,</span> <span class="number">3.14f</span><span class="special">)</span></code> on an empty tree will insert three new children: <code class="computeroutput"><span class="identifier">key1</span></code>, <code class="computeroutput"><span class="identifier">key1</span><span class="special">.</span><span class="identifier">key2</span></code> and <code class="computeroutput"><span class="identifier">key1</span><span class="special">.</span><span class="identifier">key2</span><span class="special">.</span><span class="identifier">key3</span></code>. The last one will receive a string <code class="computeroutput"><span class="string">"3.14"</span></code> as data, while - the two former ones will have empty data strings. <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147557-bb">put</a></code> + the two former ones will have empty data strings. <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792532-bb">put</a></code> always inserts new keys at the back of the existing sequences. The difference - between <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147557-bb">put</a></code> - and <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1076636-bb">add</a></code> + between <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792532-bb">put</a></code> + and <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792632-bb">add</a></code> is that put will overwrite existing values if there are any, while add will create a new node to hold the value even if the specified path references an existing node. </p> <p> - Similar to <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id788575-bb">get_value</a></code>, - there is also a <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id788842-bb">put_value</a></code> - function. It does the same for this property tree what <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147557-bb">put</a></code> + Similar to <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1164680-bb">get_value</a></code>, + there is also a <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801286-bb">put_value</a></code> + function. It does the same for this property tree what <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792532-bb">put</a></code> does for its children. Thus, it does not receive a <code class="computeroutput"><a class="link" href="../boost/property_tree/string_path.html" title="Class template string_path">path</a></code>: </p> <pre class="programlisting"><code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code> <span class="identifier">pt</span><span class="special">;</span> -<span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id788842-bb">put_value</a></code><span class="special">(</span><span class="number">3.14f</span><span class="special">);</span> +<span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801286-bb">put_value</a></code><span class="special">(</span><span class="number">3.14f</span><span class="special">);</span> </pre> <p> There is no add_value function. diff --git a/doc/html/boost_propertytree/container.html b/doc/html/boost_propertytree/container.html index 7fa7918e53..7fa7918e53 100755..100644 --- a/doc/html/boost_propertytree/container.html +++ b/doc/html/boost_propertytree/container.html diff --git a/doc/html/boost_propertytree/parsers.html b/doc/html/boost_propertytree/parsers.html index eab43dce72..1e5beeb89a 100755..100644 --- a/doc/html/boost_propertytree/parsers.html +++ b/doc/html/boost_propertytree/parsers.html @@ -64,8 +64,8 @@ the global one. </p> <p> - XML / property tree conversion schema (<code class="computeroutput"><a class="link" href="../boost/property_tree/xml_parser/read_xml_id1145781.html" title="Function template read_xml">read_xml</a></code> - and <code class="computeroutput"><a class="link" href="../boost/property_tree/xml_parser/write_xml_id1154593.html" title="Function template write_xml">write_xml</a></code>): + XML / property tree conversion schema (<code class="computeroutput"><a class="link" href="../boost/property_tree/xml_parser/read_xml_id1161432.html" title="Function template read_xml">read_xml</a></code> + and <code class="computeroutput"><a class="link" href="../boost/property_tree/xml_parser/write_xml_id1168786.html" title="Function template write_xml">write_xml</a></code>): </p> <div class="itemizedlist"><ul class="itemizedlist" type="disc"> <li class="listitem"> diff --git a/doc/html/boost_propertytree/synopsis.html b/doc/html/boost_propertytree/synopsis.html index ca3ca4a379..ec895b3fdf 100755..100644 --- a/doc/html/boost_propertytree/synopsis.html +++ b/doc/html/boost_propertytree/synopsis.html @@ -35,11 +35,11 @@ using predefined combinations of template parameters. Property tree is basically a somewhat simplified standard container (the closest being std::list), plus a bunch of extra member functions. These functions allow easy and effective - access to the data stored in property tree. They are various variants of <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code>, <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147557-bb">put</a></code>, <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id788575-bb">get_value</a></code>, - <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id788842-bb">put_value</a></code>, - <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id788302-bb">get_child</a></code>, - <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id788484-bb">put_child</a></code>. - Additionally, there is a <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id788266-bb">data</a></code> + access to the data stored in property tree. They are various variants of <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code>, <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792532-bb">put</a></code>, <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1164680-bb">get_value</a></code>, + <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801286-bb">put_value</a></code>, + <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1156400-bb">get_child</a></code>, + <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1164589-bb">put_child</a></code>. + Additionally, there is a <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1156364-bb">data</a></code> function to access node data directly. </p> <p> diff --git a/doc/html/boost_propertytree/tutorial.html b/doc/html/boost_propertytree/tutorial.html index 3c252117c2..851b2e7a77 100755..100644 --- a/doc/html/boost_propertytree/tutorial.html +++ b/doc/html/boost_propertytree/tutorial.html @@ -78,14 +78,14 @@ <span class="comment">// Load the XML file into the property tree. If reading fails</span> <span class="comment">// (cannot open file, parse error), an exception is thrown.</span> - <code class="computeroutput"><a class="link" href="../boost/property_tree/xml_parser/read_xml_id1145781.html" title="Function template read_xml">read_xml</a></code><span class="special">(</span><span class="identifier">filename</span><span class="special">,</span> <span class="identifier">pt</span><span class="special">);</span> + <code class="computeroutput"><a class="link" href="../boost/property_tree/xml_parser/read_xml_id1161432.html" title="Function template read_xml">read_xml</a></code><span class="special">(</span><span class="identifier">filename</span><span class="special">,</span> <span class="identifier">pt</span><span class="special">);</span> <span class="comment">// Get the filename and store it in the m_file variable.</span> <span class="comment">// Note that we construct the path to the value by separating</span> <span class="comment">// the individual keys with dots. If dots appear in the keys,</span> <span class="comment">// a path type with a different separator can be used.</span> <span class="comment">// If the debug.filename key is not found, an exception is thrown.</span> - <span class="identifier">m_file</span> <span class="special">=</span> <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">>(</span><span class="string">"debug.filename"</span><span class="special">);</span> + <span class="identifier">m_file</span> <span class="special">=</span> <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">>(</span><span class="string">"debug.filename"</span><span class="special">);</span> <span class="comment">// Get the debug level and store it in the m_level variable.</span> <span class="comment">// This is another version of the get method: if the value is</span> @@ -93,7 +93,7 @@ <span class="comment">// parameter) is returned instead. The type of the value</span> <span class="comment">// extracted is determined by the type of the second parameter,</span> <span class="comment">// so we can simply write get(...) instead of get<int>(...).</span> - <span class="identifier">m_level</span> <span class="special">=</span> <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1141165-bb">get</a></code><span class="special">(</span><span class="string">"debug.level"</span><span class="special">,</span> <span class="number">0</span><span class="special">);</span> + <span class="identifier">m_level</span> <span class="special">=</span> <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id801360-bb">get</a></code><span class="special">(</span><span class="string">"debug.level"</span><span class="special">,</span> <span class="number">0</span><span class="special">);</span> <span class="comment">// Iterate over the debug.modules section and store all found</span> <span class="comment">// modules in the m_modules set. The get_child() function</span> @@ -101,8 +101,8 @@ <span class="comment">// there is no such child, it throws. Property tree iterators</span> <span class="comment">// are models of BidirectionalIterator.</span> <span class="identifier">BOOST_FOREACH</span><span class="special">(</span><code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code><span class="special">::</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#boost.property_tree.basic_ptree.value_type">value_type</a></code> <span class="special">&</span><span class="identifier">v</span><span class="special">,</span> - <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id788302-bb">get_child</a></code><span class="special">(</span><span class="string">"debug.modules"</span><span class="special">))</span> - <span class="identifier">m_modules</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1138604-bb">insert</a></code><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">second</span><span class="special">.</span><span class="identifier">data</span><span class="special">());</span> + <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1156400-bb">get_child</a></code><span class="special">(</span><span class="string">"debug.modules"</span><span class="special">))</span> + <span class="identifier">m_modules</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1156051-bb">insert</a></code><span class="special">(</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">second</span><span class="special">.</span><span class="identifier">data</span><span class="special">());</span> <span class="special">}</span> </pre> <p> @@ -116,10 +116,10 @@ <code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code> <span class="identifier">pt</span><span class="special">;</span> <span class="comment">// Put log filename in property tree</span> - <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147557-bb">put</a></code><span class="special">(</span><span class="string">"debug.filename"</span><span class="special">,</span> <span class="identifier">m_file</span><span class="special">);</span> + <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792532-bb">put</a></code><span class="special">(</span><span class="string">"debug.filename"</span><span class="special">,</span> <span class="identifier">m_file</span><span class="special">);</span> <span class="comment">// Put debug level in property tree</span> - <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1147557-bb">put</a></code><span class="special">(</span><span class="string">"debug.level"</span><span class="special">,</span> <span class="identifier">m_level</span><span class="special">);</span> + <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792532-bb">put</a></code><span class="special">(</span><span class="string">"debug.level"</span><span class="special">,</span> <span class="identifier">m_level</span><span class="special">);</span> <span class="comment">// Iterate over the modules in the set and put them in the</span> <span class="comment">// property tree. Note that the put function places the new</span> @@ -129,10 +129,10 @@ <span class="comment">// be achieved using a combination of the insert and put_own</span> <span class="comment">// functions.</span> <span class="identifier">BOOST_FOREACH</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="identifier">name</span><span class="special">,</span> <span class="identifier">m_modules</span><span class="special">)</span> - <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id1076636-bb">add</a></code><span class="special">(</span><span class="string">"debug.modules.module"</span><span class="special">,</span> <span class="identifier">name</span><span class="special">);</span> + <span class="identifier">pt</span><span class="special">.</span><code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id792632-bb">add</a></code><span class="special">(</span><span class="string">"debug.modules.module"</span><span class="special">,</span> <span class="identifier">name</span><span class="special">);</span> <span class="comment">// Write the property tree to the XML file.</span> - <code class="computeroutput"><a class="link" href="../boost/property_tree/xml_parser/write_xml_id1154593.html" title="Function template write_xml">write_xml</a></code><span class="special">(</span><span class="identifier">filename</span><span class="special">,</span> <span class="identifier">pt</span><span class="special">);</span> + <code class="computeroutput"><a class="link" href="../boost/property_tree/xml_parser/write_xml_id1168786.html" title="Function template write_xml">write_xml</a></code><span class="special">(</span><span class="identifier">filename</span><span class="special">,</span> <span class="identifier">pt</span><span class="special">);</span> <span class="special">}</span> </pre> <p> |