254 lines
15 KiB
HTML
254 lines
15 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: StateMachine01 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="#pub-methods">Public Member Functions</a> |
|
||
|
|
<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_machine01-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">StateMachine01 Class Reference<div class="ingroups"><a class="el" href="group__test01.html">First Test Project</a></div></div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="statemachine01_8h_source.html">statemachine01.h</a>></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for StateMachine01:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="class_state_machine01__inherit__graph.png" border="0" usemap="#a_state_machine01_inherit__map" alt="Inheritance graph"/></div>
|
||
|
|
<map name="a_state_machine01_inherit__map" id="a_state_machine01_inherit__map">
|
||
|
|
<area shape="rect" title=" " alt="" coords="5,131,152,296"/>
|
||
|
|
<area shape="rect" title=" " alt="" coords="35,5,122,83"/>
|
||
|
|
</map>
|
||
|
|
</div>
|
||
|
|
<div class="dynheader">
|
||
|
|
Collaboration diagram for StateMachine01:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="class_state_machine01__coll__graph.png" border="0" usemap="#a_state_machine01_coll__map" alt="Collaboration graph"/></div>
|
||
|
|
<map name="a_state_machine01_coll__map" id="a_state_machine01_coll__map">
|
||
|
|
<area shape="rect" title=" " alt="" coords="5,131,152,296"/>
|
||
|
|
<area shape="rect" title=" " alt="" coords="35,5,122,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:a6e59a3d7ed9bebba660b4983f3ad4558"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine01.html#a6e59a3d7ed9bebba660b4983f3ad4558">StateMachine01</a> (int repeatInterval, string text)</td></tr>
|
||
|
|
<tr class="separator:a6e59a3d7ed9bebba660b4983f3ad4558"><td class="memSeparator" colspan="2"> </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:a4c91f12289315c5c8438c87feea424d6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine01.html#a4c91f12289315c5c8438c87feea424d6">eTimeoutId</a> { <a class="el" href="class_state_machine01.html#a4c91f12289315c5c8438c87feea424d6a560e140ef292acbebd9dd834f4907f99">Timeout_SAY_HELLO_id</a> = 1
|
||
|
|
}</td></tr>
|
||
|
|
<tr class="separator:a4c91f12289315c5c8438c87feea424d6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9b3e24a26eba26f2c2c3ad4792802ee4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4">eMainState</a> { <a class="el" href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4a77e7b6a6b9596d97c144ef82a0603224">STATE_UNKNOWN</a> = 0
|
||
|
|
, <a class="el" href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4aa53cb443dce0428eabfcdea1d0ba5e15">STATE_INITIAL</a> = 1
|
||
|
|
, <a class="el" href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4a96ec8d47fea8cfbd18748f807ae0cffc">STATE_SAY_HELLO</a> = 2
|
||
|
|
}</td></tr>
|
||
|
|
<tr class="separator:a9b3e24a26eba26f2c2c3ad4792802ee4"><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:ad6072335a0c69055427d00694cd61d8d"><td class="memItemLeft" align="right" valign="top"><a id="ad6072335a0c69055427d00694cd61d8d" name="ad6072335a0c69055427d00694cd61d8d"></a>
|
||
|
|
XFEventStatus </td><td class="memItemRight" valign="bottom"><b>processEvent</b> () override</td></tr>
|
||
|
|
<tr class="memdesc:ad6072335a0c69055427d00694cd61d8d"><td class="mdescLeft"> </td><td class="mdescRight">Remplementation from XFBehavior. <br /></td></tr>
|
||
|
|
<tr class="separator:ad6072335a0c69055427d00694cd61d8d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8b9b20e0d42edff473a4918422677fbf"><td class="memItemLeft" align="right" valign="top"><a id="a8b9b20e0d42edff473a4918422677fbf" name="a8b9b20e0d42edff473a4918422677fbf"></a>
|
||
|
|
int </td><td class="memItemRight" valign="bottom"><b>getRepeatInterval</b> () const</td></tr>
|
||
|
|
<tr class="memdesc:a8b9b20e0d42edff473a4918422677fbf"><td class="mdescLeft"> </td><td class="mdescRight">Returns repeat interval. Accessor for #_repeatInterval. <br /></td></tr>
|
||
|
|
<tr class="separator:a8b9b20e0d42edff473a4918422677fbf"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aacadf4b142dbf0b9e82cc3bd822386b1"><td class="memItemLeft" align="right" valign="top"><a id="aacadf4b142dbf0b9e82cc3bd822386b1" name="aacadf4b142dbf0b9e82cc3bd822386b1"></a>
|
||
|
|
string </td><td class="memItemRight" valign="bottom"><b>getText</b> () const</td></tr>
|
||
|
|
<tr class="memdesc:aacadf4b142dbf0b9e82cc3bd822386b1"><td class="mdescLeft"> </td><td class="mdescRight">Returns text. Accessor for #_text. <br /></td></tr>
|
||
|
|
<tr class="separator:aacadf4b142dbf0b9e82cc3bd822386b1"><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:ac6209733c246d4614371735cedb49743"><td class="memItemLeft" align="right" valign="top"><a id="ac6209733c246d4614371735cedb49743" name="ac6209733c246d4614371735cedb49743"></a>
|
||
|
|
<a class="el" href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4">eMainState</a> </td><td class="memItemRight" valign="bottom"><b>currentState_</b></td></tr>
|
||
|
|
<tr class="memdesc:ac6209733c246d4614371735cedb49743"><td class="mdescLeft"> </td><td class="mdescRight">Attribute indicating currently active state. <br /></td></tr>
|
||
|
|
<tr class="separator:ac6209733c246d4614371735cedb49743"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a0c39afad88037717ef18c7386133bb9e"><td class="memItemLeft" align="right" valign="top"><a id="a0c39afad88037717ef18c7386133bb9e" name="a0c39afad88037717ef18c7386133bb9e"></a>
|
||
|
|
int </td><td class="memItemRight" valign="bottom"><b>repeatInterval_</b></td></tr>
|
||
|
|
<tr class="memdesc:a0c39afad88037717ef18c7386133bb9e"><td class="mdescLeft"> </td><td class="mdescRight">Interval in milliseconds to repeat text in state machine. <br /></td></tr>
|
||
|
|
<tr class="separator:a0c39afad88037717ef18c7386133bb9e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a83719c758f1098b7dc1f0aa16392fd4e"><td class="memItemLeft" align="right" valign="top"><a id="a83719c758f1098b7dc1f0aa16392fd4e" name="a83719c758f1098b7dc1f0aa16392fd4e"></a>
|
||
|
|
string </td><td class="memItemRight" valign="bottom"><b>text_</b></td></tr>
|
||
|
|
<tr class="memdesc:a83719c758f1098b7dc1f0aa16392fd4e"><td class="mdescLeft"> </td><td class="mdescRight">Text to display in state machine state. <br /></td></tr>
|
||
|
|
<tr class="separator:a83719c758f1098b7dc1f0aa16392fd4e"><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 little state machine saying something in a predefined time interval.</p>
|
||
|
|
<p >Following you will find the state machine implemented by <a class="el" href="class_state_machine01.html">StateMachine01</a>: </p><div class="image">
|
||
|
|
<img src="state-machine01.png" alt=""/>
|
||
|
|
<div class="caption">
|
||
|
|
State Machine implemented by StateMachine01</div></div>
|
||
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
||
|
|
<a id="a9b3e24a26eba26f2c2c3ad4792802ee4" name="a9b3e24a26eba26f2c2c3ad4792802ee4"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b3e24a26eba26f2c2c3ad4792802ee4">◆ </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_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4">StateMachine01::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="a9b3e24a26eba26f2c2c3ad4792802ee4a77e7b6a6b9596d97c144ef82a0603224" name="a9b3e24a26eba26f2c2c3ad4792802ee4a77e7b6a6b9596d97c144ef82a0603224"></a>STATE_UNKNOWN </td><td class="fielddoc"><p >Unknown state. </p>
|
||
|
|
</td></tr>
|
||
|
|
<tr><td class="fieldname"><a id="a9b3e24a26eba26f2c2c3ad4792802ee4aa53cb443dce0428eabfcdea1d0ba5e15" name="a9b3e24a26eba26f2c2c3ad4792802ee4aa53cb443dce0428eabfcdea1d0ba5e15"></a>STATE_INITIAL </td><td class="fielddoc"><p >Initial state. </p>
|
||
|
|
</td></tr>
|
||
|
|
<tr><td class="fieldname"><a id="a9b3e24a26eba26f2c2c3ad4792802ee4a96ec8d47fea8cfbd18748f807ae0cffc" name="a9b3e24a26eba26f2c2c3ad4792802ee4a96ec8d47fea8cfbd18748f807ae0cffc"></a>STATE_SAY_HELLO </td><td class="fielddoc"><p >Say hello state. </p>
|
||
|
|
</td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a4c91f12289315c5c8438c87feea424d6" name="a4c91f12289315c5c8438c87feea424d6"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c91f12289315c5c8438c87feea424d6">◆ </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_machine01.html#a4c91f12289315c5c8438c87feea424d6">StateMachine01::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="a4c91f12289315c5c8438c87feea424d6a560e140ef292acbebd9dd834f4907f99" name="a4c91f12289315c5c8438c87feea424d6a560e140ef292acbebd9dd834f4907f99"></a>Timeout_SAY_HELLO_id </td><td class="fielddoc"><p >Timeout id for WAIT. </p>
|
||
|
|
</td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a id="a6e59a3d7ed9bebba660b4983f3ad4558" name="a6e59a3d7ed9bebba660b4983f3ad4558"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6e59a3d7ed9bebba660b4983f3ad4558">◆ </a></span>StateMachine01()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">StateMachine01::StateMachine01 </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">int </td>
|
||
|
|
<td class="paramname"><em>repeatInterval</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>text</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p >Constructor</p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">repeatInterval</td><td>Interval in milliseconds used in state machine. </td></tr>
|
||
|
|
<tr><td class="paramname">text</td><td>Text to display by the state machine. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</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/test1/src/app/<a class="el" href="statemachine01_8h_source.html">statemachine01.h</a></li>
|
||
|
|
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/test-bench/test1/src/app/statemachine01.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>
|