]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | [/ |
2 | / Copyright (c) 2008 Marcin Kalicinski (kalita <at> poczta dot onet dot pl) | |
3 | / Copyright (c) 2009 Sebastian Redl (sebastian dot redl <at> getdesigned dot at) | |
4 | / | |
5 | / Distributed under the Boost Software License, Version 1.0. (See accompanying | |
6 | / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) | |
7 | /] | |
8 | [section:synopsis Property Tree Synopsis] | |
9 | [def __basic_ptree__ [classref boost::property_tree::basic_ptree basic_ptree]] | |
10 | [def __ptree__ [classref boost::property_tree::ptree ptree]] | |
11 | [def __wptree__ [classref boost::property_tree::wptree wptree]] | |
12 | [def __iptree__ [classref boost::property_tree::iptree iptree]] | |
13 | [def __wiptree__ [classref boost::property_tree::wiptree wiptree]] | |
14 | [/ basic_ptree members] | |
15 | [def __ptree_get__ [memberref boost::property_tree::basic_ptree::get get]] | |
16 | [def __ptree_put__ [memberref boost::property_tree::basic_ptree::put put]] | |
17 | [def __ptree_get_value__ [memberref boost::property_tree::basic_ptree::get_value get_value]] | |
18 | [def __ptree_put_value__ [memberref boost::property_tree::basic_ptree::put_value put_value]] | |
19 | [def __ptree_get_child__ [memberref boost::property_tree::basic_ptree::get_child get_child]] | |
20 | [def __ptree_put_child__ [memberref boost::property_tree::basic_ptree::put_child put_child]] | |
21 | [def __ptree_data__ [memberref boost::property_tree::basic_ptree::data data]] | |
22 | The central component of the library is the __basic_ptree__ class template. | |
23 | Instances of this class are property trees. It is parametrized on key and data | |
24 | type, and key comparison policy; __ptree__, __wptree__, __iptree__ and | |
25 | __wiptree__ are typedefs of __basic_ptree__ using predefined combinations of | |
26 | template parameters. Property tree is basically a somewhat simplified standard | |
27 | container (the closest being std::list), plus a bunch of extra member | |
28 | functions. These functions allow easy and effective access to the data stored | |
29 | in property tree. They are various variants of __ptree_get__, __ptree_put__, | |
30 | __ptree_get_value__, __ptree_put_value__, __ptree_get_child__, | |
31 | __ptree_put_child__. Additionally, there is a __ptree_data__ function to access | |
32 | node data directly. | |
33 | ||
34 | See the [classref boost::property_tree::basic_ptree basic_ptree class template synopsis] for more information. | |
35 | [endsect] |