diff options
Diffstat (limited to '0.14/abstractsource_8h_source.html')
| -rw-r--r-- | 0.14/abstractsource_8h_source.html | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/0.14/abstractsource_8h_source.html b/0.14/abstractsource_8h_source.html new file mode 100644 index 00000000..008e02ab --- /dev/null +++ b/0.14/abstractsource_8h_source.html @@ -0,0 +1,120 @@ +<!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: /home/kev/src/automotive-message-broker/lib/abstractsource.h Source File</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><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><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="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File 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 id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">abstractsource.h</div> </div> +</div><!--header--> +<div class="contents"> +<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Copyright (C) 2012 Intel Corporation</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> This library is free software; you can redistribute it and/or</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> modify it under the terms of the GNU Lesser General Public</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> License as published by the Free Software Foundation; either</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> version 2.1 of the License, or (at your option) any later version.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> This library is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> Lesser General Public License for more details.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> License along with this library; if not, write to the Free Software</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ABSTRACTSOURCE_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ABSTRACTSOURCE_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <list></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <boost/any.hpp></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "abstractsink.h"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "vehicleproperty.h"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "abstractroutingengine.h"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "abstractpropertytype.h"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "propertyinfo.hpp"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span><a class="code" href="classAbstractSource.html">AbstractSource</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">typedef</span> std::list<AbstractSource*> SourceList;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classAbstractSource.html"> 41</a></span> <span class="keyword">class </span><a class="code" href="classAbstractSource.html">AbstractSource</a>: <span class="keyword">public</span> <a class="code" href="classAbstractSink.html">AbstractSink</a></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classAbstractSource.html#aad1e5e4914f2aa174dfd8fa6e143c1b9"> 48</a></span>  <span class="keyword">enum</span> <a class="code" href="classAbstractSource.html#aad1e5e4914f2aa174dfd8fa6e143c1b9">Operations</a> {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  Get = 0x01,</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  Set = 0x02,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  GetRanged = 0x04</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  };</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classAbstractSource.html">AbstractSource</a>(<a class="code" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a>* engine, map<string, string> config);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">virtual</span> ~<a class="code" href="classAbstractSource.html">AbstractSource</a>();</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classAbstractSource.html#a05589e699ea16a14675db226d51bdf9f">getPropertyAsync</a>(<a class="code" href="classAsyncPropertyReply.html">AsyncPropertyReply</a> *reply) = 0;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classAbstractSource.html#a3b30f939d68889b2540f6035fa5be7c7">getRangePropertyAsync</a>(<a class="code" href="classAsyncRangePropertyReply.html">AsyncRangePropertyReply</a> *reply) = 0;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">virtual</span> <a class="code" href="classAsyncPropertyReply.html">AsyncPropertyReply</a> * <a class="code" href="classAbstractSource.html#a684b58112b5572dfe8cb94380bf7d74a">setProperty</a>(<a class="code" href="classAsyncSetPropertyRequest.html">AsyncSetPropertyRequest</a> request) = 0;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classAbstractSource.html#ae9c042e159f080c298b2ae37c47618e9">subscribeToPropertyChanges</a>(VehicleProperty::Property property) = 0;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classAbstractSource.html#a584372310f191b1b9067a634b7366023">unsubscribeToPropertyChanges</a>(VehicleProperty::Property property) = 0;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classAbstractSource.html#a317861675652372a72fc01c075036b51">supportedOperations</a>() = 0;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">virtual</span> PropertyInfo <a class="code" href="classAbstractSource.html#a4e15ea9df2144be322968003621580c4">getPropertyInfo</a>(<span class="keyword">const</span> VehicleProperty::Property & property) = 0;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">virtual</span> PropertyList <a class="code" href="classAbstractSource.html#ad8330cbbac84dc24851eb50ff7243460">supported</a>() = 0;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="classAbstractSource.html#aabbce93fea123c54be55a007c928a6f1"> 122</a></span>  <a class="code" href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a>* <a class="code" href="classAbstractSource.html#aabbce93fea123c54be55a007c928a6f1">routingEngine</a>;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <a class="code" href="classAbstractSource.html">AbstractSource</a>():<a class="code" href="classAbstractSink.html">AbstractSink</a>(nullptr, <a class="code" href="namespacestd.html">std</a>::map<<a class="code" href="namespacestd.html">std</a>::string,<a class="code" href="namespacestd.html">std</a>::string>()) { }</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> };</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="preprocessor">#endif // ABSTRACTSOURCE_H</span></div><div class="ttc" id="classAbstractSource_html_a584372310f191b1b9067a634b7366023"><div class="ttname"><a href="classAbstractSource.html#a584372310f191b1b9067a634b7366023">AbstractSource::unsubscribeToPropertyChanges</a></div><div class="ttdeci">virtual void unsubscribeToPropertyChanges(VehicleProperty::Property property)=0</div><div class="ttdoc">unsubscribeToPropertyChanges is called when a sink requests to unsubscribe from a given property&#39;s ch...</div></div> +<div class="ttc" id="classAbstractRoutingEngine_html"><div class="ttname"><a href="classAbstractRoutingEngine.html">AbstractRoutingEngine</a></div><div class="ttdef"><b>Definition:</b> abstractroutingengine.h:366</div></div> +<div class="ttc" id="classAbstractSource_html_aad1e5e4914f2aa174dfd8fa6e143c1b9"><div class="ttname"><a href="classAbstractSource.html#aad1e5e4914f2aa174dfd8fa6e143c1b9">AbstractSource::Operations</a></div><div class="ttdeci">Operations</div><div class="ttdoc">The Operations enum is a bitmask flag used to specify which operations are supported by the source pl...</div><div class="ttdef"><b>Definition:</b> abstractsource.h:48</div></div> +<div class="ttc" id="classAbstractSource_html_ad8330cbbac84dc24851eb50ff7243460"><div class="ttname"><a href="classAbstractSource.html#ad8330cbbac84dc24851eb50ff7243460">AbstractSource::supported</a></div><div class="ttdeci">virtual PropertyList supported()=0</div><div class="ttdoc">supported </div></div> +<div class="ttc" id="namespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdef"><b>Definition:</b> picojson.h:1002</div></div> +<div class="ttc" id="classAbstractSource_html_aabbce93fea123c54be55a007c928a6f1"><div class="ttname"><a href="classAbstractSource.html#aabbce93fea123c54be55a007c928a6f1">AbstractSource::routingEngine</a></div><div class="ttdeci">AbstractRoutingEngine * routingEngine</div><div class="ttdoc">routingEngine the core routing engine used to send property updates to sink plugins. </div><div class="ttdef"><b>Definition:</b> abstractsource.h:122</div></div> +<div class="ttc" id="classAbstractSource_html_ae9c042e159f080c298b2ae37c47618e9"><div class="ttname"><a href="classAbstractSource.html#ae9c042e159f080c298b2ae37c47618e9">AbstractSource::subscribeToPropertyChanges</a></div><div class="ttdeci">virtual void subscribeToPropertyChanges(VehicleProperty::Property property)=0</div><div class="ttdoc">subscribeToPropertyChanges is called when a sink requests a subscription. Source plugins can keep tra...</div></div> +<div class="ttc" id="classAbstractSource_html_a05589e699ea16a14675db226d51bdf9f"><div class="ttname"><a href="classAbstractSource.html#a05589e699ea16a14675db226d51bdf9f">AbstractSource::getPropertyAsync</a></div><div class="ttdeci">virtual void getPropertyAsync(AsyncPropertyReply *reply)=0</div><div class="ttdoc">pure virtual methods: </div></div> +<div class="ttc" id="classAsyncPropertyReply_html"><div class="ttname"><a href="classAsyncPropertyReply.html">AsyncPropertyReply</a></div><div class="ttdoc">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 &#39;false&#39; if the request was not successful and set &#39;error&#39; to the appropriate error. </div><div class="ttdef"><b>Definition:</b> abstractroutingengine.h:123</div></div> +<div class="ttc" id="classAsyncSetPropertyRequest_html"><div class="ttname"><a href="classAsyncSetPropertyRequest.html">AsyncSetPropertyRequest</a></div><div class="ttdoc">The AsyncSetPropertyRequest class is used by sinks to set a property to the &#39;value&#39;. The source will reply with a AsyncPropertyReply containing the new value or an error. </div><div class="ttdef"><b>Definition:</b> abstractroutingengine.h:219</div></div> +<div class="ttc" id="classAsyncRangePropertyReply_html"><div class="ttname"><a href="classAsyncRangePropertyReply.html">AsyncRangePropertyReply</a></div><div class="ttdoc">The AsyncRangePropertyReply class is used by a source to reply to an AsyncRangePropertyRequest. The source should set success to &#39;true&#39; and populate the &#39;values&#39; member if the request was successful. If the request is not successful, &#39;success&#39; should be set to &#39;false&#39; and the &#39;error&#39; member should be set. </div><div class="ttdef"><b>Definition:</b> abstractroutingengine.h:331</div></div> +<div class="ttc" id="classAbstractSink_html"><div class="ttname"><a href="classAbstractSink.html">AbstractSink</a></div><div class="ttdef"><b>Definition:</b> abstractsink.h:40</div></div> +<div class="ttc" id="classAbstractSource_html_a4e15ea9df2144be322968003621580c4"><div class="ttname"><a href="classAbstractSource.html#a4e15ea9df2144be322968003621580c4">AbstractSource::getPropertyInfo</a></div><div class="ttdeci">virtual PropertyInfo getPropertyInfo(const VehicleProperty::Property &property)=0</div><div class="ttdoc">getPropertyInfo used to return specific information about a property </div></div> +<div class="ttc" id="classAbstractSource_html_a684b58112b5572dfe8cb94380bf7d74a"><div class="ttname"><a href="classAbstractSource.html#a684b58112b5572dfe8cb94380bf7d74a">AbstractSource::setProperty</a></div><div class="ttdeci">virtual AsyncPropertyReply * setProperty(AsyncSetPropertyRequest request)=0</div><div class="ttdoc">setProperty is called when a sink requests to set a value for a given property. This is only called i...</div></div> +<div class="ttc" id="classAbstractSource_html_a3b30f939d68889b2540f6035fa5be7c7"><div class="ttname"><a href="classAbstractSource.html#a3b30f939d68889b2540f6035fa5be7c7">AbstractSource::getRangePropertyAsync</a></div><div class="ttdeci">virtual void getRangePropertyAsync(AsyncRangePropertyReply *reply)=0</div><div class="ttdoc">getRangePropertyAsync is called when a sink requests a series of values for a given property within a...</div></div> +<div class="ttc" id="classAbstractSource_html_a317861675652372a72fc01c075036b51"><div class="ttname"><a href="classAbstractSource.html#a317861675652372a72fc01c075036b51">AbstractSource::supportedOperations</a></div><div class="ttdeci">virtual int supportedOperations()=0</div><div class="ttdoc">supportedOperations </div></div> +<div class="ttc" id="classAbstractSource_html"><div class="ttname"><a href="classAbstractSource.html">AbstractSource</a></div><div class="ttdef"><b>Definition:</b> abstractsource.h:41</div></div> +</div><!-- fragment --></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> |