1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Property Tree Synopsis</title> 6<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../property_tree.html" title="Chapter 31. Boost.PropertyTree"> 10<link rel="prev" href="container.html" title="Property Tree as a Container"> 11<link rel="next" href="parsers.html" title="How to Populate a Property Tree"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> 16<td align="center"><a href="../../../index.html">Home</a></td> 17<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<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> 25</div> 26<div class="section"> 27<div class="titlepage"><div><div><h2 class="title" style="clear: both"> 28<a name="property_tree.synopsis"></a><a class="link" href="synopsis.html" title="Property Tree Synopsis">Property Tree Synopsis</a> 29</h2></div></div></div> 30<p> 31 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> 32 class template. Instances of this class are property trees. It is parametrized 33 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>, 34 <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> 35 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> 36 using predefined combinations of template parameters. Property tree is basically 37 a somewhat simplified standard container (the closest being std::list), plus 38 a bunch of extra member functions. These functions allow easy and effective 39 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#id-1_3_32_10_7_1_1_1_3_63-bb">get</a></code>, <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id-1_3_32_10_7_1_1_1_3_71-bb">put</a></code>, <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id-1_3_32_10_7_1_1_1_3_53-bb">get_value</a></code>, 40 <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id-1_3_32_10_7_1_1_1_3_61-bb">put_value</a></code>, 41 <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id-1_3_32_10_7_1_1_1_3_45-bb">get_child</a></code>, 42 <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id-1_3_32_10_7_1_1_1_3_51-bb">put_child</a></code>. 43 Additionally, there is a <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html#id-1_3_32_10_7_1_1_1_3_42-bb">data</a></code> 44 function to access node data directly. 45 </p> 46<p> 47 See the <code class="computeroutput"><a class="link" href="../boost/property_tree/basic_ptree.html" title="Class template basic_ptree">basic_ptree class 48 template synopsis</a></code> for more information. 49 </p> 50</div> 51<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 52<td align="left"></td> 53<td align="right"><div class="copyright-footer">Copyright © 2008-2010 Marcin Kalicinski<br>Copyright © 2010-2013 Sebastian 54 Redl<p> 55 Distributed under the Boost Software License, Version 1.0. (See accompanying 56 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>) 57 </p> 58</div></td> 59</tr></table> 60<hr> 61<div class="spirit-nav"> 62<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> 63</div> 64</body> 65</html> 66
