diff options
Diffstat (limited to '0.14/classAbstractSource.html')
| -rw-r--r-- | 0.14/classAbstractSource.html | 492 |
1 files changed, 492 insertions, 0 deletions
diff --git a/0.14/classAbstractSource.html b/0.14/classAbstractSource.html new file mode 100644 index 00000000..7e17a73c --- /dev/null +++ b/0.14/classAbstractSource.html @@ -0,0 +1,492 @@ +<!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.11"/> +<title>automotive-message-broker: AbstractSource 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/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { init_search(); }); +</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 id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">automotive-message-broker +  <span id="projectnumber">0.14.0</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.11 --> +<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="pages.html"><span>Related Pages</span></a></li> + <li><a href="modules.html"><span>Modules</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><a href="examples.html"><span>Examples</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="classes.html"><span>Class Index</span></a></li> + <li><a href="inherits.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)"> +</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><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-types">Public Types</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-attribs">Protected Attributes</a> | +<a href="classAbstractSource-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">AbstractSource Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> +<div class="dynheader"> +Inheritance diagram for AbstractSource:</div> +<div class="dyncontent"> +<div class="center"><img src="classAbstractSource__inherit__graph.png" border="0" usemap="#AbstractSource_inherit__map" alt="Inheritance graph"/></div> +<map name="AbstractSource_inherit__map" id="AbstractSource_inherit__map"> +<area shape="rect" id="node3" href="classAmbPlugin.html" title="AmbPlugin\< T \>" alt="" coords="5,155,123,181"/> +<area shape="rect" id="node2" href="classAbstractSink.html" title="AbstractSink" alt="" coords="15,5,113,32"/> +</map> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> +<div class="dynheader"> +Collaboration diagram for AbstractSource:</div> +<div class="dyncontent"> +<div class="center"><img src="classAbstractSource__coll__graph.png" border="0" usemap="#AbstractSource_coll__map" alt="Collaboration graph"/></div> +<map name="AbstractSource_coll__map" id="AbstractSource_coll__map"> +<area shape="rect" id="node2" href="classAbstractSink.html" title="AbstractSink" alt="" coords="143,95,240,121"/> +<area shape="rect" id="node3" href="classAbstractRoutingEngine.html" title="AbstractRoutingEngine" alt="" coords="5,5,161,32"/> +</map> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></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:aad1e5e4914f2aa174dfd8fa6e143c1b9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad1e5e4914f2aa174dfd8fa6e143c1b9"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractSource.html#aad1e5e4914f2aa174dfd8fa6e143c1b9">Operations</a> { <b>Get</b> = 0x01, +<b>Set</b> = 0x02, +<b>GetRanged</b> = 0x04 + }<tr class="memdesc:aad1e5e4914f2aa174dfd8fa6e143c1b9"><td class="mdescLeft"> </td><td class="mdescRight">The Operations enum is a bitmask flag used to specify which operations are supported by the source plugin. <br /></td></tr> +</td></tr> +<tr class="separator:aad1e5e4914f2aa174dfd8fa6e143c1b9"><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:a753c78f3ee4c565c4ba2157c06cb7fbe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a753c78f3ee4c565c4ba2157c06cb7fbe"></a> + </td><td class="memItemRight" valign="bottom"><b>AbstractSource</b> (<a class="el" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a> *engine, map< string, string > config)</td></tr> +<tr class="separator:a753c78f3ee4c565c4ba2157c06cb7fbe"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a05589e699ea16a14675db226d51bdf9f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractSource.html#a05589e699ea16a14675db226d51bdf9f">getPropertyAsync</a> (<a class="el" href="classAsyncPropertyReply.html">AsyncPropertyReply</a> *reply)=0</td></tr> +<tr class="memdesc:a05589e699ea16a14675db226d51bdf9f"><td class="mdescLeft"> </td><td class="mdescRight">pure virtual methods: <a href="#a05589e699ea16a14675db226d51bdf9f">More...</a><br /></td></tr> +<tr class="separator:a05589e699ea16a14675db226d51bdf9f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3b30f939d68889b2540f6035fa5be7c7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractSource.html#a3b30f939d68889b2540f6035fa5be7c7">getRangePropertyAsync</a> (<a class="el" href="classAsyncRangePropertyReply.html">AsyncRangePropertyReply</a> *reply)=0</td></tr> +<tr class="memdesc:a3b30f939d68889b2540f6035fa5be7c7"><td class="mdescLeft"> </td><td class="mdescRight">getRangePropertyAsync is called when a sink requests a series of values for a given property within a specified time or sequencial range. This will only be called if the source support the Ranged Operation ( <a href="#a3b30f939d68889b2540f6035fa5be7c7">More...</a><br /></td></tr> +<tr class="separator:a3b30f939d68889b2540f6035fa5be7c7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a684b58112b5572dfe8cb94380bf7d74a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classAsyncPropertyReply.html">AsyncPropertyReply</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractSource.html#a684b58112b5572dfe8cb94380bf7d74a">setProperty</a> (<a class="el" href="classAsyncSetPropertyRequest.html">AsyncSetPropertyRequest</a> request)=0</td></tr> +<tr class="memdesc:a684b58112b5572dfe8cb94380bf7d74a"><td class="mdescLeft"> </td><td class="mdescRight">setProperty is called when a sink requests to set a value for a given property. This is only called if the source supports the Set Operation ( <a href="#a684b58112b5572dfe8cb94380bf7d74a">More...</a><br /></td></tr> +<tr class="separator:a684b58112b5572dfe8cb94380bf7d74a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae9c042e159f080c298b2ae37c47618e9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractSource.html#ae9c042e159f080c298b2ae37c47618e9">subscribeToPropertyChanges</a> (VehicleProperty::Property property)=0</td></tr> +<tr class="memdesc:ae9c042e159f080c298b2ae37c47618e9"><td class="mdescLeft"> </td><td class="mdescRight">subscribeToPropertyChanges is called when a sink requests a subscription. Source plugins can keep track of subscriptions and may wish to sleep if there are no subscriptions. <a href="#ae9c042e159f080c298b2ae37c47618e9">More...</a><br /></td></tr> +<tr class="separator:ae9c042e159f080c298b2ae37c47618e9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a584372310f191b1b9067a634b7366023"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractSource.html#a584372310f191b1b9067a634b7366023">unsubscribeToPropertyChanges</a> (VehicleProperty::Property property)=0</td></tr> +<tr class="memdesc:a584372310f191b1b9067a634b7366023"><td class="mdescLeft"> </td><td class="mdescRight">unsubscribeToPropertyChanges is called when a sink requests to unsubscribe from a given property's changes. <a href="#a584372310f191b1b9067a634b7366023">More...</a><br /></td></tr> +<tr class="separator:a584372310f191b1b9067a634b7366023"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a317861675652372a72fc01c075036b51"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractSource.html#a317861675652372a72fc01c075036b51">supportedOperations</a> ()=0</td></tr> +<tr class="memdesc:a317861675652372a72fc01c075036b51"><td class="mdescLeft"> </td><td class="mdescRight">supportedOperations <a href="#a317861675652372a72fc01c075036b51">More...</a><br /></td></tr> +<tr class="separator:a317861675652372a72fc01c075036b51"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4e15ea9df2144be322968003621580c4"><td class="memItemLeft" align="right" valign="top">virtual PropertyInfo </td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractSource.html#a4e15ea9df2144be322968003621580c4">getPropertyInfo</a> (const VehicleProperty::Property &property)=0</td></tr> +<tr class="memdesc:a4e15ea9df2144be322968003621580c4"><td class="mdescLeft"> </td><td class="mdescRight">getPropertyInfo used to return specific information about a property <a href="#a4e15ea9df2144be322968003621580c4">More...</a><br /></td></tr> +<tr class="separator:a4e15ea9df2144be322968003621580c4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad8330cbbac84dc24851eb50ff7243460"><td class="memItemLeft" align="right" valign="top">virtual PropertyList </td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractSource.html#ad8330cbbac84dc24851eb50ff7243460">supported</a> ()=0</td></tr> +<tr class="memdesc:ad8330cbbac84dc24851eb50ff7243460"><td class="mdescLeft"> </td><td class="mdescRight">supported <a href="#ad8330cbbac84dc24851eb50ff7243460">More...</a><br /></td></tr> +<tr class="separator:ad8330cbbac84dc24851eb50ff7243460"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classAbstractSink"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classAbstractSink')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classAbstractSink.html">AbstractSink</a></td></tr> +<tr class="memitem:a63f03d63fd091cd6f39a9888dd08ea6a inherit pub_methods_classAbstractSink"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63f03d63fd091cd6f39a9888dd08ea6a"></a> + </td><td class="memItemRight" valign="bottom"><b>AbstractSink</b> (<a class="el" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a> *engine, map< string, string > config)</td></tr> +<tr class="separator:a63f03d63fd091cd6f39a9888dd08ea6a inherit pub_methods_classAbstractSink"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a965ae1d5218713c7823fbd95fa51b053 inherit pub_methods_classAbstractSink"><td class="memItemLeft" align="right" valign="top">virtual const string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractSink.html#a965ae1d5218713c7823fbd95fa51b053">uuid</a> ()=0</td></tr> +<tr class="memdesc:a965ae1d5218713c7823fbd95fa51b053 inherit pub_methods_classAbstractSink"><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual methods: <a href="#a965ae1d5218713c7823fbd95fa51b053">More...</a><br /></td></tr> +<tr class="separator:a965ae1d5218713c7823fbd95fa51b053 inherit pub_methods_classAbstractSink"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afeb683c566a5a71303d05d2e12da2b28 inherit pub_methods_classAbstractSink"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractSink.html#afeb683c566a5a71303d05d2e12da2b28">propertyChanged</a> (<a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a> *value)</td></tr> +<tr class="memdesc:afeb683c566a5a71303d05d2e12da2b28 inherit pub_methods_classAbstractSink"><td class="mdescLeft"> </td><td class="mdescRight">propertyChanged is called when a subscribed to property changes. <a href="#afeb683c566a5a71303d05d2e12da2b28">More...</a><br /></td></tr> +<tr class="separator:afeb683c566a5a71303d05d2e12da2b28 inherit pub_methods_classAbstractSink"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa9538a89536e8b6495551283116a588b inherit pub_methods_classAbstractSink"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractSink.html#aa9538a89536e8b6495551283116a588b">supportedChanged</a> (const PropertyList &supportedProperties)=0</td></tr> +<tr class="separator:aa9538a89536e8b6495551283116a588b inherit pub_methods_classAbstractSink"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> +Protected Attributes</h2></td></tr> +<tr class="memitem:aabbce93fea123c54be55a007c928a6f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractSource.html#aabbce93fea123c54be55a007c928a6f1">routingEngine</a></td></tr> +<tr class="memdesc:aabbce93fea123c54be55a007c928a6f1"><td class="mdescLeft"> </td><td class="mdescRight">routingEngine the core routing engine used to send property updates to sink plugins. <a href="#aabbce93fea123c54be55a007c928a6f1">More...</a><br /></td></tr> +<tr class="separator:aabbce93fea123c54be55a007c928a6f1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pro_attribs_classAbstractSink"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classAbstractSink')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classAbstractSink.html">AbstractSink</a></td></tr> +<tr class="memitem:a4d49a722e60cd9993c182a29fbf74591 inherit pro_attribs_classAbstractSink"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d49a722e60cd9993c182a29fbf74591"></a> +<a class="el" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAbstractSink.html#a4d49a722e60cd9993c182a29fbf74591">routingEngine</a></td></tr> +<tr class="memdesc:a4d49a722e60cd9993c182a29fbf74591 inherit pro_attribs_classAbstractSink"><td class="mdescLeft"> </td><td class="mdescRight">routingEngine is the core of AMB. It is used to pass plugin and property information to other plugins <br /></td></tr> +<tr class="separator:a4d49a722e60cd9993c182a29fbf74591 inherit pro_attribs_classAbstractSink"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a52581d514cad8b74a9fb42a026522f76 inherit pro_attribs_classAbstractSink"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52581d514cad8b74a9fb42a026522f76"></a> +map< string, string > </td><td class="memItemRight" valign="bottom"><b>configuration</b></td></tr> +<tr class="separator:a52581d514cad8b74a9fb42a026522f76 inherit pro_attribs_classAbstractSink"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><dl><dt><b>Examples: </b></dt><dd><a class="el" href="_2home_2kev_2src_2automotive-message-broker_2lib_2abstractroutingengine_8h-example.html#_a1">/home/kev/src/automotive-message-broker/lib/abstractroutingengine.h</a>.</dd> +</dl></div><h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a05589e699ea16a14675db226d51bdf9f"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void AbstractSource::getPropertyAsync </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classAsyncPropertyReply.html">AsyncPropertyReply</a> * </td> + <td class="paramname"><em>reply</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>pure virtual methods: </p> +<p>getPropertyAsync is called when a sink requests the value for given property. This is only called if the source supports the Get operation (</p><dl class="section see"><dt>See also</dt><dd>Operation) </dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">reply</td><td>the reply variable. </td></tr> + </table> + </dd> +</dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAsyncPropertyReply.html" title="The AsyncPropertyReply class is used by sources to reply to Get and Set operations. The source should set success to true if the call is successful or 'false' if the request was not successful and set 'error' to the appropriate error. ">AsyncPropertyReply</a> </dd></dl> + +<p>Implemented in <a class="el" href="group__libamb.html#ga6d965dd88d158b4af1f609317b674098">AmbPlugin< T ></a>.</p> + +</div> +</div> +<a class="anchor" id="a4e15ea9df2144be322968003621580c4"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual PropertyInfo AbstractSource::getPropertyInfo </td> + <td>(</td> + <td class="paramtype">const VehicleProperty::Property & </td> + <td class="paramname"><em>property</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>getPropertyInfo used to return specific information about a property </p> +<dl class="section see"><dt>See also</dt><dd>PropertyInfo the source should override this otherwise a PropertyInfo::invalid() will be returned for the property </dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">property</td><td>the property to get info for. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a PropertyInfo object. </dd></dl> + +<p>Implemented in <a class="el" href="group__libamb.html#ga717b0cdbad39119d5f8ef55750eb280e">AmbPlugin< T ></a>.</p> + +</div> +</div> +<a class="anchor" id="a3b30f939d68889b2540f6035fa5be7c7"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void AbstractSource::getRangePropertyAsync </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classAsyncRangePropertyReply.html">AsyncRangePropertyReply</a> * </td> + <td class="paramname"><em>reply</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>getRangePropertyAsync is called when a sink requests a series of values for a given property within a specified time or sequencial range. This will only be called if the source support the Ranged Operation ( </p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAbstractSource.html#aad1e5e4914f2aa174dfd8fa6e143c1b9" title="The Operations enum is a bitmask flag used to specify which operations are supported by the source pl...">Operations</a>) </dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">reply</td><td>is the reply variable. </td></tr> + </table> + </dd> +</dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAsyncRangePropertyReply.html" title="The AsyncRangePropertyReply class is used by a source to reply to an AsyncRangePropertyRequest. The source should set success to 'true' and populate the 'values' member if the request was successful. If the request is not successful, 'success' should be set to 'false' and the 'error' member should be set. ">AsyncRangePropertyReply</a> </dd></dl> + +<p>Implemented in <a class="el" href="group__libamb.html#gab052ed4dea097b25aa9aec76f151175f">AmbPlugin< T ></a>.</p> + +</div> +</div> +<a class="anchor" id="a684b58112b5572dfe8cb94380bf7d74a"></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="classAsyncPropertyReply.html">AsyncPropertyReply</a>* AbstractSource::setProperty </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classAsyncSetPropertyRequest.html">AsyncSetPropertyRequest</a> </td> + <td class="paramname"><em>request</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>setProperty is called when a sink requests to set a value for a given property. This is only called if the source supports the Set Operation ( </p> +<dl class="section see"><dt>See also</dt><dd>Operation) </dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">request</td><td>the requested property to set. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>returns a pointer to the new value for the property. </dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAsyncPropertyReply.html" title="The AsyncPropertyReply class is used by sources to reply to Get and Set operations. The source should set success to true if the call is successful or 'false' if the request was not successful and set 'error' to the appropriate error. ">AsyncPropertyReply</a> </dd></dl> + +<p>Implemented in <a class="el" href="group__libamb.html#ga9348b743e7f678c4b98b9681199844ad">AmbPlugin< T ></a>.</p> + +</div> +</div> +<a class="anchor" id="ae9c042e159f080c298b2ae37c47618e9"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void AbstractSource::subscribeToPropertyChanges </td> + <td>(</td> + <td class="paramtype">VehicleProperty::Property </td> + <td class="paramname"><em>property</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>subscribeToPropertyChanges is called when a sink requests a subscription. Source plugins can keep track of subscriptions and may wish to sleep if there are no subscriptions. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">property</td><td>the property that is being subscribed. </td></tr> + </table> + </dd> +</dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAbstractSource.html#a584372310f191b1b9067a634b7366023" title="unsubscribeToPropertyChanges is called when a sink requests to unsubscribe from a given property's ch...">unsubscribeToPropertyChanges</a> </dd></dl> + +<p>Implemented in <a class="el" href="group__libamb.html#gab98182f95801527bec4d972f37d3c92b">AmbPlugin< T ></a>.</p> + +</div> +</div> +<a class="anchor" id="ad8330cbbac84dc24851eb50ff7243460"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual PropertyList AbstractSource::supported </td> + <td>(</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>supported </p> +<dl class="section return"><dt>Returns</dt><dd>returns the supported properties. </dd></dl> + +<p>Implemented in <a class="el" href="group__libamb.html#ga877185aeb55596f1d4407e9d7add3d06">AmbPlugin< T ></a>.</p> + +</div> +</div> +<a class="anchor" id="a317861675652372a72fc01c075036b51"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual int AbstractSource::supportedOperations </td> + <td>(</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>supportedOperations </p> +<dl class="section return"><dt>Returns</dt><dd>returns the supported operations. </dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAbstractSource.html#aad1e5e4914f2aa174dfd8fa6e143c1b9" title="The Operations enum is a bitmask flag used to specify which operations are supported by the source pl...">Operations</a> </dd></dl> + +<p>Implemented in <a class="el" href="group__libamb.html#gac06aaf56b38fc404f766b3ff78eafb0e">AmbPlugin< T ></a>.</p> + +</div> +</div> +<a class="anchor" id="a584372310f191b1b9067a634b7366023"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void AbstractSource::unsubscribeToPropertyChanges </td> + <td>(</td> + <td class="paramtype">VehicleProperty::Property </td> + <td class="paramname"><em>property</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>unsubscribeToPropertyChanges is called when a sink requests to unsubscribe from a given property's changes. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">property</td><td>the property to unsubscribe to </td></tr> + </table> + </dd> +</dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAbstractSource.html#ae9c042e159f080c298b2ae37c47618e9" title="subscribeToPropertyChanges is called when a sink requests a subscription. Source plugins can keep tra...">subscribeToPropertyChanges</a> </dd></dl> + +<p>Implemented in <a class="el" href="group__libamb.html#ga1ebede30c34aa80c3833db9d744474d0">AmbPlugin< T ></a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a class="anchor" id="aabbce93fea123c54be55a007c928a6f1"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a>* AbstractSource::routingEngine</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>routingEngine the core routing engine used to send property updates to sink plugins. </p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a> </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>/home/kev/src/automotive-message-broker/lib/<a class="el" href="abstractsource_8h_source.html">abstractsource.h</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.11 +</small></address> +</body> +</html> |