<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>UHD: uhd::property_tree Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">UHD
 <span id="projectnumber">003.007.002-0-unknown</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceuhd.html">uhd</a></li><li class="navelem"><a class="el" href="classuhd_1_1property__tree.html">property_tree</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classuhd_1_1property__tree-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uhd::property_tree Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="property__tree_8hpp_source.html">property_tree.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for uhd::property_tree:</div>
<div class="dyncontent">
<div class="center">
<img src="classuhd_1_1property__tree.png" usemap="#uhd::property_tree_map" alt=""/>
<map id="uhd::property_tree_map" name="uhd::property_tree_map">
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aebbee624be5b4c8cd5c590aa60ccbd10"><td class="memItemLeft" align="right" valign="top">typedef boost::shared_ptr<br class="typebreak" />
< <a class="el" href="classuhd_1_1property__tree.html">property_tree</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property__tree.html#aebbee624be5b4c8cd5c590aa60ccbd10">sptr</a></td></tr>
<tr class="separator:aebbee624be5b4c8cd5c590aa60ccbd10"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad369a07c498fb949bc65f91f151d8901"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classuhd_1_1property__tree.html#aebbee624be5b4c8cd5c590aa60ccbd10">sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property__tree.html#ad369a07c498fb949bc65f91f151d8901">subtree</a> (const <a class="el" href="structuhd_1_1fs__path.html">fs_path</a> &path) const =0</td></tr>
<tr class="memdesc:ad369a07c498fb949bc65f91f151d8901"><td class="mdescLeft"> </td><td class="mdescRight">Get a subtree with a new root starting at path. <a href="#ad369a07c498fb949bc65f91f151d8901">More...</a><br /></td></tr>
<tr class="separator:ad369a07c498fb949bc65f91f151d8901"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa810db6efd763cdec797f32dacb9dbb"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property__tree.html#aaa810db6efd763cdec797f32dacb9dbb">remove</a> (const <a class="el" href="structuhd_1_1fs__path.html">fs_path</a> &path)=0</td></tr>
<tr class="memdesc:aaa810db6efd763cdec797f32dacb9dbb"><td class="mdescLeft"> </td><td class="mdescRight">Remove a property or directory (recursive) <a href="#aaa810db6efd763cdec797f32dacb9dbb">More...</a><br /></td></tr>
<tr class="separator:aaa810db6efd763cdec797f32dacb9dbb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc86bc93ee29257873291879cd905dc4"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property__tree.html#adc86bc93ee29257873291879cd905dc4">exists</a> (const <a class="el" href="structuhd_1_1fs__path.html">fs_path</a> &path) const =0</td></tr>
<tr class="memdesc:adc86bc93ee29257873291879cd905dc4"><td class="mdescLeft"> </td><td class="mdescRight">True if the path exists in the tree. <a href="#adc86bc93ee29257873291879cd905dc4">More...</a><br /></td></tr>
<tr class="separator:adc86bc93ee29257873291879cd905dc4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a740cb283e9e65b7ba655a6b010e35d6b"><td class="memItemLeft" align="right" valign="top">virtual std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property__tree.html#a740cb283e9e65b7ba655a6b010e35d6b">list</a> (const <a class="el" href="structuhd_1_1fs__path.html">fs_path</a> &path) const =0</td></tr>
<tr class="memdesc:a740cb283e9e65b7ba655a6b010e35d6b"><td class="mdescLeft"> </td><td class="mdescRight">Get an iterable to all things in the given path. <a href="#a740cb283e9e65b7ba655a6b010e35d6b">More...</a><br /></td></tr>
<tr class="separator:a740cb283e9e65b7ba655a6b010e35d6b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a167937dc02b179b45115d474264c4721"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:a167937dc02b179b45115d474264c4721"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classuhd_1_1property.html">property</a>< T > & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuhd_1_1property__tree.html#a167937dc02b179b45115d474264c4721">create</a> (const <a class="el" href="structuhd_1_1fs__path.html">fs_path</a> &path)</td></tr>
<tr class="memdesc:a167937dc02b179b45115d474264c4721"><td class="mdescLeft"> </td><td class="mdescRight">Create a new property entry in the tree. <a href="#a167937dc02b179b45115d474264c4721">More...</a><br /></td></tr>
<tr class="separator:a167937dc02b179b45115d474264c4721"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ff778bd0c40c2cbdc237a11d9a2d83f"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:a1ff778bd0c40c2cbdc237a11d9a2d83f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classuhd_1_1property.html">property</a>< T > & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classuhd_1_1property__tree.html#a1ff778bd0c40c2cbdc237a11d9a2d83f">access</a> (const <a class="el" href="structuhd_1_1fs__path.html">fs_path</a> &path)</td></tr>
<tr class="memdesc:a1ff778bd0c40c2cbdc237a11d9a2d83f"><td class="mdescLeft"> </td><td class="mdescRight">Get access to a property in the tree. <a href="#a1ff778bd0c40c2cbdc237a11d9a2d83f">More...</a><br /></td></tr>
<tr class="separator:a1ff778bd0c40c2cbdc237a11d9a2d83f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ad943cf979bc17c8a520ff8dae7ca582c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classuhd_1_1property__tree.html#aebbee624be5b4c8cd5c590aa60ccbd10">sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property__tree.html#ad943cf979bc17c8a520ff8dae7ca582c">make</a> (void)</td></tr>
<tr class="memdesc:ad943cf979bc17c8a520ff8dae7ca582c"><td class="mdescLeft"> </td><td class="mdescRight">Create a new + empty property tree. <a href="#ad943cf979bc17c8a520ff8dae7ca582c">More...</a><br /></td></tr>
<tr class="separator:ad943cf979bc17c8a520ff8dae7ca582c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The property tree provides a file system structure for accessing properties. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="aebbee624be5b4c8cd5c590aa60ccbd10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef boost::shared_ptr<<a class="el" href="classuhd_1_1property__tree.html">property_tree</a>> <a class="el" href="classuhd_1_1property__tree.html#aebbee624be5b4c8cd5c590aa60ccbd10">uhd::property_tree::sptr</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1ff778bd0c40c2cbdc237a11d9a2d83f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classuhd_1_1property.html">property</a><T>& uhd::property_tree::access </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structuhd_1_1fs__path.html">fs_path</a> & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get access to a property in the tree. </p>
</div>
</div>
<a class="anchor" id="a167937dc02b179b45115d474264c4721"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classuhd_1_1property.html">property</a><T>& uhd::property_tree::create </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structuhd_1_1fs__path.html">fs_path</a> & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new property entry in the tree. </p>
</div>
</div>
<a class="anchor" id="adc86bc93ee29257873291879cd905dc4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool uhd::property_tree::exists </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structuhd_1_1fs__path.html">fs_path</a> & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>True if the path exists in the tree. </p>
</div>
</div>
<a class="anchor" id="a740cb283e9e65b7ba655a6b010e35d6b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::vector<std::string> uhd::property_tree::list </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structuhd_1_1fs__path.html">fs_path</a> & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an iterable to all things in the given path. </p>
</div>
</div>
<a class="anchor" id="ad943cf979bc17c8a520ff8dae7ca582c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classuhd_1_1property__tree.html#aebbee624be5b4c8cd5c590aa60ccbd10">sptr</a> uhd::property_tree::make </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new + empty property tree. </p>
</div>
</div>
<a class="anchor" id="aaa810db6efd763cdec797f32dacb9dbb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void uhd::property_tree::remove </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structuhd_1_1fs__path.html">fs_path</a> & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a property or directory (recursive) </p>
</div>
</div>
<a class="anchor" id="ad369a07c498fb949bc65f91f151d8901"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classuhd_1_1property__tree.html#aebbee624be5b4c8cd5c590aa60ccbd10">sptr</a> uhd::property_tree::subtree </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structuhd_1_1fs__path.html">fs_path</a> & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a subtree with a new root starting at path. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/uhd/<a class="el" href="property__tree_8hpp_source.html">property_tree.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 15 2014 11:47:53 for UHD by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
