diff options
Diffstat (limited to '0.14/html/classAmbPluginImpl.html')
| -rw-r--r-- | 0.14/html/classAmbPluginImpl.html | 772 |
1 files changed, 772 insertions, 0 deletions
diff --git a/0.14/html/classAmbPluginImpl.html b/0.14/html/classAmbPluginImpl.html new file mode 100644 index 00000000..b19ece45 --- /dev/null +++ b/0.14/html/classAmbPluginImpl.html @@ -0,0 +1,772 @@ +<!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: AmbPluginImpl 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-methods">Public Member Functions</a> | +<a href="#pro-types">Protected Types</a> | +<a href="#pro-methods">Protected Member Functions</a> | +<a href="#pro-attribs">Protected Attributes</a> | +<a href="classAmbPluginImpl-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">AmbPluginImpl Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__libamb.html">Libamb</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p><a class="el" href="classAmbPlugin.html">AmbPlugin</a> private class implementation - base class for all plugin implementations. + <a href="classAmbPluginImpl.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="ambpluginimpl_8h_source.html">ambpluginimpl.h</a>></code></p> +<div class="dynheader"> +Collaboration diagram for AmbPluginImpl:</div> +<div class="dyncontent"> +<div class="center"><img src="classAmbPluginImpl__coll__graph.png" border="0" usemap="#AmbPluginImpl_coll__map" alt="Collaboration graph"/></div> +<map name="AmbPluginImpl_coll__map" id="AmbPluginImpl_coll__map"> +<area shape="rect" id="node2" href="classAbstractSource.html" title="AbstractSource" alt="" coords="73,184,185,211"/> +<area shape="rect" id="node3" href="classAbstractSink.html" title="AbstractSink" alt="" coords="237,95,335,121"/> +<area shape="rect" id="node4" href="classAbstractRoutingEngine.html" title="AbstractRoutingEngine" alt="" coords="51,5,207,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-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a3d8f1cc299086979feda83a738383da9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#a3d8f1cc299086979feda83a738383da9">AmbPluginImpl</a> (<a class="el" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a> *re, const map< string, string > &config, <a class="el" href="classAbstractSource.html">AbstractSource</a> &parent)</td></tr> +<tr class="separator:a3d8f1cc299086979feda83a738383da9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abb111b1801f96f34d1dac2667cd3b349"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#abb111b1801f96f34d1dac2667cd3b349">getPropertyAsync</a> (<a class="el" href="classAsyncPropertyReply.html">AsyncPropertyReply</a> *reply)</td></tr> +<tr class="memdesc:abb111b1801f96f34d1dac2667cd3b349"><td class="mdescLeft"> </td><td class="mdescRight">getPropertyAsync is called when a sink requests the value for given property. This is only called if the source supports the Get operation. <a href="#abb111b1801f96f34d1dac2667cd3b349">More...</a><br /></td></tr> +<tr class="separator:abb111b1801f96f34d1dac2667cd3b349"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9447fe9aefa1c4407c65bed49bdc09e7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#a9447fe9aefa1c4407c65bed49bdc09e7">getRangePropertyAsync</a> (<a class="el" href="classAsyncRangePropertyReply.html">AsyncRangePropertyReply</a> *reply)</td></tr> +<tr class="memdesc:a9447fe9aefa1c4407c65bed49bdc09e7"><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="#a9447fe9aefa1c4407c65bed49bdc09e7">More...</a><br /></td></tr> +<tr class="separator:a9447fe9aefa1c4407c65bed49bdc09e7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a99149b3a7d6912959d1ad6bda3e10843"><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="classAmbPluginImpl.html#a99149b3a7d6912959d1ad6bda3e10843">setProperty</a> (const <a class="el" href="classAsyncSetPropertyRequest.html">AsyncSetPropertyRequest</a> &request)</td></tr> +<tr class="memdesc:a99149b3a7d6912959d1ad6bda3e10843"><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="#a99149b3a7d6912959d1ad6bda3e10843">More...</a><br /></td></tr> +<tr class="separator:a99149b3a7d6912959d1ad6bda3e10843"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2d1fe01faaee9e48268df587481f11ce"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#a2d1fe01faaee9e48268df587481f11ce">subscribeToPropertyChanges</a> (const VehicleProperty::Property &property)</td></tr> +<tr class="memdesc:a2d1fe01faaee9e48268df587481f11ce"><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="#a2d1fe01faaee9e48268df587481f11ce">More...</a><br /></td></tr> +<tr class="separator:a2d1fe01faaee9e48268df587481f11ce"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afddf7c88c3e53e8b4722e9a456c1529c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#afddf7c88c3e53e8b4722e9a456c1529c">unsubscribeToPropertyChanges</a> (const VehicleProperty::Property &property)</td></tr> +<tr class="memdesc:afddf7c88c3e53e8b4722e9a456c1529c"><td class="mdescLeft"> </td><td class="mdescRight">unsubscribeToPropertyChanges is called when a sink requests to unsubscribe from a given property's changes. <a href="#afddf7c88c3e53e8b4722e9a456c1529c">More...</a><br /></td></tr> +<tr class="separator:afddf7c88c3e53e8b4722e9a456c1529c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a03a9c9305463e47cdc5c73f8d178aef6"><td class="memItemLeft" align="right" valign="top">virtual PropertyList </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#a03a9c9305463e47cdc5c73f8d178aef6">supported</a> () const </td></tr> +<tr class="memdesc:a03a9c9305463e47cdc5c73f8d178aef6"><td class="mdescLeft"> </td><td class="mdescRight">supported is called by the routingEngine to understand what properties this source supports. <a href="#a03a9c9305463e47cdc5c73f8d178aef6">More...</a><br /></td></tr> +<tr class="separator:a03a9c9305463e47cdc5c73f8d178aef6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa1b56456501c4233ed8071dcbdf955bd"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#aa1b56456501c4233ed8071dcbdf955bd">supportedOperations</a> () const </td></tr> +<tr class="memdesc:aa1b56456501c4233ed8071dcbdf955bd"><td class="mdescLeft"> </td><td class="mdescRight">supportedOperations <a href="#aa1b56456501c4233ed8071dcbdf955bd">More...</a><br /></td></tr> +<tr class="separator:aa1b56456501c4233ed8071dcbdf955bd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a417e5e1bbe184f41db38b7e567ea369e"><td class="memItemLeft" align="right" valign="top">virtual PropertyInfo </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#a417e5e1bbe184f41db38b7e567ea369e">getPropertyInfo</a> (const VehicleProperty::Property &property)</td></tr> +<tr class="memdesc:a417e5e1bbe184f41db38b7e567ea369e"><td class="mdescLeft"> </td><td class="mdescRight">getPropertyInfo used to return specific information about a property. The source should override this otherwise a PropertyInfo::invalid() will be returned for the property <a href="#a417e5e1bbe184f41db38b7e567ea369e">More...</a><br /></td></tr> +<tr class="separator:a417e5e1bbe184f41db38b7e567ea369e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abba832fa02a70798df7323b909c7a2c2"><td class="memItemLeft" align="right" valign="top">virtual const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#abba832fa02a70798df7323b909c7a2c2">uuid</a> () const =0</td></tr> +<tr class="separator:abba832fa02a70798df7323b909c7a2c2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a82134b7948d3f9cce0168dfc8da7579e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#a82134b7948d3f9cce0168dfc8da7579e">propertyChanged</a> (<a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a> *value)</td></tr> +<tr class="separator:a82134b7948d3f9cce0168dfc8da7579e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9ef528c7ee79bfd30132b926ce38b0ae"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#a9ef528c7ee79bfd30132b926ce38b0ae">supportedChanged</a> (const PropertyList &supportedProperties)</td></tr> +<tr class="separator:a9ef528c7ee79bfd30132b926ce38b0ae"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0e9fa59ffb80efe0e30fb5de78540a31"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#a0e9fa59ffb80efe0e30fb5de78540a31">init</a> ()</td></tr> +<tr class="separator:a0e9fa59ffb80efe0e30fb5de78540a31"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acd51c852d9aa295dc8a37119876a4f1c"><td class="memTemplParams" colspan="2"><a class="anchor" id="acd51c852d9aa295dc8a37119876a4f1c"></a> +template<typename T > </td></tr> +<tr class="memitem:acd51c852d9aa295dc8a37119876a4f1c"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#acd51c852d9aa295dc8a37119876a4f1c">setValue</a> (std::shared_ptr< <a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a> > property, T value)</td></tr> +<tr class="memdesc:acd51c852d9aa295dc8a37119876a4f1c"><td class="mdescLeft"> </td><td class="mdescRight">setValue of a property <br /></td></tr> +<tr class="separator:acd51c852d9aa295dc8a37119876a4f1c"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-types"></a> +Protected Types</h2></td></tr> +<tr class="memitem:a6be3e5823bb358932c132760262fb4ee"><td class="memItemLeft" align="right" valign="top">typedef std::map< Zone::Type, std::shared_ptr< <a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#a6be3e5823bb358932c132760262fb4ee">ZonePropertyType</a></td></tr> +<tr class="separator:a6be3e5823bb358932c132760262fb4ee"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> +Protected Member Functions</h2></td></tr> +<tr class="memitem:a35c8d3e886b9b2f891cffb10d93637ec"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#a35c8d3e886b9b2f891cffb10d93637ec">findPropertyType</a> (const VehicleProperty::Property &propertyName, const Zone::Type &zone=Zone::None)</td></tr> +<tr class="separator:a35c8d3e886b9b2f891cffb10d93637ec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a23dd25458089bb7f3ed5de44395ded7c"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#a23dd25458089bb7f3ed5de44395ded7c">addPropertySupport</a> (Zone::Type zone, std::function< <a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a> *(void)> typeFactory, std::string sourceUuid="")</td></tr> +<tr class="separator:a23dd25458089bb7f3ed5de44395ded7c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aad251db3a4cb7f188c2853a273bccef1"><td class="memTemplParams" colspan="2"><a class="anchor" id="aad251db3a4cb7f188c2853a273bccef1"></a> +template<class T > </td></tr> +<tr class="memitem:aad251db3a4cb7f188c2853a273bccef1"><td class="memTemplItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a> > </td><td class="memTemplItemRight" valign="bottom"><b>addPropertySupport</b> (Zone::Type zone)</td></tr> +<tr class="separator:aad251db3a4cb7f188c2853a273bccef1"><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:a36fa7b3c793f1410b331d3221079d19b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a36fa7b3c793f1410b331d3221079d19b"></a> +<a class="el" href="classAbstractSource.html">AbstractSource</a> & </td><td class="memItemRight" valign="bottom"><b>source</b></td></tr> +<tr class="separator:a36fa7b3c793f1410b331d3221079d19b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a44be51306133b0d71ed79507032c3a8c"><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="classAmbPluginImpl.html#a44be51306133b0d71ed79507032c3a8c">routingEngine</a></td></tr> +<tr class="separator:a44be51306133b0d71ed79507032c3a8c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8f58d50cf0a4dd48b90e8fad6a9f5baa"><td class="memItemLeft" align="right" valign="top">std::map< VehicleProperty::Property, <a class="el" href="classAmbPluginImpl.html#a6be3e5823bb358932c132760262fb4ee">ZonePropertyType</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#a8f58d50cf0a4dd48b90e8fad6a9f5baa">properties</a></td></tr> +<tr class="separator:a8f58d50cf0a4dd48b90e8fad6a9f5baa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1f711a42020b16453e6890d3634de987"><td class="memItemLeft" align="right" valign="top">std::map< std::string, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAmbPluginImpl.html#a1f711a42020b16453e6890d3634de987">configuration</a></td></tr> +<tr class="separator:a1f711a42020b16453e6890d3634de987"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p><a class="el" href="classAmbPlugin.html">AmbPlugin</a> private class implementation - base class for all plugin implementations. </p> +<p>Contains common code used in plugins for Automotive message broker(AMB). For the AMB library API please visit <a class="el" href="libamb_8h.html#libamb">Automotive Message Broker Library Documentation</a>. </p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a class="anchor" id="a6be3e5823bb358932c132760262fb4ee"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">typedef std::map< Zone::Type, std::shared_ptr<<a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a>> > <a class="el" href="classAmbPluginImpl.html#a6be3e5823bb358932c132760262fb4ee">AmbPluginImpl::ZonePropertyType</a></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>Helper typedef </p> + +</div> +</div> +<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="a3d8f1cc299086979feda83a738383da9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">AmbPluginImpl::AmbPluginImpl </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a> * </td> + <td class="paramname"><em>re</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const map< string, string > & </td> + <td class="paramname"><em>config</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classAbstractSource.html">AbstractSource</a> & </td> + <td class="paramname"><em>parent</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">re</td><td><a class="el" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a> </td></tr> + <tr><td class="paramname">config</td><td>Map of the configuration string values loaded on startup from AMB configuration file </td></tr> + <tr><td class="paramname">parent</td><td><a class="el" href="classAmbPlugin.html">AmbPlugin</a> instance </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a23dd25458089bb7f3ed5de44395ded7c"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr<<a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a>> AmbPluginImpl::addPropertySupport </td> + <td>(</td> + <td class="paramtype">Zone::Type </td> + <td class="paramname"><em>zone</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::function< <a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a> *(void)> </td> + <td class="paramname"><em>typeFactory</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::string </td> + <td class="paramname"><em>sourceUuid</em> = <code>""</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></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>Registers property in AMB </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">zone</td><td><a class="el" href="classZone.html">Zone</a> of the property to be registered. </td></tr> + <tr><td class="paramname">typeFactory</td><td>Function to be used to create instance of the <a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a> for registered property </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>AbstractPropertyType* if signal exits otherwise nullptr(in this case we do not know its datatype) </dd></dl> + +</div> +</div> +<a class="anchor" id="a35c8d3e886b9b2f891cffb10d93637ec"></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="classAbstractPropertyType.html">AbstractPropertyType</a>* AmbPluginImpl::findPropertyType </td> + <td>(</td> + <td class="paramtype">const VehicleProperty::Property & </td> + <td class="paramname"><em>propertyName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const Zone::Type & </td> + <td class="paramname"><em>zone</em> = <code>Zone::None</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Finds property type in <a class="el" href="classAmbPluginImpl.html#a8f58d50cf0a4dd48b90e8fad6a9f5baa">properties</a> </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">propertyName</td><td>Name of the property to be found. </td></tr> + <tr><td class="paramname">zone</td><td><a class="el" href="classZone.html">Zone</a> of the property to be found. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>AbstractPropertyType* if signal exits otherwise nullptr(in this case we do not know its datatype) </dd></dl> + +</div> +</div> +<a class="anchor" id="abb111b1801f96f34d1dac2667cd3b349"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void AmbPluginImpl::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">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<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="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">reply</td><td>the reply variable. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a417e5e1bbe184f41db38b7e567ea369e"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual PropertyInfo AmbPluginImpl::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">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>getPropertyInfo used to return specific information about a property. The source should override this otherwise a PropertyInfo::invalid() will be returned for the property </p> +<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> + +</div> +</div> +<a class="anchor" id="a9447fe9aefa1c4407c65bed49bdc09e7"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void AmbPluginImpl::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">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="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">reply</td><td>is the reply variable. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a0e9fa59ffb80efe0e30fb5de78540a31"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">AmbPluginImpl::init </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Second phase of the plugin initialization. </p> + +</div> +</div> +<a class="anchor" id="a82134b7948d3f9cce0168dfc8da7579e"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void AmbPluginImpl::propertyChanged </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a> * </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">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>propertyChanged is called when a subscribed to property changes. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">value</td><td>value of the property that changed. this is a temporary pointer that will be destroyed. Do not destroy it. If you need to store the value use value.anyValue(), value.value<T>() or value->copy() to copy. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a99149b3a7d6912959d1ad6bda3e10843"></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>* AmbPluginImpl::setProperty </td> + <td>(</td> + <td class="paramtype">const <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">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="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> + +</div> +</div> +<a class="anchor" id="a2d1fe01faaee9e48268df587481f11ce"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void AmbPluginImpl::subscribeToPropertyChanges </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">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> + +</div> +</div> +<a class="anchor" id="a03a9c9305463e47cdc5c73f8d178aef6"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual PropertyList AmbPluginImpl::supported </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>supported is called by the routingEngine to understand what properties this source supports. </p> +<dl class="section return"><dt>Returns</dt><dd>returns a list of supported properties. If the the supported properties changed, the source should call AbstractRoutingEngine::setSupported. </dd></dl> + +</div> +</div> +<a class="anchor" id="a9ef528c7ee79bfd30132b926ce38b0ae"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">AmbPluginImpl::supportedChanged </td> + <td>(</td> + <td class="paramtype">const PropertyList & </td> + <td class="paramname"><em>supportedProperties</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p><a class="el" href="classAmbPluginImpl.html#a9ef528c7ee79bfd30132b926ce38b0ae">supportedChanged()</a> is called when the supported properties changes</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">supportedProperties</td><td>the new list of supported properties. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="aa1b56456501c4233ed8071dcbdf955bd"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual int AmbPluginImpl::supportedOperations </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">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> + +</div> +</div> +<a class="anchor" id="afddf7c88c3e53e8b4722e9a456c1529c"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void AmbPluginImpl::unsubscribeToPropertyChanges </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">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> + +</div> +</div> +<a class="anchor" id="abba832fa02a70798df7323b909c7a2c2"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual const std::string AmbPluginImpl::uuid </td> + <td>(</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 class="el" href="classAmbPluginImpl.html#abba832fa02a70798df7323b909c7a2c2">uuid()</a> is a unique identifier </p><dl class="section return"><dt>Returns</dt><dd>a guid-style unique identifier </dd></dl> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a class="anchor" id="a1f711a42020b16453e6890d3634de987"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::map< std::string, std::string> AmbPluginImpl::configuration</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>configuration </p> + +</div> +</div> +<a class="anchor" id="a8f58d50cf0a4dd48b90e8fad6a9f5baa"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">AmbPluginImpl::properties</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>Supported property values map </p> + +</div> +</div> +<a class="anchor" id="a44be51306133b0d71ed79507032c3a8c"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">AmbPluginImpl::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><a class="el" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a> instance </p> + +</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="ambpluginimpl_8h_source.html">ambpluginimpl.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> |