diff options
Diffstat (limited to '0.14/html/classAsyncRangePropertyReply.html')
| -rw-r--r-- | 0.14/html/classAsyncRangePropertyReply.html | 195 |
1 files changed, 195 insertions, 0 deletions
diff --git a/0.14/html/classAsyncRangePropertyReply.html b/0.14/html/classAsyncRangePropertyReply.html new file mode 100644 index 00000000..065d6c60 --- /dev/null +++ b/0.14/html/classAsyncRangePropertyReply.html @@ -0,0 +1,195 @@ +<!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: AsyncRangePropertyReply 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="#pub-attribs">Public Attributes</a> | +<a href="classAsyncRangePropertyReply-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">AsyncRangePropertyReply Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>The <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> class is used by a source to reply to an <a class="el" href="classAsyncRangePropertyRequest.html" title="The AsyncRangePropertyRequest class is used by sinks to request values within a time or sequence rang...">AsyncRangePropertyRequest</a>. 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. + <a href="classAsyncRangePropertyReply.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="abstractroutingengine_8h_source.html">abstractroutingengine.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for AsyncRangePropertyReply:</div> +<div class="dyncontent"> +<div class="center"><img src="classAsyncRangePropertyReply__inherit__graph.png" border="0" usemap="#AsyncRangePropertyReply_inherit__map" alt="Inheritance graph"/></div> +<map name="AsyncRangePropertyReply_inherit__map" id="AsyncRangePropertyReply_inherit__map"> +<area shape="rect" id="node2" href="classAsyncRangePropertyRequest.html" title="The AsyncRangePropertyRequest class is used by sinks to request values within a time or sequence rang..." alt="" coords="5,5,200,32"/> +</map> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> +<div class="dynheader"> +Collaboration diagram for AsyncRangePropertyReply:</div> +<div class="dyncontent"> +<div class="center"><img src="classAsyncRangePropertyReply__coll__graph.png" border="0" usemap="#AsyncRangePropertyReply_coll__map" alt="Collaboration graph"/></div> +<map name="AsyncRangePropertyReply_coll__map" id="AsyncRangePropertyReply_coll__map"> +<area shape="rect" id="node2" href="classAsyncRangePropertyRequest.html" title="The AsyncRangePropertyRequest class is used by sinks to request values within a time or sequence rang..." alt="" coords="5,5,200,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:ac253016c5ff4dc8e0ac11f8e98a16025"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac253016c5ff4dc8e0ac11f8e98a16025"></a> + </td><td class="memItemRight" valign="bottom"><b>AsyncRangePropertyReply</b> (<a class="el" href="classAsyncRangePropertyRequest.html">AsyncRangePropertyRequest</a> request)</td></tr> +<tr class="separator:ac253016c5ff4dc8e0ac11f8e98a16025"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classAsyncRangePropertyRequest"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classAsyncRangePropertyRequest')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classAsyncRangePropertyRequest.html">AsyncRangePropertyRequest</a></td></tr> +<tr class="memitem:aefe0f0167ce9bcabcd4450a21c7ea0e5 inherit pub_methods_classAsyncRangePropertyRequest"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefe0f0167ce9bcabcd4450a21c7ea0e5"></a> + </td><td class="memItemRight" valign="bottom"><b>AsyncRangePropertyRequest</b> (const <a class="el" href="classAsyncRangePropertyRequest.html">AsyncRangePropertyRequest</a> &request)</td></tr> +<tr class="separator:aefe0f0167ce9bcabcd4450a21c7ea0e5 inherit pub_methods_classAsyncRangePropertyRequest"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:a43762c9a2d88ec91e3218f7eca297e56"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a43762c9a2d88ec91e3218f7eca297e56"></a> +<a class="el" href="classAsyncPropertyReply.html#ad91affaa25fcc3b73947a6cf4591e5d1">AsyncPropertyReply::Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsyncRangePropertyReply.html#a43762c9a2d88ec91e3218f7eca297e56">error</a></td></tr> +<tr class="memdesc:a43762c9a2d88ec91e3218f7eca297e56"><td class="mdescLeft"> </td><td class="mdescRight">error this is set if there was an error in the request. "success" will also be set to false. <br /></td></tr> +<tr class="separator:a43762c9a2d88ec91e3218f7eca297e56"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4ce96fd40ce8ec3fddab46652026734b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ce96fd40ce8ec3fddab46652026734b"></a> +std::list< <a class="el" href="classAbstractPropertyType.html">AbstractPropertyType</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsyncRangePropertyReply.html#a4ce96fd40ce8ec3fddab46652026734b">values</a></td></tr> +<tr class="memdesc:a4ce96fd40ce8ec3fddab46652026734b"><td class="mdescLeft"> </td><td class="mdescRight">values if the request was successful, this will contain a list of values meeting the criteria of the request. <br /></td></tr> +<tr class="separator:a4ce96fd40ce8ec3fddab46652026734b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4eab37dada60970211e62b0fc3aeac92"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4eab37dada60970211e62b0fc3aeac92"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsyncRangePropertyReply.html#a4eab37dada60970211e62b0fc3aeac92">success</a></td></tr> +<tr class="memdesc:a4eab37dada60970211e62b0fc3aeac92"><td class="mdescLeft"> </td><td class="mdescRight">success this will be true if the request was successful. If not, this is false and error is set. <br /></td></tr> +<tr class="separator:a4eab37dada60970211e62b0fc3aeac92"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_attribs_classAsyncRangePropertyRequest"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classAsyncRangePropertyRequest')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="classAsyncRangePropertyRequest.html">AsyncRangePropertyRequest</a></td></tr> +<tr class="memitem:afd6f95a06376fef905faf5ab1b580bc9 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd6f95a06376fef905faf5ab1b580bc9"></a> +PropertyList </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsyncRangePropertyRequest.html#afd6f95a06376fef905faf5ab1b580bc9">properties</a></td></tr> +<tr class="memdesc:afd6f95a06376fef905faf5ab1b580bc9 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="mdescLeft"> </td><td class="mdescRight">properties list of properties to request <br /></td></tr> +<tr class="separator:afd6f95a06376fef905faf5ab1b580bc9 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a626258d5d401e0598d619b84600689f9 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a626258d5d401e0598d619b84600689f9"></a> +std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsyncRangePropertyRequest.html#a626258d5d401e0598d619b84600689f9">sourceUuid</a></td></tr> +<tr class="memdesc:a626258d5d401e0598d619b84600689f9 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="mdescLeft"> </td><td class="mdescRight">sourceUuid if the sink wishes to request a specific source, this should be set to the uuid of the source. <br /></td></tr> +<tr class="separator:a626258d5d401e0598d619b84600689f9 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a045f1320e9152de5e97f0b4de5c061da inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a045f1320e9152de5e97f0b4de5c061da"></a> +Zone::Type </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsyncRangePropertyRequest.html#a045f1320e9152de5e97f0b4de5c061da">zone</a></td></tr> +<tr class="memdesc:a045f1320e9152de5e97f0b4de5c061da inherit pub_attribs_classAsyncRangePropertyRequest"><td class="mdescLeft"> </td><td class="mdescRight">zone if the sink wishes to request a specific zone, this should be set to the desired zone . <br /></td></tr> +<tr class="separator:a045f1320e9152de5e97f0b4de5c061da inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a81777a8e0304bd6929c05d39c650454d inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a81777a8e0304bd6929c05d39c650454d"></a> +GetRangedPropertyCompletedSignal </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsyncRangePropertyRequest.html#a81777a8e0304bd6929c05d39c650454d">completed</a></td></tr> +<tr class="memdesc:a81777a8e0304bd6929c05d39c650454d inherit pub_attribs_classAsyncRangePropertyRequest"><td class="mdescLeft"> </td><td class="mdescRight">completed callback 'completed' is called when the ranged request is complete. The reply from this request is passed into the completed call. The completed callback must free the reply before it returns or there will be a leak. <br /></td></tr> +<tr class="separator:a81777a8e0304bd6929c05d39c650454d inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2dc2927f6c771707f15a767358a58e69 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2dc2927f6c771707f15a767358a58e69"></a> +double </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsyncRangePropertyRequest.html#a2dc2927f6c771707f15a767358a58e69">timeBegin</a></td></tr> +<tr class="memdesc:a2dc2927f6c771707f15a767358a58e69 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="mdescLeft"> </td><td class="mdescRight">timeBegin Set this to request values for the specified property beggining at this time. Time is seconds\ since the unix epoc. Set this to '0' if you do not want values within a time range. <br /></td></tr> +<tr class="separator:a2dc2927f6c771707f15a767358a58e69 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acd2a28137c227b0fb6a51576d84f5f30 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd2a28137c227b0fb6a51576d84f5f30"></a> +double </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsyncRangePropertyRequest.html#acd2a28137c227b0fb6a51576d84f5f30">timeEnd</a></td></tr> +<tr class="memdesc:acd2a28137c227b0fb6a51576d84f5f30 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="mdescLeft"> </td><td class="mdescRight">timeEnd Set this to request values for the specified property beggining at this time. Time is seconds\ since the unix epoc. Set this to '0' if you do not want values within a time range. <br /></td></tr> +<tr class="separator:acd2a28137c227b0fb6a51576d84f5f30 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a024dab8e12c45ea8988b7f3e4b3c85c0 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a024dab8e12c45ea8988b7f3e4b3c85c0"></a> +int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsyncRangePropertyRequest.html#a024dab8e12c45ea8988b7f3e4b3c85c0">sequenceBegin</a></td></tr> +<tr class="memdesc:a024dab8e12c45ea8988b7f3e4b3c85c0 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="mdescLeft"> </td><td class="mdescRight">sequenceBegin set this to request values with a sequence >= to the sequenceBegin value. Set to -1 if you don't want values within a sequence ranges. <br /></td></tr> +<tr class="separator:a024dab8e12c45ea8988b7f3e4b3c85c0 inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a352afdecef1d1e6fc1f82384d0c9edfe inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a352afdecef1d1e6fc1f82384d0c9edfe"></a> +int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsyncRangePropertyRequest.html#a352afdecef1d1e6fc1f82384d0c9edfe">sequenceEnd</a></td></tr> +<tr class="memdesc:a352afdecef1d1e6fc1f82384d0c9edfe inherit pub_attribs_classAsyncRangePropertyRequest"><td class="mdescLeft"> </td><td class="mdescRight">sequenceEnd set this to request values with a sequence <= to the sequenceEnd value. Set to -1 if you don't want values within a sequence ranges. <br /></td></tr> +<tr class="separator:a352afdecef1d1e6fc1f82384d0c9edfe inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab93b9cc82ead929a6e1f72be699fbb6c inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab93b9cc82ead929a6e1f72be699fbb6c"></a> +std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAsyncRangePropertyRequest.html#ab93b9cc82ead929a6e1f72be699fbb6c">pid</a></td></tr> +<tr class="memdesc:ab93b9cc82ead929a6e1f72be699fbb6c inherit pub_attribs_classAsyncRangePropertyRequest"><td class="mdescLeft"> </td><td class="mdescRight">pid requesting process id <br /></td></tr> +<tr class="separator:ab93b9cc82ead929a6e1f72be699fbb6c inherit pub_attribs_classAsyncRangePropertyRequest"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>The <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> class is used by a source to reply to an <a class="el" href="classAsyncRangePropertyRequest.html" title="The AsyncRangePropertyRequest class is used by sinks to request values within a time or sequence rang...">AsyncRangePropertyRequest</a>. 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. </p> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_2home_2kev_2src_2automotive-message-broker_2lib_2abstractroutingengine_8h-example.html#_a3">/home/kev/src/automotive-message-broker/lib/abstractroutingengine.h</a>.</dd> +</dl></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="abstractroutingengine_8h_source.html">abstractroutingengine.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> |