mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
147 lines
9.3 KiB
HTML
147 lines
9.3 KiB
HTML
<!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::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
|
|
 <span id="projectnumber">1.2.3</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_1DeviceRunner.html">DeviceRunner</a></li> </ul>
|
|
</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="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 <<a class="el" href="DeviceRunner_8h_source.html">fairmq/DeviceRunner.h</a>></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" id="node2" href="classFairMQProgOptions.html" title="FairMQProgOptions" alt="" coords="18,81,163,108"/>
|
|
<area shape="rect" id="node3" href="classFairProgOptions.html" title="FairProgOptions" alt="" coords="29,5,153,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:aa22612dbf3e8b833a63164267224928c"><td class="memItemLeft" align="right" valign="top"><a id="aa22612dbf3e8b833a63164267224928c"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>DeviceRunner</b> (int argc, char *const argv[])</td></tr>
|
|
<tr class="separator:aa22612dbf3e8b833a63164267224928c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c6e72a3814eb83d5e34b9ab43af757c"><td class="memItemLeft" align="right" valign="top"><a id="a2c6e72a3814eb83d5e34b9ab43af757c"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>Run</b> () -> int</td></tr>
|
|
<tr class="separator:a2c6e72a3814eb83d5e34b9ab43af757c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7e3b497cb7c7f6f9a5cdb3c1f473119"><td class="memItemLeft" align="right" valign="top"><a id="ac7e3b497cb7c7f6f9a5cdb3c1f473119"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>RunWithExceptionHandlers</b> () -> int</td></tr>
|
|
<tr class="separator:ac7e3b497cb7c7f6f9a5cdb3c1f473119"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a621ca2eeda693106a1eed7bcd97139d7"><td class="memTemplParams" colspan="2"><a id="a621ca2eeda693106a1eed7bcd97139d7"></a>
|
|
template<typename H > </td></tr>
|
|
<tr class="memitem:a621ca2eeda693106a1eed7bcd97139d7"><td class="memTemplItemLeft" align="right" valign="top">auto </td><td class="memTemplItemRight" valign="bottom"><b>AddHook</b> (std::function< void(<a class="el" href="classfair_1_1mq_1_1DeviceRunner.html">DeviceRunner</a> &)> hook) -> void</td></tr>
|
|
<tr class="separator:a621ca2eeda693106a1eed7bcd97139d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3211db4793e6fcc735cbbef8ad4460a"><td class="memTemplParams" colspan="2"><a id="af3211db4793e6fcc735cbbef8ad4460a"></a>
|
|
template<typename H > </td></tr>
|
|
<tr class="memitem:af3211db4793e6fcc735cbbef8ad4460a"><td class="memTemplItemLeft" align="right" valign="top">auto </td><td class="memTemplItemRight" valign="bottom"><b>RemoveHook</b> () -> void</td></tr>
|
|
<tr class="separator:af3211db4793e6fcc735cbbef8ad4460a"><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:a4fef680e2db0327f441949df7b1f676d"><td class="memItemLeft" align="right" valign="top"><a id="a4fef680e2db0327f441949df7b1f676d"></a>
|
|
std::vector< std::string > </td><td class="memItemRight" valign="bottom"><b>fRawCmdLineArgs</b></td></tr>
|
|
<tr class="separator:a4fef680e2db0327f441949df7b1f676d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ae42895297c49ebdfa50ab3a07abfd4"><td class="memItemLeft" align="right" valign="top"><a id="a5ae42895297c49ebdfa50ab3a07abfd4"></a>
|
|
std::shared_ptr< <a class="el" href="classfair_1_1mq_1_1PluginManager.html">PluginManager</a> > </td><td class="memItemRight" valign="bottom"><b>fPluginManager</b></td></tr>
|
|
<tr class="separator:a5ae42895297c49ebdfa50ab3a07abfd4"><td class="memSeparator" colspan="2"> </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> </td><td class="memItemRight" valign="bottom"><b>fConfig</b></td></tr>
|
|
<tr class="separator:ae0cb66f35d080a7e5adeffcf487e836e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a10348857241b3b7ed0f7709912a8a2b1"><td class="memItemLeft" align="right" valign="top"><a id="a10348857241b3b7ed0f7709912a8a2b1"></a>
|
|
std::shared_ptr< <a class="el" href="classFairMQDevice.html">FairMQDevice</a> > </td><td class="memItemRight" valign="bottom"><b>fDevice</b></td></tr>
|
|
<tr class="separator:a10348857241b3b7ed0f7709912a8a2b1"><td class="memSeparator" colspan="2"> </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 -->
|
|
<!-- 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.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|