Klagarge/XF
Archived
1
0
Fork 0
Code Issues Pull Requests Releases 1 Activity

Initial commit

Browse Source
This commit is contained in:
Rémi Heredero
2023-09-19 15:59:49 +02:00
commit bef0bade14
1860 changed files with 582828 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

275
test-bench/doxygen/output/html/class_state_machine04a.html Normal file
View File

@@ -0,0 +1,275 @@
<!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=11"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>XF Test Bench: StateMachine04a 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">XF Test Bench<span id="projectnumber">&#160;3.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-types">Protected Types</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_state_machine04a-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">StateMachine04a Class Reference<div class="ingroups"><a class="el" href="group__test04.html">Forth Test Project</a></div></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="statemachine04a_8h_source.html">statemachine04a.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for StateMachine04a:</div>
<div class="dyncontent">
<div class="center"><img src="class_state_machine04a__inherit__graph.png" border="0" usemap="#a_state_machine04a_inherit__map" alt="Inheritance graph"/></div>
<map name="a_state_machine04a_inherit__map" id="a_state_machine04a_inherit__map">
<area shape="rect" title=" " alt="" coords="5,131,156,281"/>
<area shape="rect" title=" " alt="" coords="37,5,124,83"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for StateMachine04a:</div>
<div class="dyncontent">
<div class="center"><img src="class_state_machine04a__coll__graph.png" border="0" usemap="#a_state_machine04a_coll__map" alt="Collaboration graph"/></div>
<map name="a_state_machine04a_coll__map" id="a_state_machine04a_coll__map">
<area shape="rect" title=" " alt="" coords="5,131,156,281"/>
<area shape="rect" title=" " alt="" coords="37,5,124,83"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6c3abbbc6d25d5ce8ae706f0ca2eeba1"><td class="memItemLeft" align="right" valign="top"><a id="a6c3abbbc6d25d5ce8ae706f0ca2eeba1" name="a6c3abbbc6d25d5ce8ae706f0ca2eeba1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>StateMachine04a</b> ()</td></tr>
<tr class="memdesc:a6c3abbbc6d25d5ce8ae706f0ca2eeba1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a6c3abbbc6d25d5ce8ae706f0ca2eeba1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5eae61a7f237b988e771aaa03d963f0e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine04a.html#a5eae61a7f237b988e771aaa03d963f0e">setNeighbour</a> (XFBehavior *pNeighbour)</td></tr>
<tr class="separator:a5eae61a7f237b988e771aaa03d963f0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a886f82be81f8e86f5a547566a9001235"><td class="memItemLeft" align="right" valign="top">XFBehavior *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine04a.html#a886f82be81f8e86f5a547566a9001235">getNeighbour</a> () const</td></tr>
<tr class="separator:a886f82be81f8e86f5a547566a9001235"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-types" name="pro-types"></a>
Protected Types</h2></td></tr>
<tr class="memitem:a8c08db4187f3fba8e469362d722dad68"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine04a.html#a8c08db4187f3fba8e469362d722dad68">eTimeoutId</a> { <a class="el" href="class_state_machine04a.html#a8c08db4187f3fba8e469362d722dad68a1cd71cb27b8244b44176d1a1f6ccecca">Timeout_WAIT_id</a> = 1
}</td></tr>
<tr class="separator:a8c08db4187f3fba8e469362d722dad68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5436c68577266affa8e9bd0b32f74b51"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine04a.html#a5436c68577266affa8e9bd0b32f74b51">eMainState</a> { <a class="el" href="class_state_machine04a.html#a5436c68577266affa8e9bd0b32f74b51af8c94bff385edbe4b218605215294b8a">STATE_UNKOWN</a> = 0
, <a class="el" href="class_state_machine04a.html#a5436c68577266affa8e9bd0b32f74b51a0c0af5cec02b5b0a0464a63e7a32993c">STATE_INITIAL</a> = 1
, <a class="el" href="class_state_machine04a.html#a5436c68577266affa8e9bd0b32f74b51a84835750aa57dd071c371a2eaaccfb91">STATE_WAIT</a> = 2
, <a class="el" href="class_state_machine04a.html#a5436c68577266affa8e9bd0b32f74b51ac2488a8f558fb99cf703d4f7b6dd5bdb">STATE_SEND_RESTART</a> = 3
}</td></tr>
<tr class="separator:a5436c68577266affa8e9bd0b32f74b51"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a44e8910da144002fe813766c9d782ed7"><td class="memItemLeft" align="right" valign="top">XFEventStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine04a.html#a44e8910da144002fe813766c9d782ed7">processEvent</a> () override</td></tr>
<tr class="separator:a44e8910da144002fe813766c9d782ed7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ae821698ee4c11c1708fa78bb41d387ab"><td class="memItemLeft" align="right" valign="top"><a id="ae821698ee4c11c1708fa78bb41d387ab" name="ae821698ee4c11c1708fa78bb41d387ab"></a>
<a class="el" href="class_state_machine04a.html#a5436c68577266affa8e9bd0b32f74b51">eMainState</a>&#160;</td><td class="memItemRight" valign="bottom"><b>currentState_</b></td></tr>
<tr class="memdesc:ae821698ee4c11c1708fa78bb41d387ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attribute indicating currently active state. <br /></td></tr>
<tr class="separator:ae821698ee4c11c1708fa78bb41d387ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d55df85f742f036801b28f060b88438"><td class="memItemLeft" align="right" valign="top"><a id="a0d55df85f742f036801b28f060b88438" name="a0d55df85f742f036801b28f060b88438"></a>
XFBehavior *&#160;</td><td class="memItemRight" valign="bottom"><b>pNeighbour_</b></td></tr>
<tr class="memdesc:a0d55df85f742f036801b28f060b88438"><td class="mdescLeft">&#160;</td><td class="mdescRight">Association to the neigbour state machine. <br /></td></tr>
<tr class="separator:a0d55df85f742f036801b28f060b88438"><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 >Implements a state machine sending its neighbour state machine an <em><a class="el" href="classev_restart.html">evRestart</a></em> event every four seconds.</p>
<p >Following you will find the state machine implemented by <a class="el" href="class_state_machine04a.html">StateMachine04a</a>: </p><div class="image">
<img src="state-machine04a.png" alt=""/>
<div class="caption">
State Machine implemented by StateMachine04</div></div>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a5436c68577266affa8e9bd0b32f74b51" name="a5436c68577266affa8e9bd0b32f74b51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5436c68577266affa8e9bd0b32f74b51">&#9670;&nbsp;</a></span>eMainState</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_state_machine04a.html#a5436c68577266affa8e9bd0b32f74b51">StateMachine04a::eMainState</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Enumeration used to have a unique identifier for every state in the state machine. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a5436c68577266affa8e9bd0b32f74b51af8c94bff385edbe4b218605215294b8a" name="a5436c68577266affa8e9bd0b32f74b51af8c94bff385edbe4b218605215294b8a"></a>STATE_UNKOWN&#160;</td><td class="fielddoc"><p >Unknown state. </p>
</td></tr>
<tr><td class="fieldname"><a id="a5436c68577266affa8e9bd0b32f74b51a0c0af5cec02b5b0a0464a63e7a32993c" name="a5436c68577266affa8e9bd0b32f74b51a0c0af5cec02b5b0a0464a63e7a32993c"></a>STATE_INITIAL&#160;</td><td class="fielddoc"><p >Initial state. </p>
</td></tr>
<tr><td class="fieldname"><a id="a5436c68577266affa8e9bd0b32f74b51a84835750aa57dd071c371a2eaaccfb91" name="a5436c68577266affa8e9bd0b32f74b51a84835750aa57dd071c371a2eaaccfb91"></a>STATE_WAIT&#160;</td><td class="fielddoc"><p >Wait state. </p>
</td></tr>
<tr><td class="fieldname"><a id="a5436c68577266affa8e9bd0b32f74b51ac2488a8f558fb99cf703d4f7b6dd5bdb" name="a5436c68577266affa8e9bd0b32f74b51ac2488a8f558fb99cf703d4f7b6dd5bdb"></a>STATE_SEND_RESTART&#160;</td><td class="fielddoc"><p >State sending an restart event. </p>
</td></tr>
</table>
</div>
</div>
<a id="a8c08db4187f3fba8e469362d722dad68" name="a8c08db4187f3fba8e469362d722dad68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c08db4187f3fba8e469362d722dad68">&#9670;&nbsp;</a></span>eTimeoutId</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_state_machine04a.html#a8c08db4187f3fba8e469362d722dad68">StateMachine04a::eTimeoutId</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Timeout identifier(s) for this state machine </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a8c08db4187f3fba8e469362d722dad68a1cd71cb27b8244b44176d1a1f6ccecca" name="a8c08db4187f3fba8e469362d722dad68a1cd71cb27b8244b44176d1a1f6ccecca"></a>Timeout_WAIT_id&#160;</td><td class="fielddoc"><p >Timeout id for WAIT. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a886f82be81f8e86f5a547566a9001235" name="a886f82be81f8e86f5a547566a9001235"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a886f82be81f8e86f5a547566a9001235">&#9670;&nbsp;</a></span>getNeighbour()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XFBehavior * StateMachine04a::getNeighbour </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p >Returns reference to neighbour state machine. </p>
</div>
</div>
<a id="a44e8910da144002fe813766c9d782ed7" name="a44e8910da144002fe813766c9d782ed7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44e8910da144002fe813766c9d782ed7">&#9670;&nbsp;</a></span>processEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">XFEventStatus StateMachine04a::processEvent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Implements state machine behavior. </p>
</div>
</div>
<a id="a5eae61a7f237b988e771aaa03d963f0e" name="a5eae61a7f237b988e771aaa03d963f0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5eae61a7f237b988e771aaa03d963f0e">&#9670;&nbsp;</a></span>setNeighbour()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StateMachine04a::setNeighbour </td>
<td>(</td>
<td class="paramtype">XFBehavior *&#160;</td>
<td class="paramname"><em>pNeighbour</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Sets the association to the neighbour state machine. Call this method prior the start the state machine. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/test-bench/test4/src/app/<a class="el" href="statemachine04a_8h_source.html">statemachine04a.h</a></li>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/test-bench/test4/src/app/statemachine04a.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:36:35 for XF Test Bench by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2
</small></address>
</body>
</html>