<!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< T > Class Template 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.html">property</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="classuhd_1_1property-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">uhd::property< T > Class Template 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< T >:</div>
<div class="dyncontent">
<div class="center">
<img src="classuhd_1_1property.png" usemap="#uhd::property< T >_map" alt=""/>
<map id="uhd::property< T >_map" name="uhd::property< T >_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:a415afb33e21b589e7c2b5ba7eb024d07"><td class="memItemLeft" align="right" valign="top">typedef boost::function< void(const <br class="typebreak" />
T &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property.html#a415afb33e21b589e7c2b5ba7eb024d07">subscriber_type</a></td></tr>
<tr class="separator:a415afb33e21b589e7c2b5ba7eb024d07"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1914be6a5e6c31456540c676e9e8eeb8"><td class="memItemLeft" align="right" valign="top">typedef boost::function< T(void)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property.html#a1914be6a5e6c31456540c676e9e8eeb8">publisher_type</a></td></tr>
<tr class="separator:a1914be6a5e6c31456540c676e9e8eeb8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a363e6d30e4e6d16b9c7a9b05840ecdda"><td class="memItemLeft" align="right" valign="top">typedef boost::function< T(const <br class="typebreak" />
T &)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property.html#a363e6d30e4e6d16b9c7a9b05840ecdda">coercer_type</a></td></tr>
<tr class="separator:a363e6d30e4e6d16b9c7a9b05840ecdda"><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:a093e2d462a2fce2e67cf9e9ecacbfbfa"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classuhd_1_1property.html">property</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property.html#a093e2d462a2fce2e67cf9e9ecacbfbfa">coerce</a> (const <a class="el" href="classuhd_1_1property.html#a363e6d30e4e6d16b9c7a9b05840ecdda">coercer_type</a> &coercer)=0</td></tr>
<tr class="separator:a093e2d462a2fce2e67cf9e9ecacbfbfa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a013f0d56daa5240f1bb1c8f9cddf91e0"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classuhd_1_1property.html">property</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property.html#a013f0d56daa5240f1bb1c8f9cddf91e0">publish</a> (const <a class="el" href="classuhd_1_1property.html#a1914be6a5e6c31456540c676e9e8eeb8">publisher_type</a> &publisher)=0</td></tr>
<tr class="separator:a013f0d56daa5240f1bb1c8f9cddf91e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb7bba1624ccf2eda930802ac445b668"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classuhd_1_1property.html">property</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property.html#aeb7bba1624ccf2eda930802ac445b668">subscribe</a> (const <a class="el" href="classuhd_1_1property.html#a415afb33e21b589e7c2b5ba7eb024d07">subscriber_type</a> &subscriber)=0</td></tr>
<tr class="separator:aeb7bba1624ccf2eda930802ac445b668"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7c2e5a95e738274b6a14e1dfff04c69"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classuhd_1_1property.html">property</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property.html#ad7c2e5a95e738274b6a14e1dfff04c69">update</a> (void)=0</td></tr>
<tr class="separator:ad7c2e5a95e738274b6a14e1dfff04c69"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff1360aa4e1ddcd9fee2fd8d7326ce6f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classuhd_1_1property.html">property</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property.html#aff1360aa4e1ddcd9fee2fd8d7326ce6f">set</a> (const T &value)=0</td></tr>
<tr class="separator:aff1360aa4e1ddcd9fee2fd8d7326ce6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1ae8de90508b4f760127256f7e85743"><td class="memItemLeft" align="right" valign="top">virtual T </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property.html#ad1ae8de90508b4f760127256f7e85743">get</a> (void) const =0</td></tr>
<tr class="separator:ad1ae8de90508b4f760127256f7e85743"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a435430ed40a3cd0f4e2be7c6bb6ece92"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1property.html#a435430ed40a3cd0f4e2be7c6bb6ece92">empty</a> (void) const =0</td></tr>
<tr class="separator:a435430ed40a3cd0f4e2be7c6bb6ece92"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename T><br />
class uhd::property< T ></h3>
<p>A templated property interface for holding a value and registering callbacks when that value changes. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a363e6d30e4e6d16b9c7a9b05840ecdda"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">typedef boost::function<T(const T &)> <a class="el" href="classuhd_1_1property.html">uhd::property</a>< T >::<a class="el" href="classuhd_1_1property.html#a363e6d30e4e6d16b9c7a9b05840ecdda">coercer_type</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a1914be6a5e6c31456540c676e9e8eeb8"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">typedef boost::function<T(void)> <a class="el" href="classuhd_1_1property.html">uhd::property</a>< T >::<a class="el" href="classuhd_1_1property.html#a1914be6a5e6c31456540c676e9e8eeb8">publisher_type</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a415afb33e21b589e7c2b5ba7eb024d07"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">typedef boost::function<void(const T &)> <a class="el" href="classuhd_1_1property.html">uhd::property</a>< T >::<a class="el" href="classuhd_1_1property.html#a415afb33e21b589e7c2b5ba7eb024d07">subscriber_type</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a093e2d462a2fce2e67cf9e9ecacbfbfa"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classuhd_1_1property.html">property</a><T>& <a class="el" href="classuhd_1_1property.html">uhd::property</a>< T >::coerce </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classuhd_1_1property.html#a363e6d30e4e6d16b9c7a9b05840ecdda">coercer_type</a> & </td>
<td class="paramname"><em>coercer</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>Register a coercer into the property. A coercer is a special subscriber that coerces the value. Only one coercer may be registered per property. Registering a coercer replaces the previous coercer. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coercer</td><td>the coercer callback function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a reference to this property for chaining </dd></dl>
</div>
</div>
<a class="anchor" id="a435430ed40a3cd0f4e2be7c6bb6ece92"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="classuhd_1_1property.html">uhd::property</a>< T >::empty </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></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>A property is empty if it has never been set. A property with a publisher is never empty. </p><dl class="section return"><dt>Returns</dt><dd>true if the property is empty </dd></dl>
</div>
</div>
<a class="anchor" id="ad1ae8de90508b4f760127256f7e85743"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual T <a class="el" href="classuhd_1_1property.html">uhd::property</a>< T >::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></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 the current value of this property. The publisher (when provided) yields the value, otherwise an internal shadow is used for the value. </p><dl class="section return"><dt>Returns</dt><dd>the current value in the property </dd></dl>
</div>
</div>
<a class="anchor" id="a013f0d56daa5240f1bb1c8f9cddf91e0"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classuhd_1_1property.html">property</a><T>& <a class="el" href="classuhd_1_1property.html">uhd::property</a>< T >::publish </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classuhd_1_1property.html#a1914be6a5e6c31456540c676e9e8eeb8">publisher_type</a> & </td>
<td class="paramname"><em>publisher</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>Register a publisher into the property. A publisher is a special callback the provides the value. Publishers are useful for creating read-only properties. Only one publisher may be registered per property. Registering a publisher replaces the previous publisher. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">publisher</td><td>the publisher callback function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a reference to this property for chaining </dd></dl>
</div>
</div>
<a class="anchor" id="aff1360aa4e1ddcd9fee2fd8d7326ce6f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classuhd_1_1property.html">property</a><T>& <a class="el" href="classuhd_1_1property.html">uhd::property</a>< T >::set </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>value</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>Set the new value and call all subscribers. The coercer (when provided) is called initially, and the coerced value is used to set the subscribers. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the new value to set on this property </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a reference to this property for chaining </dd></dl>
</div>
</div>
<a class="anchor" id="aeb7bba1624ccf2eda930802ac445b668"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classuhd_1_1property.html">property</a><T>& <a class="el" href="classuhd_1_1property.html">uhd::property</a>< T >::subscribe </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classuhd_1_1property.html#a415afb33e21b589e7c2b5ba7eb024d07">subscriber_type</a> & </td>
<td class="paramname"><em>subscriber</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>Register a subscriber into the property. All subscribers are called when the value changes. Once a subscriber is registered, it cannot be unregistered. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">subscriber</td><td>the subscriber callback function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a reference to this property for chaining </dd></dl>
</div>
</div>
<a class="anchor" id="ad7c2e5a95e738274b6a14e1dfff04c69"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classuhd_1_1property.html">property</a><T>& <a class="el" href="classuhd_1_1property.html">uhd::property</a>< T >::update </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Update calls all subscribers w/ the current value. </p><dl class="section return"><dt>Returns</dt><dd>a reference to this property for chaining </dd></dl>
</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>
