Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-13 00:31:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
FairMQ/v1.2.1/classfair_1_1mq_1_1PluginManager.html
Dennis Klein 83fa4bb6d9
Add API docs for 1.2.1
2018-05-04 22:17:56 +02:00

165 lines
12 KiB
HTML
Raw Permalink Blame History

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FairMQ: fair::mq::PluginManager 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>
<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">FairMQ
&#160;<span id="projectnumber">1.2.1</span>
</div>
<div id="projectbrief">C++ Message Passing Framework</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></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="namespacefair.html">fair</a></li><li class="navelem"><b>mq</b></li><li class="navelem"><a class="el" href="classfair_1_1mq_1_1PluginManager.html">PluginManager</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classfair_1_1mq_1_1PluginManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fair::mq::PluginManager Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>manages and owns plugin instances
<a href="classfair_1_1mq_1_1PluginManager.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PluginManager_8h_source.html">fairmq/PluginManager.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1PluginManager_1_1BadSearchPath.html">BadSearchPath</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1PluginManager_1_1PluginInstantiationError.html">PluginInstantiationError</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1PluginManager_1_1PluginLoadError.html">PluginLoadError</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1PluginManager_1_1ProgramOptionsParseError.html">ProgramOptionsParseError</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a093417f2e29e4f3082c367b28600e7de"><td class="memItemLeft" align="right" valign="top"><a id="a093417f2e29e4f3082c367b28600e7de"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>PluginFactory</b> = std::shared_ptr&lt; <a class="el" href="classfair_1_1mq_1_1Plugin.html">fair::mq::Plugin</a> &gt;(<a class="el" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a> &amp;)</td></tr>
<tr class="separator:a093417f2e29e4f3082c367b28600e7de"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a1427b0d6fc67ca0c716926251b8bc9f3"><td class="memItemLeft" align="right" valign="top"><a id="a1427b0d6fc67ca0c716926251b8bc9f3"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>SetSearchPaths</b> (const std::vector&lt; boost::filesystem::path &gt; &amp;) -&gt; void</td></tr>
<tr class="separator:a1427b0d6fc67ca0c716926251b8bc9f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d1c361ce2e9187e7d17c63d657eab6c"><td class="memItemLeft" align="right" valign="top"><a id="a8d1c361ce2e9187e7d17c63d657eab6c"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>AppendSearchPath</b> (const boost::filesystem::path &amp;) -&gt; void</td></tr>
<tr class="separator:a8d1c361ce2e9187e7d17c63d657eab6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac0f54038a5054c7f7fecb0ac76c3c66"><td class="memItemLeft" align="right" valign="top"><a id="aac0f54038a5054c7f7fecb0ac76c3c66"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>PrependSearchPath</b> (const boost::filesystem::path &amp;) -&gt; void</td></tr>
<tr class="separator:aac0f54038a5054c7f7fecb0ac76c3c66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1a9ccaf12bc4db5aac25dc11755b641"><td class="memItemLeft" align="right" valign="top"><a id="ad1a9ccaf12bc4db5aac25dc11755b641"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>SearchPaths</b> () const -&gt; const std::vector&lt; boost::filesystem::path &gt; &amp;</td></tr>
<tr class="separator:ad1a9ccaf12bc4db5aac25dc11755b641"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6a2bc82c4e06a19b1ad6c6f18971a3b"><td class="memItemLeft" align="right" valign="top"><a id="ae6a2bc82c4e06a19b1ad6c6f18971a3b"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>LoadPlugin</b> (const std::string &amp;pluginName) -&gt; void</td></tr>
<tr class="separator:ae6a2bc82c4e06a19b1ad6c6f18971a3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b314b20f061f25f1a6b2da01bf134b8"><td class="memItemLeft" align="right" valign="top"><a id="a3b314b20f061f25f1a6b2da01bf134b8"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>LoadPlugins</b> (const std::vector&lt; std::string &gt; &amp;pluginNames) -&gt; void</td></tr>
<tr class="separator:a3b314b20f061f25f1a6b2da01bf134b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfe1f5aba800b08ea96f0ddc6cdf79c1"><td class="memItemLeft" align="right" valign="top"><a id="acfe1f5aba800b08ea96f0ddc6cdf79c1"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>InstantiatePlugins</b> () -&gt; void</td></tr>
<tr class="separator:acfe1f5aba800b08ea96f0ddc6cdf79c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b102f28eb49d3d38d78933d951a1c0b"><td class="memItemLeft" align="right" valign="top"><a id="a1b102f28eb49d3d38d78933d951a1c0b"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>ForEachPlugin</b> (std::function&lt; void(<a class="el" href="classfair_1_1mq_1_1Plugin.html">Plugin</a> &amp;)&gt; func) -&gt; void</td></tr>
<tr class="separator:a1b102f28eb49d3d38d78933d951a1c0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea0651326c89dd3a56ed86e68c8c9e61"><td class="memItemLeft" align="right" valign="top"><a id="aea0651326c89dd3a56ed86e68c8c9e61"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>ForEachPluginProgOptions</b> (std::function&lt; void(boost::program_options::options_description)&gt; func) const -&gt; void</td></tr>
<tr class="separator:aea0651326c89dd3a56ed86e68c8c9e61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af36269e340acfd1431a078e5c941d8ca"><td class="memTemplParams" colspan="2"><a id="af36269e340acfd1431a078e5c941d8ca"></a>
template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:af36269e340acfd1431a078e5c941d8ca"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>EmplacePluginServices</b> (Args &amp;&amp;... args) -&gt; void</td></tr>
<tr class="separator:af36269e340acfd1431a078e5c941d8ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69933c4bd7230aa691a8d525437ae266"><td class="memItemLeft" align="right" valign="top"><a id="a69933c4bd7230aa691a8d525437ae266"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>WaitForPluginsToReleaseDeviceControl</b> () -&gt; void</td></tr>
<tr class="separator:a69933c4bd7230aa691a8d525437ae266"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ab41d2e94845d5488f4ae40ca26c7a011"><td class="memItemLeft" align="right" valign="top"><a id="ab41d2e94845d5488f4ae40ca26c7a011"></a>
static auto&#160;</td><td class="memItemRight" valign="bottom"><b>ProgramOptions</b> () -&gt; boost::program_options::options_description</td></tr>
<tr class="separator:ab41d2e94845d5488f4ae40ca26c7a011"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2350947596da023a94c5d4647e08616"><td class="memItemLeft" align="right" valign="top"><a id="ac2350947596da023a94c5d4647e08616"></a>
static auto&#160;</td><td class="memItemRight" valign="bottom"><b>MakeFromCommandLineOptions</b> (const std::vector&lt; std::string &gt;) -&gt; std::shared_ptr&lt; <a class="el" href="classfair_1_1mq_1_1PluginManager.html">PluginManager</a> &gt;</td></tr>
<tr class="separator:ac2350947596da023a94c5d4647e08616"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98a38d6917984d55eac54c2d33f645f3"><td class="memItemLeft" align="right" valign="top"><a id="a98a38d6917984d55eac54c2d33f645f3"></a>
static auto&#160;</td><td class="memItemRight" valign="bottom"><b>LibPrefix</b> () -&gt; const std::string &amp;</td></tr>
<tr class="separator:a98a38d6917984d55eac54c2d33f645f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>manages and owns plugin instances </p>
<p>The plugin manager is responsible for the whole plugin lifecycle. It facilitates two plugin mechanisms: A prelinked dynamic plugins (shared libraries) B dynamic plugins (shared libraries) C static plugins (builtin) </p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li>fairmq/<a class="el" href="PluginManager_8h_source.html">PluginManager.h</a></li>
<li>fairmq/PluginManager.cxx</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink