245 lines
14 KiB
HTML
245 lines
14 KiB
HTML
|
<!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: StateMachine02 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"> 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&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&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> |
|
||
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
||
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
||
|
|
<a href="#pro-static-attribs">Static Protected Attributes</a> |
|
||
|
|
<a href="class_state_machine02-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">StateMachine02 Class Reference<div class="ingroups"><a class="el" href="group__test02.html">Second Test Project</a></div></div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="statemachine02_8h_source.html">statemachine02.h</a>></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for StateMachine02:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="class_state_machine02__inherit__graph.png" border="0" usemap="#a_state_machine02_inherit__map" alt="Inheritance graph"/></div>
|
||
|
|
<map name="a_state_machine02_inherit__map" id="a_state_machine02_inherit__map">
|
||
|
|
<area shape="rect" title=" " alt="" coords="5,131,149,281"/>
|
||
|
|
<area shape="rect" title=" " alt="" coords="34,5,121,83"/>
|
||
|
|
</map>
|
||
|
|
</div>
|
||
|
|
<div class="dynheader">
|
||
|
|
Collaboration diagram for StateMachine02:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="class_state_machine02__coll__graph.png" border="0" usemap="#a_state_machine02_coll__map" alt="Collaboration graph"/></div>
|
||
|
|
<map name="a_state_machine02_coll__map" id="a_state_machine02_coll__map">
|
||
|
|
<area shape="rect" title=" " alt="" coords="5,131,149,281"/>
|
||
|
|
<area shape="rect" title=" " alt="" coords="34,5,121,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:a3f3d2bed279212d5ddd109a22c0d1340"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine02.html#a3f3d2bed279212d5ddd109a22c0d1340">eTimeoutId</a> { <a class="el" href="class_state_machine02.html#a3f3d2bed279212d5ddd109a22c0d1340a2a2438079c1fcb6609ca145efda26e21">Timeout_PRINT_COUNT_id</a> = 1
|
||
|
|
}</td></tr>
|
||
|
|
<tr class="separator:a3f3d2bed279212d5ddd109a22c0d1340"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad1ab359b87d41aa2ee32a812d366f183"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine02.html#ad1ab359b87d41aa2ee32a812d366f183">eMainState</a> { <br />
|
||
|
|
  <a class="el" href="class_state_machine02.html#ad1ab359b87d41aa2ee32a812d366f183af7a26cff5e477f917abd18f24579ff73">STATE_UNKOWN</a> = 0
|
||
|
|
, <a class="el" href="class_state_machine02.html#ad1ab359b87d41aa2ee32a812d366f183a0c5a500675ff82c3cb9e1a49c58be411">STATE_INITIAL</a> = 1
|
||
|
|
, <a class="el" href="class_state_machine02.html#ad1ab359b87d41aa2ee32a812d366f183a7e14b349d831c8a5f422b991ef9bc4ca">STATE_PRINT_COUNT</a> = 2
|
||
|
|
, <a class="el" href="class_state_machine02.html#ad1ab359b87d41aa2ee32a812d366f183a44bdea6e4ced029920e0996b4293b431">STATE_CONDITION_01</a> = 3
|
||
|
|
, <br />
|
||
|
|
  <a class="el" href="class_state_machine02.html#ad1ab359b87d41aa2ee32a812d366f183a66892f0c224b4943f02d14b91ca78e89">STATE_TERMINATION_01</a> = 4
|
||
|
|
<br />
|
||
|
|
}</td></tr>
|
||
|
|
<tr class="separator:ad1ab359b87d41aa2ee32a812d366f183"><td class="memSeparator" colspan="2"> </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:a652724f5d376f82d20495bf83ed7ddb1"><td class="memItemLeft" align="right" valign="top">XFEventStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine02.html#a652724f5d376f82d20495bf83ed7ddb1">processEvent</a> () override</td></tr>
|
||
|
|
<tr class="separator:a652724f5d376f82d20495bf83ed7ddb1"><td class="memSeparator" colspan="2"> </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:ab3658eee88deeaa0ee6ad2583fadd737"><td class="memItemLeft" align="right" valign="top"><a id="ab3658eee88deeaa0ee6ad2583fadd737" name="ab3658eee88deeaa0ee6ad2583fadd737"></a>
|
||
|
|
<a class="el" href="class_state_machine02.html#ad1ab359b87d41aa2ee32a812d366f183">eMainState</a> </td><td class="memItemRight" valign="bottom"><b>_currentState</b></td></tr>
|
||
|
|
<tr class="memdesc:ab3658eee88deeaa0ee6ad2583fadd737"><td class="mdescLeft"> </td><td class="mdescRight">Attribute indicating currently active state. <br /></td></tr>
|
||
|
|
<tr class="separator:ab3658eee88deeaa0ee6ad2583fadd737"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aae20bcd66cb2a36e9a8d1bd66feccc3c"><td class="memItemLeft" align="right" valign="top"><a id="aae20bcd66cb2a36e9a8d1bd66feccc3c" name="aae20bcd66cb2a36e9a8d1bd66feccc3c"></a>
|
||
|
|
const uint32_t </td><td class="memItemRight" valign="bottom"><b>id</b></td></tr>
|
||
|
|
<tr class="memdesc:aae20bcd66cb2a36e9a8d1bd66feccc3c"><td class="mdescLeft"> </td><td class="mdescRight">Object identifier. <br /></td></tr>
|
||
|
|
<tr class="separator:aae20bcd66cb2a36e9a8d1bd66feccc3c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a143f2d5d2402b0f92141f4962a5b03dc"><td class="memItemLeft" align="right" valign="top"><a id="a143f2d5d2402b0f92141f4962a5b03dc" name="a143f2d5d2402b0f92141f4962a5b03dc"></a>
|
||
|
|
int </td><td class="memItemRight" valign="bottom"><b>counter</b></td></tr>
|
||
|
|
<tr class="memdesc:a143f2d5d2402b0f92141f4962a5b03dc"><td class="mdescLeft"> </td><td class="mdescRight">Count down attribute used in state machine. <br /></td></tr>
|
||
|
|
<tr class="separator:a143f2d5d2402b0f92141f4962a5b03dc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-static-attribs" name="pro-static-attribs"></a>
|
||
|
|
Static Protected Attributes</h2></td></tr>
|
||
|
|
<tr class="memitem:a099af89e1bf7e2c33f6fa5b383816203"><td class="memItemLeft" align="right" valign="top"><a id="a099af89e1bf7e2c33f6fa5b383816203" name="a099af89e1bf7e2c33f6fa5b383816203"></a>
|
||
|
|
static uint32_t </td><td class="memItemRight" valign="bottom"><b>nextId</b> = 1</td></tr>
|
||
|
|
<tr class="memdesc:a099af89e1bf7e2c33f6fa5b383816203"><td class="mdescLeft"> </td><td class="mdescRight">Static attribute providing identifier for next object. <br /></td></tr>
|
||
|
|
<tr class="separator:a099af89e1bf7e2c33f6fa5b383816203"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p >Task implementing a state machine doing a count down from 5 to 1 and terminating.</p>
|
||
|
|
<p >Following you will find the state machine implemented by <a class="el" href="class_state_machine02.html">StateMachine02</a>: </p><div class="image">
|
||
|
|
<img src="state-machine02.png" alt=""/>
|
||
|
|
<div class="caption">
|
||
|
|
State Machine implemented by StateMachine02</div></div>
|
||
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
||
|
|
<a id="ad1ab359b87d41aa2ee32a812d366f183" name="ad1ab359b87d41aa2ee32a812d366f183"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad1ab359b87d41aa2ee32a812d366f183">◆ </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_machine02.html#ad1ab359b87d41aa2ee32a812d366f183">StateMachine02::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="ad1ab359b87d41aa2ee32a812d366f183af7a26cff5e477f917abd18f24579ff73" name="ad1ab359b87d41aa2ee32a812d366f183af7a26cff5e477f917abd18f24579ff73"></a>STATE_UNKOWN </td><td class="fielddoc"><p >Unkown state. </p>
|
||
|
|
</td></tr>
|
||
|
|
<tr><td class="fieldname"><a id="ad1ab359b87d41aa2ee32a812d366f183a0c5a500675ff82c3cb9e1a49c58be411" name="ad1ab359b87d41aa2ee32a812d366f183a0c5a500675ff82c3cb9e1a49c58be411"></a>STATE_INITIAL </td><td class="fielddoc"><p >Initial state. </p>
|
||
|
|
</td></tr>
|
||
|
|
<tr><td class="fieldname"><a id="ad1ab359b87d41aa2ee32a812d366f183a7e14b349d831c8a5f422b991ef9bc4ca" name="ad1ab359b87d41aa2ee32a812d366f183a7e14b349d831c8a5f422b991ef9bc4ca"></a>STATE_PRINT_COUNT </td><td class="fielddoc"><p >Print count state. </p>
|
||
|
|
</td></tr>
|
||
|
|
<tr><td class="fieldname"><a id="ad1ab359b87d41aa2ee32a812d366f183a44bdea6e4ced029920e0996b4293b431" name="ad1ab359b87d41aa2ee32a812d366f183a44bdea6e4ced029920e0996b4293b431"></a>STATE_CONDITION_01 </td><td class="fielddoc"><p >Condition after print count state. </p>
|
||
|
|
</td></tr>
|
||
|
|
<tr><td class="fieldname"><a id="ad1ab359b87d41aa2ee32a812d366f183a66892f0c224b4943f02d14b91ca78e89" name="ad1ab359b87d41aa2ee32a812d366f183a66892f0c224b4943f02d14b91ca78e89"></a>STATE_TERMINATION_01 </td><td class="fielddoc"><p >Termination state. </p>
|
||
|
|
</td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a3f3d2bed279212d5ddd109a22c0d1340" name="a3f3d2bed279212d5ddd109a22c0d1340"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3f3d2bed279212d5ddd109a22c0d1340">◆ </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_machine02.html#a3f3d2bed279212d5ddd109a22c0d1340">StateMachine02::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="a3f3d2bed279212d5ddd109a22c0d1340a2a2438079c1fcb6609ca145efda26e21" name="a3f3d2bed279212d5ddd109a22c0d1340a2a2438079c1fcb6609ca145efda26e21"></a>Timeout_PRINT_COUNT_id </td><td class="fielddoc"><p >Timeout id for WAIT. </p>
|
||
|
|
</td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="a652724f5d376f82d20495bf83ed7ddb1" name="a652724f5d376f82d20495bf83ed7ddb1"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a652724f5d376f82d20495bf83ed7ddb1">◆ </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 StateMachine02::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/test2/src/app/<a class="el" href="statemachine02_8h_source.html">statemachine02.h</a></li>
|
||
|
|
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/test-bench/test2/src/app/statemachine02.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 <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>
|