Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-15 17:41:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add API docs for 1.3.9

Browse Source
This commit is contained in:
Dennis Klein
2019-08-07 18:00:46 +02:00
parent f1c3c5f6c4
commit 95b8ff7858
1169 changed files with 49740 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

146
v1.3.9/classfair_1_1mq_1_1DeviceRunner.html Normal file
View File

@@ -0,0 +1,146 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FairMQ: fair::mq::DeviceRunner 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.3.9</span>
</div>
<div id="projectbrief">C++ Message Passing Framework</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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_1DeviceRunner.html">DeviceRunner</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classfair_1_1mq_1_1DeviceRunner-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fair::mq::DeviceRunner Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Utility class to facilitate a convenient top-level device launch/shutdown.
<a href="classfair_1_1mq_1_1DeviceRunner.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="DeviceRunner_8h_source.html">fairmq/DeviceRunner.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for fair::mq::DeviceRunner:</div>
<div class="dyncontent">
<div class="center"><img src="classfair_1_1mq_1_1DeviceRunner__coll__graph.png" border="0" usemap="#fair_1_1mq_1_1DeviceRunner_coll__map" alt="Collaboration graph"/></div>
<map name="fair_1_1mq_1_1DeviceRunner_coll__map" id="fair_1_1mq_1_1DeviceRunner_coll__map">
<area shape="rect" title="Utility class to facilitate a convenient top&#45;level device launch/shutdown." alt="" coords="95,95,249,121"/>
<area shape="rect" href="classfair_1_1mq_1_1PluginManager.html" title="manages and owns plugin instances" alt="" coords="5,5,165,32"/>
<area shape="rect" href="classFairMQProgOptions.html" title=" " alt="" coords="190,5,327,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:a918804c754ee6b8dca4511246cbf59cd"><td class="memItemLeft" align="right" valign="top"><a id="a918804c754ee6b8dca4511246cbf59cd"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DeviceRunner</b> (int argc, char *const argv[], bool printLogo=true)</td></tr>
<tr class="separator:a918804c754ee6b8dca4511246cbf59cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c6e72a3814eb83d5e34b9ab43af757c"><td class="memItemLeft" align="right" valign="top"><a id="a2c6e72a3814eb83d5e34b9ab43af757c"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>Run</b> () -&gt; int</td></tr>
<tr class="separator:a2c6e72a3814eb83d5e34b9ab43af757c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7e3b497cb7c7f6f9a5cdb3c1f473119"><td class="memItemLeft" align="right" valign="top"><a id="ac7e3b497cb7c7f6f9a5cdb3c1f473119"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>RunWithExceptionHandlers</b> () -&gt; int</td></tr>
<tr class="separator:ac7e3b497cb7c7f6f9a5cdb3c1f473119"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a621ca2eeda693106a1eed7bcd97139d7"><td class="memTemplParams" colspan="2"><a id="a621ca2eeda693106a1eed7bcd97139d7"></a>
template&lt;typename H &gt; </td></tr>
<tr class="memitem:a621ca2eeda693106a1eed7bcd97139d7"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>AddHook</b> (std::function&lt; void(<a class="el" href="classfair_1_1mq_1_1DeviceRunner.html">DeviceRunner</a> &amp;)&gt; hook) -&gt; void</td></tr>
<tr class="separator:a621ca2eeda693106a1eed7bcd97139d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3211db4793e6fcc735cbbef8ad4460a"><td class="memTemplParams" colspan="2"><a id="af3211db4793e6fcc735cbbef8ad4460a"></a>
template&lt;typename H &gt; </td></tr>
<tr class="memitem:af3211db4793e6fcc735cbbef8ad4460a"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>RemoveHook</b> () -&gt; void</td></tr>
<tr class="separator:af3211db4793e6fcc735cbbef8ad4460a"><td class="memSeparator" colspan="2">&#160;</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:a4fef680e2db0327f441949df7b1f676d"><td class="memItemLeft" align="right" valign="top"><a id="a4fef680e2db0327f441949df7b1f676d"></a>
std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>fRawCmdLineArgs</b></td></tr>
<tr class="separator:a4fef680e2db0327f441949df7b1f676d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0cb66f35d080a7e5adeffcf487e836e"><td class="memItemLeft" align="right" valign="top"><a id="ae0cb66f35d080a7e5adeffcf487e836e"></a>
<a class="el" href="classFairMQProgOptions.html">FairMQProgOptions</a>&#160;</td><td class="memItemRight" valign="bottom"><b>fConfig</b></td></tr>
<tr class="separator:ae0cb66f35d080a7e5adeffcf487e836e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40ed1496b3bb7269c6bfd6e039fad5ff"><td class="memItemLeft" align="right" valign="top"><a id="a40ed1496b3bb7269c6bfd6e039fad5ff"></a>
std::unique_ptr&lt; <a class="el" href="classFairMQDevice.html">FairMQDevice</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>fDevice</b></td></tr>
<tr class="separator:a40ed1496b3bb7269c6bfd6e039fad5ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43f3b62b6b7f9a2ed0b115d5ed496889"><td class="memItemLeft" align="right" valign="top"><a id="a43f3b62b6b7f9a2ed0b115d5ed496889"></a>
<a class="el" href="classfair_1_1mq_1_1PluginManager.html">PluginManager</a>&#160;</td><td class="memItemRight" valign="bottom"><b>fPluginManager</b></td></tr>
<tr class="separator:a43f3b62b6b7f9a2ed0b115d5ed496889"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf2edd7d88823b00846d2333f6c7a25f"><td class="memItemLeft" align="right" valign="top"><a id="adf2edd7d88823b00846d2333f6c7a25f"></a>
const bool&#160;</td><td class="memItemRight" valign="bottom"><b>fPrintLogo</b></td></tr>
<tr class="separator:adf2edd7d88823b00846d2333f6c7a25f"><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>Utility class to facilitate a convenient top-level device launch/shutdown. </p>
<p>Runs a single FairMQ device with config and plugin support.</p>
<p>For customization user hooks are executed at various steps during device launch/shutdown in the following sequence: </p><pre class="fragment"> LoadPlugins
|
v
</pre><p> SetCustomCmdLineOptions | v ModifyRawCmdLineArgs | v InstatiateDevice</p>
<p>Each hook has access to all members of the <a class="el" href="classfair_1_1mq_1_1DeviceRunner.html" title="Utility class to facilitate a convenient top-level device launch/shutdown.">DeviceRunner</a> and really only differs by the point in time it is called.</p>
<p>For an example usage of this class see the <a class="el" href="runFairMQDevice_8h_source.html">fairmq/runFairMQDevice.h</a> header. </p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li>fairmq/<a class="el" href="DeviceRunner_8h_source.html">DeviceRunner.h</a></li>
<li>fairmq/DeviceRunner.cxx</li>
</ul>
</div><!-- contents -->
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>