diff options
Diffstat (limited to '0.14/interfacePluginSegment.html')
| -rw-r--r-- | 0.14/interfacePluginSegment.html | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/0.14/interfacePluginSegment.html b/0.14/interfacePluginSegment.html new file mode 100644 index 00000000..8c4820db --- /dev/null +++ b/0.14/interfacePluginSegment.html @@ -0,0 +1,147 @@ +<!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: PluginSegment Interface 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-attribs">Public Attributes</a> | +<a href="interfacePluginSegment-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">PluginSegment Interface Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><a class="el" href="interfacePluginSegment.html" title="PluginSegment root object for plugin segments. PluginSegment inherits the attributes from Plugin and ...">PluginSegment</a> root object for plugin segments. <a class="el" href="interfacePluginSegment.html" title="PluginSegment root object for plugin segments. PluginSegment inherits the attributes from Plugin and ...">PluginSegment</a> inherits the attributes from <a class="el" href="interfacePlugin.html" title="the Plugin interface describes the configuration for a plugin. This interface may be extended with pl...">Plugin</a> and adds the "enabled" attribute. Only plugins that have 'enabled' : true will be loaded by the AMB daemon. PluginSements are usually installed in /etc/ambd/plugins.d. The following is a basic example of a plugin segment configuration: + <a href="interfacePluginSegment.html#details">More...</a></p> + +<p><code>import"<a class="el" href="ambd-configuration_8idl_source.html">ambd-configuration.idl</a>";</code></p> +<div class="dynheader"> +Inheritance diagram for PluginSegment:</div> +<div class="dyncontent"> +<div class="center"><img src="interfacePluginSegment__inherit__graph.png" border="0" usemap="#PluginSegment_inherit__map" alt="Inheritance graph"/></div> +<map name="PluginSegment_inherit__map" id="PluginSegment_inherit__map"> +<area shape="rect" id="node2" href="interfacePlugin.html" title="the Plugin interface describes the configuration for a plugin. This interface may be extended with pl..." alt="" coords="31,5,90,32"/> +</map> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> +<div class="dynheader"> +Collaboration diagram for PluginSegment:</div> +<div class="dyncontent"> +<div class="center"><img src="interfacePluginSegment__coll__graph.png" border="0" usemap="#PluginSegment_coll__map" alt="Collaboration graph"/></div> +<map name="PluginSegment_coll__map" id="PluginSegment_coll__map"> +<area shape="rect" id="node2" href="interfacePlugin.html" title="the Plugin interface describes the configuration for a plugin. This interface may be extended with pl..." alt="" coords="31,5,90,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-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:a4f7af4204c2c84960a855ab7a5b1ddd8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f7af4204c2c84960a855ab7a5b1ddd8"></a> +readonly attribute boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacePluginSegment.html#a4f7af4204c2c84960a855ab7a5b1ddd8">enabled</a></td></tr> +<tr class="memdesc:a4f7af4204c2c84960a855ab7a5b1ddd8"><td class="mdescLeft"> </td><td class="mdescRight">enabled - returns true if the plugin is enabled or not. <br /></td></tr> +<tr class="separator:a4f7af4204c2c84960a855ab7a5b1ddd8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_attribs_interfacePlugin"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_interfacePlugin')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="interfacePlugin.html">Plugin</a></td></tr> +<tr class="memitem:aeb17b357ddf4dc76ccc940009dbc24d3 inherit pub_attribs_interfacePlugin"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb17b357ddf4dc76ccc940009dbc24d3"></a> +readonly attribute DOMString </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacePlugin.html#aeb17b357ddf4dc76ccc940009dbc24d3">name</a></td></tr> +<tr class="memdesc:aeb17b357ddf4dc76ccc940009dbc24d3 inherit pub_attribs_interfacePlugin"><td class="mdescLeft"> </td><td class="mdescRight">name of plugin (ie 'ExamplePlugin') <br /></td></tr> +<tr class="separator:aeb17b357ddf4dc76ccc940009dbc24d3 inherit pub_attribs_interfacePlugin"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa2dff3a4c94a5c21f36cd8124135ffeb inherit pub_attribs_interfacePlugin"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2dff3a4c94a5c21f36cd8124135ffeb"></a> +readonly attribute DOMString </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacePlugin.html#aa2dff3a4c94a5c21f36cd8124135ffeb">path</a></td></tr> +<tr class="memdesc:aa2dff3a4c94a5c21f36cd8124135ffeb inherit pub_attribs_interfacePlugin"><td class="mdescLeft"> </td><td class="mdescRight">path to the plugins .so file (ie /usr/local/lib/automotive-message-broker/examplesourceplugin.so) <br /></td></tr> +<tr class="separator:aa2dff3a4c94a5c21f36cd8124135ffeb inherit pub_attribs_interfacePlugin"><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="interfacePluginSegment.html" title="PluginSegment root object for plugin segments. PluginSegment inherits the attributes from Plugin and ...">PluginSegment</a> root object for plugin segments. <a class="el" href="interfacePluginSegment.html" title="PluginSegment root object for plugin segments. PluginSegment inherits the attributes from Plugin and ...">PluginSegment</a> inherits the attributes from <a class="el" href="interfacePlugin.html" title="the Plugin interface describes the configuration for a plugin. This interface may be extended with pl...">Plugin</a> and adds the "enabled" attribute. Only plugins that have 'enabled' : true will be loaded by the AMB daemon. PluginSements are usually installed in /etc/ambd/plugins.d. The following is a basic example of a plugin segment configuration: </p> +<div class="fragment"><div class="line">{</div><div class="line"> <span class="stringliteral">"name"</span> : <span class="stringliteral">"MyPlugin"</span>,</div><div class="line"> <span class="stringliteral">"path"</span> : <span class="stringliteral">"/usr/local/lib/automotive-message-broker/myplugin.so"</span>,</div><div class="line"> <span class="stringliteral">"enabled"</span> : <span class="keyword">false</span></div><div class="line">}</div></div><!-- fragment --> </div><hr/>The documentation for this interface was generated from the following file:<ul> +<li><a class="el" href="ambd-configuration_8idl_source.html">ambd-configuration.idl</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> |