diff options
Diffstat (limited to '0.14/classAbstractSink.html')
-rw-r--r-- | 0.14/classAbstractSink.html | 245 |
1 files changed, 245 insertions, 0 deletions
diff --git a/0.14/classAbstractSink.html b/0.14/classAbstractSink.html new file mode 100644 index 00000000..80795521 --- /dev/null +++ b/0.14/classAbstractSink.html @@ -0,0 +1,245 @@ +<!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: AbstractSink 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-attribs">Protected Attributes</a> | +<a href="classAbstractSink-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">AbstractSink Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> +<div class="dynheader"> +Inheritance diagram for AbstractSink:</div> +<div class="dyncontent"> +<div class="center"><img src="classAbstractSink__inherit__graph.png" border="0" usemap="#AbstractSink_inherit__map" alt="Inheritance graph"/></div> +<map name="AbstractSink_inherit__map" id="AbstractSink_inherit__map"> +<area shape="rect" id="node2" href="classAbstractSource.html" title="AbstractSource" alt="" coords="8,80,120,107"/> +<area shape="rect" id="node3" href="classAmbPlugin.html" title="AmbPlugin\< T \>" alt="" coords="5,155,123,181"/> +</map> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> +<div class="dynheader"> +Collaboration diagram for AbstractSink:</div> +<div class="dyncontent"> +<div class="center"><img src="classAbstractSink__coll__graph.png" border="0" usemap="#AbstractSink_coll__map" alt="Collaboration graph"/></div> +<map name="AbstractSink_coll__map" id="AbstractSink_coll__map"> +<area shape="rect" id="node2" 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-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a63f03d63fd091cd6f39a9888dd08ea6a"><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"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a965ae1d5218713c7823fbd95fa51b053"><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"><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual methods: <a href="#a965ae1d5218713c7823fbd95fa51b053">More...</a><br /></td></tr> +<tr class="separator:a965ae1d5218713c7823fbd95fa51b053"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afeb683c566a5a71303d05d2e12da2b28"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa9538a89536e8b6495551283116a588b"><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"><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:a4d49a722e60cd9993c182a29fbf74591"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a52581d514cad8b74a9fb42a026522f76"><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"><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#_a0">/home/kev/src/automotive-message-broker/lib/abstractroutingengine.h</a>.</dd> +</dl></div><h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="afeb683c566a5a71303d05d2e12da2b28"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void AbstractSink::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">inline</span><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="section see"><dt>See also</dt><dd>AbstractRoutingEngine::subscribeToPropertyChanges() </dd></dl> +<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> + +<p>Reimplemented in <a class="el" href="group__libamb.html#gaf58a77165e10549dc0e30f2d1b0d7b2f">AmbPlugin< T ></a>.</p> + +</div> +</div> +<a class="anchor" id="aa9538a89536e8b6495551283116a588b"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void AbstractSink::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">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p><a class="el" href="classAbstractSink.html#aa9538a89536e8b6495551283116a588b">supportedChanged()</a> is called when the supported properties changes </p><ul> +<li>supportedProperties the new list of supported properties. </li> +</ul> + +<p>Implemented in <a class="el" href="group__libamb.html#ga6a1098c5ae43cd731c7910efd36f6f7e">AmbPlugin< T ></a>.</p> + +</div> +</div> +<a class="anchor" id="a965ae1d5218713c7823fbd95fa51b053"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual const string AbstractSink::uuid </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>Pure virtual methods: </p> +<p><a class="el" href="classAbstractSink.html#a965ae1d5218713c7823fbd95fa51b053" title="Pure virtual methods: ">uuid()</a> is a unique identifier </p><dl class="section return"><dt>Returns</dt><dd>a guid-style unique identifier </dd></dl> + +<p>Implemented in <a class="el" href="group__libamb.html#ga84ad326ad2f861a8b028c0b99940d470">AmbPlugin< T ></a>.</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="abstractsink_8h_source.html">abstractsink.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> |