235 lines
14 KiB
HTML
235 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: StateMachine05b 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_machine05b-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">StateMachine05b Class Reference<div class="ingroups"><a class="el" href="group__test05.html">Fifth Test Project</a></div></div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="statemachine05b_8h_source.html">statemachine05b.h</a>></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for StateMachine05b:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="class_state_machine05b__inherit__graph.png" border="0" usemap="#a_state_machine05b_inherit__map" alt="Inheritance graph"/></div>
|
||
|
|
<map name="a_state_machine05b_inherit__map" id="a_state_machine05b_inherit__map">
|
||
|
|
<area shape="rect" title=" " alt="" coords="5,131,156,267"/>
|
||
|
|
<area shape="rect" title=" " alt="" coords="37,5,124,83"/>
|
||
|
|
</map>
|
||
|
|
</div>
|
||
|
|
<div class="dynheader">
|
||
|
|
Collaboration diagram for StateMachine05b:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="class_state_machine05b__coll__graph.png" border="0" usemap="#a_state_machine05b_coll__map" alt="Collaboration graph"/></div>
|
||
|
|
<map name="a_state_machine05b_coll__map" id="a_state_machine05b_coll__map">
|
||
|
|
<area shape="rect" title=" " alt="" coords="5,131,156,267"/>
|
||
|
|
<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:aa7bc3dfd48966a076caa1dde4617f8fa"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine05b.html#aa7bc3dfd48966a076caa1dde4617f8fa">StateMachine05b</a> (std::string text)</td></tr>
|
||
|
|
<tr class="separator:aa7bc3dfd48966a076caa1dde4617f8fa"><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:a9ce1b583d3802ec945155dc580761438"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine05b.html#a9ce1b583d3802ec945155dc580761438">eTimeoutId</a> { <a class="el" href="class_state_machine05b.html#a9ce1b583d3802ec945155dc580761438aec65cab72310a49b93802c3cae2153b0">Timeout_SAY_HELLO_id</a> = 1
|
||
|
|
}</td></tr>
|
||
|
|
<tr class="separator:a9ce1b583d3802ec945155dc580761438"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5b365dfa048765081afeb63bcc37192f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine05b.html#a5b365dfa048765081afeb63bcc37192f">eMainState</a> { <a class="el" href="class_state_machine05b.html#a5b365dfa048765081afeb63bcc37192fa0481f46249444f3b106086d2407a1ff4">STATE_UNKNOWN</a> = 0
|
||
|
|
, <a class="el" href="class_state_machine05b.html#a5b365dfa048765081afeb63bcc37192fa1d63c1ea57ac4b573d2dce8db2bd3d9f">STATE_INITIAL</a> = 1
|
||
|
|
, <a class="el" href="class_state_machine05b.html#a5b365dfa048765081afeb63bcc37192fa1cc7bcdd345d9af7da82d3425dce4aad">STATE_SAY_TEXT</a> = 2
|
||
|
|
}</td></tr>
|
||
|
|
<tr class="separator:a5b365dfa048765081afeb63bcc37192f"><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:a5339cf91ed80c9680dbd38ba7ca7306d"><td class="memItemLeft" align="right" valign="top"><a id="a5339cf91ed80c9680dbd38ba7ca7306d" name="a5339cf91ed80c9680dbd38ba7ca7306d"></a>
|
||
|
|
XFEventStatus </td><td class="memItemRight" valign="bottom"><b>processEvent</b> () override</td></tr>
|
||
|
|
<tr class="memdesc:a5339cf91ed80c9680dbd38ba7ca7306d"><td class="mdescLeft"> </td><td class="mdescRight">Remplementation from XFReactive. <br /></td></tr>
|
||
|
|
<tr class="separator:a5339cf91ed80c9680dbd38ba7ca7306d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aad06a19c297d1a1b60037afe08769cc1"><td class="memItemLeft" align="right" valign="top"><a id="aad06a19c297d1a1b60037afe08769cc1" name="aad06a19c297d1a1b60037afe08769cc1"></a>
|
||
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>getText</b> () const</td></tr>
|
||
|
|
<tr class="memdesc:aad06a19c297d1a1b60037afe08769cc1"><td class="mdescLeft"> </td><td class="mdescRight">Returns text. Accessor for #_text. <br /></td></tr>
|
||
|
|
<tr class="separator:aad06a19c297d1a1b60037afe08769cc1"><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:a9e07d919271928ce93e18a1f3690af98"><td class="memItemLeft" align="right" valign="top"><a id="a9e07d919271928ce93e18a1f3690af98" name="a9e07d919271928ce93e18a1f3690af98"></a>
|
||
|
|
<a class="el" href="class_state_machine05b.html#a5b365dfa048765081afeb63bcc37192f">eMainState</a> </td><td class="memItemRight" valign="bottom"><b>currentState_</b></td></tr>
|
||
|
|
<tr class="memdesc:a9e07d919271928ce93e18a1f3690af98"><td class="mdescLeft"> </td><td class="mdescRight">Attribute indicating currently active state. <br /></td></tr>
|
||
|
|
<tr class="separator:a9e07d919271928ce93e18a1f3690af98"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa6442c36c4b2471a07aca6bf61198b2f"><td class="memItemLeft" align="right" valign="top"><a id="aa6442c36c4b2471a07aca6bf61198b2f" name="aa6442c36c4b2471a07aca6bf61198b2f"></a>
|
||
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>text_</b></td></tr>
|
||
|
|
<tr class="memdesc:aa6442c36c4b2471a07aca6bf61198b2f"><td class="mdescLeft"> </td><td class="mdescRight">Text to display in state machine state. <br /></td></tr>
|
||
|
|
<tr class="separator:aa6442c36c4b2471a07aca6bf61198b2f"><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. The text to output is passed to the object at construction time. The time interval is fixed to one second.</p>
|
||
|
|
<p >Following you will find the state machine implemented by <a class="el" href="class_state_machine05b.html">StateMachine05b</a>: </p><div class="image">
|
||
|
|
<img src="state-machine05b.png" alt=""/>
|
||
|
|
<div class="caption">
|
||
|
|
State Machine implemented by StateMachine05b</div></div>
|
||
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
||
|
|
<a id="a5b365dfa048765081afeb63bcc37192f" name="a5b365dfa048765081afeb63bcc37192f"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5b365dfa048765081afeb63bcc37192f">◆ </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_machine05b.html#a5b365dfa048765081afeb63bcc37192f">StateMachine05b::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="a5b365dfa048765081afeb63bcc37192fa0481f46249444f3b106086d2407a1ff4" name="a5b365dfa048765081afeb63bcc37192fa0481f46249444f3b106086d2407a1ff4"></a>STATE_UNKNOWN </td><td class="fielddoc"><p >Unknown state. </p>
|
||
|
|
</td></tr>
|
||
|
|
<tr><td class="fieldname"><a id="a5b365dfa048765081afeb63bcc37192fa1d63c1ea57ac4b573d2dce8db2bd3d9f" name="a5b365dfa048765081afeb63bcc37192fa1d63c1ea57ac4b573d2dce8db2bd3d9f"></a>STATE_INITIAL </td><td class="fielddoc"><p >Initial state. </p>
|
||
|
|
</td></tr>
|
||
|
|
<tr><td class="fieldname"><a id="a5b365dfa048765081afeb63bcc37192fa1cc7bcdd345d9af7da82d3425dce4aad" name="a5b365dfa048765081afeb63bcc37192fa1cc7bcdd345d9af7da82d3425dce4aad"></a>STATE_SAY_TEXT </td><td class="fielddoc"><p >Say "text" state. </p>
|
||
|
|
</td></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a9ce1b583d3802ec945155dc580761438" name="a9ce1b583d3802ec945155dc580761438"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9ce1b583d3802ec945155dc580761438">◆ </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_machine05b.html#a9ce1b583d3802ec945155dc580761438">StateMachine05b::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="a9ce1b583d3802ec945155dc580761438aec65cab72310a49b93802c3cae2153b0" name="a9ce1b583d3802ec945155dc580761438aec65cab72310a49b93802c3cae2153b0"></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="aa7bc3dfd48966a076caa1dde4617f8fa" name="aa7bc3dfd48966a076caa1dde4617f8fa"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa7bc3dfd48966a076caa1dde4617f8fa">◆ </a></span>StateMachine05b()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">StateMachine05b::StateMachine05b </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">std::string </td>
|
||
|
|
<td class="paramname"><em>text</em></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">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/test5/src/app/<a class="el" href="statemachine05b_8h_source.html">statemachine05b.h</a></li>
|
||
|
|
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/test-bench/test5/src/app/statemachine05b.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>
|