<!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: StateMachine03 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="class_state_machine03-members.html">List of all members</a> </div> <div class="headertitle"><div class="title">StateMachine03 Class Reference<div class="ingroups"><a class="el" href="group__test03.html">Thirth Test Project</a></div></div></div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="statemachine03_8h_source.html">statemachine03.h</a>></code></p> <div class="dynheader"> Inheritance diagram for StateMachine03:</div> <div class="dyncontent"> <div class="center"><img src="class_state_machine03__inherit__graph.png" border="0" usemap="#a_state_machine03_inherit__map" alt="Inheritance graph"/></div> <map name="a_state_machine03_inherit__map" id="a_state_machine03_inherit__map"> <area shape="rect" title=" " alt="" coords="5,131,149,237"/> <area shape="rect" title=" " alt="" coords="34,5,121,83"/> </map> </div> <div class="dynheader"> Collaboration diagram for StateMachine03:</div> <div class="dyncontent"> <div class="center"><img src="class_state_machine03__coll__graph.png" border="0" usemap="#a_state_machine03_coll__map" alt="Collaboration graph"/></div> <map name="a_state_machine03_coll__map" id="a_state_machine03_coll__map"> <area shape="rect" title=" " alt="" coords="5,131,149,237"/> <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:a74ae5a9658741240e70a1bc5fcaa75fe"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine03.html#a74ae5a9658741240e70a1bc5fcaa75fe">eTimeoutId</a> { <a class="el" href="class_state_machine03.html#a74ae5a9658741240e70a1bc5fcaa75feaa6fe1c614aff47d84236e6f01dd1e92d">Timeout_WAIT_id</a> = 1 }</td></tr> <tr class="separator:a74ae5a9658741240e70a1bc5fcaa75fe"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a080841c4752dff9512b20f3c69c2bca2"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine03.html#a080841c4752dff9512b20f3c69c2bca2">eMainState</a> { <a class="el" href="class_state_machine03.html#a080841c4752dff9512b20f3c69c2bca2ad02f690cdf05ff78a076e00eada4b463">STATE_UNKOWN</a> = 0 , <a class="el" href="class_state_machine03.html#a080841c4752dff9512b20f3c69c2bca2ae8ff26cd13a7b6cdd20bff3c099eda22">STATE_INITIAL</a> = 1 , <a class="el" href="class_state_machine03.html#a080841c4752dff9512b20f3c69c2bca2aee2562f290aeea725104cfd54cdb31a1">STATE_WAIT</a> = 2 , <a class="el" href="class_state_machine03.html#a080841c4752dff9512b20f3c69c2bca2a1102c7b4aff8082b6e3e227900e6a1a0">STATE_SEND_RESTART</a> = 3 }</td></tr> <tr class="separator:a080841c4752dff9512b20f3c69c2bca2"><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:a1d5021db56bcc3a1f2d0413be5778dbf"><td class="memItemLeft" align="right" valign="top">XFEventStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine03.html#a1d5021db56bcc3a1f2d0413be5778dbf">processEvent</a> () override</td></tr> <tr class="separator:a1d5021db56bcc3a1f2d0413be5778dbf"><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:a5f669e4b667193d9181e3519401e7448"><td class="memItemLeft" align="right" valign="top"><a id="a5f669e4b667193d9181e3519401e7448" name="a5f669e4b667193d9181e3519401e7448"></a> <a class="el" href="class_state_machine03.html#a080841c4752dff9512b20f3c69c2bca2">eMainState</a> </td><td class="memItemRight" valign="bottom"><b>currentState_</b></td></tr> <tr class="memdesc:a5f669e4b667193d9181e3519401e7448"><td class="mdescLeft"> </td><td class="mdescRight">Attribute indicating currently active state. <br /></td></tr> <tr class="separator:a5f669e4b667193d9181e3519401e7448"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p >Implements a state machine sending itself an <em><a class="el" href="classev_restart.html">evRestart</a></em> event, to drive the state machine further.</p> <p >Following you will find the state machine implemented by <a class="el" href="class_state_machine03.html">StateMachine03</a>: </p><div class="image"> <img src="state-machine03.png" alt=""/> <div class="caption"> State Machine implemented by StateMachine03</div></div> </div><h2 class="groupheader">Member Enumeration Documentation</h2> <a id="a080841c4752dff9512b20f3c69c2bca2" name="a080841c4752dff9512b20f3c69c2bca2"></a> <h2 class="memtitle"><span class="permalink"><a href="#a080841c4752dff9512b20f3c69c2bca2">◆ </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_machine03.html#a080841c4752dff9512b20f3c69c2bca2">StateMachine03::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="a080841c4752dff9512b20f3c69c2bca2ad02f690cdf05ff78a076e00eada4b463" name="a080841c4752dff9512b20f3c69c2bca2ad02f690cdf05ff78a076e00eada4b463"></a>STATE_UNKOWN </td><td class="fielddoc"><p >Unkown state. </p> </td></tr> <tr><td class="fieldname"><a id="a080841c4752dff9512b20f3c69c2bca2ae8ff26cd13a7b6cdd20bff3c099eda22" name="a080841c4752dff9512b20f3c69c2bca2ae8ff26cd13a7b6cdd20bff3c099eda22"></a>STATE_INITIAL </td><td class="fielddoc"><p >Initial state. </p> </td></tr> <tr><td class="fieldname"><a id="a080841c4752dff9512b20f3c69c2bca2aee2562f290aeea725104cfd54cdb31a1" name="a080841c4752dff9512b20f3c69c2bca2aee2562f290aeea725104cfd54cdb31a1"></a>STATE_WAIT </td><td class="fielddoc"><p >Wait state. </p> </td></tr> <tr><td class="fieldname"><a id="a080841c4752dff9512b20f3c69c2bca2a1102c7b4aff8082b6e3e227900e6a1a0" name="a080841c4752dff9512b20f3c69c2bca2a1102c7b4aff8082b6e3e227900e6a1a0"></a>STATE_SEND_RESTART </td><td class="fielddoc"><p >State sending an restart event. </p> </td></tr> </table> </div> </div> <a id="a74ae5a9658741240e70a1bc5fcaa75fe" name="a74ae5a9658741240e70a1bc5fcaa75fe"></a> <h2 class="memtitle"><span class="permalink"><a href="#a74ae5a9658741240e70a1bc5fcaa75fe">◆ </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_machine03.html#a74ae5a9658741240e70a1bc5fcaa75fe">StateMachine03::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="a74ae5a9658741240e70a1bc5fcaa75feaa6fe1c614aff47d84236e6f01dd1e92d" name="a74ae5a9658741240e70a1bc5fcaa75feaa6fe1c614aff47d84236e6f01dd1e92d"></a>Timeout_WAIT_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="a1d5021db56bcc3a1f2d0413be5778dbf" name="a1d5021db56bcc3a1f2d0413be5778dbf"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1d5021db56bcc3a1f2d0413be5778dbf">◆ </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 StateMachine03::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/test3/src/app/<a class="el" href="statemachine03_8h_source.html">statemachine03.h</a></li> <li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/test-bench/test3/src/app/statemachine03.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>