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

231
test-bench/doxygen/output/html/class_state_machine04b.html Normal file
View File

@@ -0,0 +1,231 @@
<!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: StateMachine04b 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="#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_machine04b-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">StateMachine04b 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="statemachine04b_8h_source.html">statemachine04b.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for StateMachine04b:</div>
<div class="dyncontent">
<div class="center"><img src="class_state_machine04b__inherit__graph.png" border="0" usemap="#a_state_machine04b_inherit__map" alt="Inheritance graph"/></div>
<map name="a_state_machine04b_inherit__map" id="a_state_machine04b_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 StateMachine04b:</div>
<div class="dyncontent">
<div class="center"><img src="class_state_machine04b__coll__graph.png" border="0" usemap="#a_state_machine04b_coll__map" alt="Collaboration graph"/></div>
<map name="a_state_machine04b_coll__map" id="a_state_machine04b_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="pro-types" name="pro-types"></a>
Protected Types</h2></td></tr>
<tr class="memitem:a934a9e1fb8d1ce4ce79890d935951cad"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine04b.html#a934a9e1fb8d1ce4ce79890d935951cad">eTimeoutId</a> { <a class="el" href="class_state_machine04b.html#a934a9e1fb8d1ce4ce79890d935951cada2c6f576f62f8eb09f97873704dd1f24f">Timeout_WAIT_id</a> = 1
}</td></tr>
<tr class="separator:a934a9e1fb8d1ce4ce79890d935951cad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cbedd342fba4cc152aa61e6e51f3d08"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08">eMainState</a> { <a class="el" href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08a5e246d22804803d10077cca5cf6d55a9">STATE_UNKOWN</a> = 0
, <a class="el" href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08ac7a06f3e776da6568962cde9e46a1604">STATE_INITIAL</a> = 1
, <a class="el" href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08acb6aed934f04df5098b9bb08610fd1b0">STATE_WAIT</a> = 2
}</td></tr>
<tr class="separator:a6cbedd342fba4cc152aa61e6e51f3d08"><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:a5f52bf9e9543660a3cf08b2bb18a3ec4"><td class="memItemLeft" align="right" valign="top">XFEventStatus&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine04b.html#a5f52bf9e9543660a3cf08b2bb18a3ec4">processEvent</a> () override</td></tr>
<tr class="separator:a5f52bf9e9543660a3cf08b2bb18a3ec4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3740d77249ca8a8fa191a914c9a3229"><td class="memItemLeft" align="right" valign="top"><a id="ab3740d77249ca8a8fa191a914c9a3229" name="ab3740d77249ca8a8fa191a914c9a3229"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>isTimeoutEvent</b> (int timeoutId)</td></tr>
<tr class="memdesc:ab3740d77249ca8a8fa191a914c9a3229"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true in case state machine is currently processing a timeout. <br /></td></tr>
<tr class="separator:ab3740d77249ca8a8fa191a914c9a3229"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3dda278f8e86861a4397b1a68402e799"><td class="memItemLeft" align="right" valign="top"><a id="a3dda278f8e86861a4397b1a68402e799" name="a3dda278f8e86861a4397b1a68402e799"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>isRestartEvent</b> () const</td></tr>
<tr class="memdesc:a3dda278f8e86861a4397b1a68402e799"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true in case state machine is currently processing an <em><a class="el" href="classev_restart.html">evRestart</a></em> event. <br /></td></tr>
<tr class="separator:a3dda278f8e86861a4397b1a68402e799"><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:aacec0a31225b7d0da00cdda770ac3683"><td class="memItemLeft" align="right" valign="top"><a id="aacec0a31225b7d0da00cdda770ac3683" name="aacec0a31225b7d0da00cdda770ac3683"></a>
<a class="el" href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08">eMainState</a>&#160;</td><td class="memItemRight" valign="bottom"><b>currentState_</b></td></tr>
<tr class="memdesc:aacec0a31225b7d0da00cdda770ac3683"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attribute indicating currently active state. <br /></td></tr>
<tr class="separator:aacec0a31225b7d0da00cdda770ac3683"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbae2fd9c84e10d49f3fcd3404e34eed"><td class="memItemLeft" align="right" valign="top"><a id="acbae2fd9c84e10d49f3fcd3404e34eed" name="acbae2fd9c84e10d49f3fcd3404e34eed"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>timeout_</b></td></tr>
<tr class="memdesc:acbae2fd9c84e10d49f3fcd3404e34eed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timeout attribute counting rised timeouts in state machine. <br /></td></tr>
<tr class="separator:acbae2fd9c84e10d49f3fcd3404e34eed"><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 timeouting every second. It shows how many times the timeout has expired (using a <a class="el" href="class_state_machine04b.html#acbae2fd9c84e10d49f3fcd3404e34eed" title="Timeout attribute counting rised timeouts in state machine.">timeout_</a> attribute). The state machine can be reset by sending an <em><a class="el" href="classev_restart.html">evRestart</a></em> event.</p>
<p >Following you will find the state machine implemented by <a class="el" href="class_state_machine04b.html">StateMachine04b</a>: </p><div class="image">
<img src="state-machine04b.png" alt=""/>
<div class="caption">
State Machine implemented by StateMachine04</div></div>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a6cbedd342fba4cc152aa61e6e51f3d08" name="a6cbedd342fba4cc152aa61e6e51f3d08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cbedd342fba4cc152aa61e6e51f3d08">&#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_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08">StateMachine04b::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="a6cbedd342fba4cc152aa61e6e51f3d08a5e246d22804803d10077cca5cf6d55a9" name="a6cbedd342fba4cc152aa61e6e51f3d08a5e246d22804803d10077cca5cf6d55a9"></a>STATE_UNKOWN&#160;</td><td class="fielddoc"><p >Unkown state. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6cbedd342fba4cc152aa61e6e51f3d08ac7a06f3e776da6568962cde9e46a1604" name="a6cbedd342fba4cc152aa61e6e51f3d08ac7a06f3e776da6568962cde9e46a1604"></a>STATE_INITIAL&#160;</td><td class="fielddoc"><p >Initial state. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6cbedd342fba4cc152aa61e6e51f3d08acb6aed934f04df5098b9bb08610fd1b0" name="a6cbedd342fba4cc152aa61e6e51f3d08acb6aed934f04df5098b9bb08610fd1b0"></a>STATE_WAIT&#160;</td><td class="fielddoc"><p >Wait for timeout state. </p>
</td></tr>
</table>
</div>
</div>
<a id="a934a9e1fb8d1ce4ce79890d935951cad" name="a934a9e1fb8d1ce4ce79890d935951cad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a934a9e1fb8d1ce4ce79890d935951cad">&#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_machine04b.html#a934a9e1fb8d1ce4ce79890d935951cad">StateMachine04b::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="a934a9e1fb8d1ce4ce79890d935951cada2c6f576f62f8eb09f97873704dd1f24f" name="a934a9e1fb8d1ce4ce79890d935951cada2c6f576f62f8eb09f97873704dd1f24f"></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="a5f52bf9e9543660a3cf08b2bb18a3ec4" name="a5f52bf9e9543660a3cf08b2bb18a3ec4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f52bf9e9543660a3cf08b2bb18a3ec4">&#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 StateMachine04b::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>
<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="statemachine04b_8h_source.html">statemachine04b.h</a></li>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/test-bench/test4/src/app/statemachine04b.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>