<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Property Tree Synopsis</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.html" title="Chapter 14. Boost.PropertyTree">
<link rel="prev" href="container.html" title="Property Tree as a Container">
<link rel="next" href="parsers.html" title="How to Populate a Property Tree">
</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="container.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../property_tree.html"><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="parsers.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_propertytree.synopsis"></a><a class="link" href="synopsis.html" title="Property Tree Synopsis"> Property Tree Synopsis</a>
</h2></div></div></div>
<p>
The central component of the library is the <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html" title="Class template basic_ptree">basic_ptree</a></code>
class template. Instances of this class are property trees. It is parametrized
on key and data type, and key comparison policy; <code class="computeroutput"><a class="link" href="../boost/property_tree/ptree.html" title="Type definition ptree">ptree</a></code>,
<code class="computeroutput"><a class="link" href="../boost/property_tree/wptree.html" title="Type definition wptree">wptree</a></code>, <code class="computeroutput"><a class="link" href="../boost/property_tree/iptree.html" title="Type definition iptree">iptree</a></code> and <code class="computeroutput"><a class="link" href="../boost/property_tree/wiptree.html" title="Type definition wiptree">wiptree</a></code>
are typedefs of <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html" title="Class template basic_ptree">basic_ptree</a></code>
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#id896942-bb">get</a></code>, <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id986372-bb">put</a></code>, <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id896603-bb">get_value</a></code>,
<code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id896869-bb">put_value</a></code>,
<code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id896342-bb">get_child</a></code>,
<code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id896514-bb">put_child</a></code>.
Additionally, there is <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id892788-bb">data</a></code>
function to access node data directly.
</p>
<p>
See the <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html" title="Class template basic_ptree">basic_ptree class
template synopsis</a></code> for more information.
</p>
</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 © 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="container.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../property_tree.html"><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="parsers.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
