mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
183 lines
11 KiB
HTML
183 lines
11 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: FairMQStateMachine 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.0</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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classFairMQStateMachine-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">FairMQStateMachine Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for FairMQStateMachine:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classFairMQStateMachine__inherit__graph.png" border="0" usemap="#FairMQStateMachine_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="FairMQStateMachine_inherit__map" id="FairMQStateMachine_inherit__map">
|
|
<area shape="rect" id="node3" href="classFairMQDevice.html" title="FairMQDevice" alt="" coords="440,208,551,235"/>
|
|
<area shape="rect" id="node4" href="classFairMQBenchmarkSampler.html" title="FairMQBenchmarkSampler" alt="" coords="607,5,802,32"/>
|
|
<area shape="rect" id="node5" href="classFairMQMerger.html" title="FairMQMerger" alt="" coords="649,56,760,83"/>
|
|
<area shape="rect" id="node6" href="classFairMQMultiplier.html" title="FairMQMultiplier" alt="" coords="641,107,768,133"/>
|
|
<area shape="rect" id="node7" href="classFairMQProxy.html" title="FairMQProxy" alt="" coords="653,157,756,184"/>
|
|
<area shape="rect" id="node8" href="classFairMQShmPrototypeSampler.html" title="FairMQShmPrototypeSampler" alt="" coords="599,208,811,235"/>
|
|
<area shape="rect" id="node9" href="classFairMQShmPrototypeSink.html" title="FairMQShmPrototypeSink" alt="" coords="611,259,798,285"/>
|
|
<area shape="rect" id="node10" href="classFairMQSink.html" title="FairMQSink" alt="" coords="657,309,752,336"/>
|
|
<area shape="rect" id="node11" href="classFairMQSplitter.html" title="FairMQSplitter" alt="" coords="648,360,761,387"/>
|
|
<area shape="rect" id="node12" href="classMyDevice.html" title="MyDevice" alt="" coords="661,411,748,437"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for FairMQStateMachine:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classFairMQStateMachine__coll__graph.png" border="0" usemap="#FairMQStateMachine_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="FairMQStateMachine_coll__map" id="FairMQStateMachine_coll__map">
|
|
</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-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a40422459e6d1e5427c46d7651ed2e616"><td class="memItemLeft" align="right" valign="top"><a id="a40422459e6d1e5427c46d7651ed2e616"></a>enum  </td><td class="memItemRight" valign="bottom"><b>Event</b> { <br />
|
|
  <b>INIT_DEVICE</b>,
|
|
<b>internal_DEVICE_READY</b>,
|
|
<b>INIT_TASK</b>,
|
|
<b>internal_READY</b>,
|
|
<br />
|
|
  <b>RUN</b>,
|
|
<b>PAUSE</b>,
|
|
<b>STOP</b>,
|
|
<b>RESET_TASK</b>,
|
|
<br />
|
|
  <b>RESET_DEVICE</b>,
|
|
<b>internal_IDLE</b>,
|
|
<b>END</b>,
|
|
<b>ERROR_FOUND</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:a40422459e6d1e5427c46d7651ed2e616"><td class="memSeparator" colspan="2"> </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:a9ee523fe4940a663c909fce8a51b10f3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQStateMachine.html#a9ee523fe4940a663c909fce8a51b10f3">FairMQStateMachine</a> ()</td></tr>
|
|
<tr class="separator:a9ee523fe4940a663c909fce8a51b10f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:addf56a5817575421a74fa25bfdfb0662"><td class="memItemLeft" align="right" valign="top"><a id="addf56a5817575421a74fa25bfdfb0662"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetInterfaceVersion</b> () const</td></tr>
|
|
<tr class="separator:addf56a5817575421a74fa25bfdfb0662"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ffc3496e92ad11f5bc4946d2d7c7b2d"><td class="memItemLeft" align="right" valign="top"><a id="a1ffc3496e92ad11f5bc4946d2d7c7b2d"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>ChangeState</b> (int event)</td></tr>
|
|
<tr class="separator:a1ffc3496e92ad11f5bc4946d2d7c7b2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a553ab468a73db9c950471cd04eee7582"><td class="memItemLeft" align="right" valign="top"><a id="a553ab468a73db9c950471cd04eee7582"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>ChangeState</b> (const std::string &event)</td></tr>
|
|
<tr class="separator:a553ab468a73db9c950471cd04eee7582"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aecf55e25c6c70bbeb692ab8d15b0872b"><td class="memItemLeft" align="right" valign="top"><a id="aecf55e25c6c70bbeb692ab8d15b0872b"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>WaitForEndOfState</b> (int event)</td></tr>
|
|
<tr class="separator:aecf55e25c6c70bbeb692ab8d15b0872b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a532450b98022bdeca317da193f66e9cb"><td class="memItemLeft" align="right" valign="top"><a id="a532450b98022bdeca317da193f66e9cb"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>WaitForEndOfState</b> (const std::string &event)</td></tr>
|
|
<tr class="separator:a532450b98022bdeca317da193f66e9cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5443a5c5fec5d233249e8f688326cecb"><td class="memItemLeft" align="right" valign="top"><a id="a5443a5c5fec5d233249e8f688326cecb"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>WaitForEndOfStateForMs</b> (int event, int durationInMs)</td></tr>
|
|
<tr class="separator:a5443a5c5fec5d233249e8f688326cecb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad775927113eaedbf8a10b32d0114449a"><td class="memItemLeft" align="right" valign="top"><a id="ad775927113eaedbf8a10b32d0114449a"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>WaitForEndOfStateForMs</b> (const std::string &event, int durationInMs)</td></tr>
|
|
<tr class="separator:ad775927113eaedbf8a10b32d0114449a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c6099c92d83f54c81ac92cf45719690"><td class="memItemLeft" align="right" valign="top"><a id="a6c6099c92d83f54c81ac92cf45719690"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SubscribeToStateChange</b> (const std::string &key, std::function< void(const State)> callback)</td></tr>
|
|
<tr class="separator:a6c6099c92d83f54c81ac92cf45719690"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e2e0243459ebfec7e2a9a9ad4fbd3bc"><td class="memItemLeft" align="right" valign="top"><a id="a5e2e0243459ebfec7e2a9a9ad4fbd3bc"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>UnsubscribeFromStateChange</b> (const std::string &key)</td></tr>
|
|
<tr class="separator:a5e2e0243459ebfec7e2a9a9ad4fbd3bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a9ee523fe4940a663c909fce8a51b10f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9ee523fe4940a663c909fce8a51b10f3">◆ </a></span>FairMQStateMachine()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">FairMQStateMachine::FairMQStateMachine </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>FairMQStateMachine.cxx</p>
|
|
<dl class="section since"><dt>Since</dt><dd>2012-10-25 </dd></dl>
|
|
<dl class="section author"><dt>Author</dt><dd>D. Klein, A. Rybalchenko </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>fairmq/<a class="el" href="FairMQStateMachine_8h_source.html">FairMQStateMachine.h</a></li>
|
|
<li>fairmq/FairMQStateMachine.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>
|