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

234
test-bench/doxygen/output/html/class_state_machine05a.html Normal file
View File

@@ -0,0 +1,234 @@
<!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: StateMachine05a 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="#pub-methods">Public Member Functions</a> &#124;
<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_machine05a-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">StateMachine05a 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 &lt;<a class="el" href="statemachine05a_8h_source.html">statemachine05a.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for StateMachine05a:</div>
<div class="dyncontent">
<div class="center"><img src="class_state_machine05a__inherit__graph.png" border="0" usemap="#a_state_machine05a_inherit__map" alt="Inheritance graph"/></div>
<map name="a_state_machine05a_inherit__map" id="a_state_machine05a_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 StateMachine05a:</div>
<div class="dyncontent">
<div class="center"><img src="class_state_machine05a__coll__graph.png" border="0" usemap="#a_state_machine05a_coll__map" alt="Collaboration graph"/></div>
<map name="a_state_machine05a_coll__map" id="a_state_machine05a_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:a09c9b5462668ad70fc623e6c1d42add5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine05a.html#a09c9b5462668ad70fc623e6c1d42add5">StateMachine05a</a> (std::string text)</td></tr>
<tr class="separator:a09c9b5462668ad70fc623e6c1d42add5"><td class="memSeparator" colspan="2">&#160;</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:a5fedfdc32df8f531a18124e80612929c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine05a.html#a5fedfdc32df8f531a18124e80612929c">eTimeoutId</a> { <a class="el" href="class_state_machine05a.html#a5fedfdc32df8f531a18124e80612929caf9b5289d5651e38ce3650a7d7d55f987">Timeout_SAY_HELLO_id</a> = 1
}</td></tr>
<tr class="separator:a5fedfdc32df8f531a18124e80612929c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a514a5572dec383e11fc3a0744bac179c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_state_machine05a.html#a514a5572dec383e11fc3a0744bac179c">eMainState</a> { <a class="el" href="class_state_machine05a.html#a514a5572dec383e11fc3a0744bac179ca40fc48e78e734c795c0ce6718aa58000">STATE_UNKNOWN</a> = 0
, <a class="el" href="class_state_machine05a.html#a514a5572dec383e11fc3a0744bac179cabe926d790e5d121d1aec53afdbef2588">STATE_INITIAL</a> = 1
, <a class="el" href="class_state_machine05a.html#a514a5572dec383e11fc3a0744bac179ca5f404f48d39362d0a2cbb5841f14ce90">STATE_SAY_TEXT</a> = 2
}</td></tr>
<tr class="separator:a514a5572dec383e11fc3a0744bac179c"><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:a638bd8c8185bb37f13df384393bfe0e0"><td class="memItemLeft" align="right" valign="top"><a id="a638bd8c8185bb37f13df384393bfe0e0" name="a638bd8c8185bb37f13df384393bfe0e0"></a>
XFEventStatus&#160;</td><td class="memItemRight" valign="bottom"><b>processEvent</b> () override</td></tr>
<tr class="memdesc:a638bd8c8185bb37f13df384393bfe0e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remplementation from XFReactive. <br /></td></tr>
<tr class="separator:a638bd8c8185bb37f13df384393bfe0e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a682dfb3c3036cbe27a0ca63d86f50732"><td class="memItemLeft" align="right" valign="top"><a id="a682dfb3c3036cbe27a0ca63d86f50732" name="a682dfb3c3036cbe27a0ca63d86f50732"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>getText</b> () const</td></tr>
<tr class="memdesc:a682dfb3c3036cbe27a0ca63d86f50732"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns text. Accessor for #_text. <br /></td></tr>
<tr class="separator:a682dfb3c3036cbe27a0ca63d86f50732"><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:a890b19f66f58724b213ce07f4770086c"><td class="memItemLeft" align="right" valign="top"><a id="a890b19f66f58724b213ce07f4770086c" name="a890b19f66f58724b213ce07f4770086c"></a>
<a class="el" href="class_state_machine05a.html#a514a5572dec383e11fc3a0744bac179c">eMainState</a>&#160;</td><td class="memItemRight" valign="bottom"><b>currentState_</b></td></tr>
<tr class="memdesc:a890b19f66f58724b213ce07f4770086c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attribute indicating currently active state. <br /></td></tr>
<tr class="separator:a890b19f66f58724b213ce07f4770086c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fa372f8683d28aa18f96740950934f5"><td class="memItemLeft" align="right" valign="top"><a id="a7fa372f8683d28aa18f96740950934f5" name="a7fa372f8683d28aa18f96740950934f5"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>text_</b></td></tr>
<tr class="memdesc:a7fa372f8683d28aa18f96740950934f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Text to display in state machine state. <br /></td></tr>
<tr class="separator:a7fa372f8683d28aa18f96740950934f5"><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 >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 500 milliseconds.</p>
<p >Following you will find the state machine implemented by <a class="el" href="class_state_machine05a.html">StateMachine05a</a>: </p><div class="image">
<img src="state-machine05a.png" alt=""/>
<div class="caption">
State Machine implemented by StateMachine05a</div></div>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a514a5572dec383e11fc3a0744bac179c" name="a514a5572dec383e11fc3a0744bac179c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a514a5572dec383e11fc3a0744bac179c">&#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_machine05a.html#a514a5572dec383e11fc3a0744bac179c">StateMachine05a::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="a514a5572dec383e11fc3a0744bac179ca40fc48e78e734c795c0ce6718aa58000" name="a514a5572dec383e11fc3a0744bac179ca40fc48e78e734c795c0ce6718aa58000"></a>STATE_UNKNOWN&#160;</td><td class="fielddoc"><p >Unknown state. </p>
</td></tr>
<tr><td class="fieldname"><a id="a514a5572dec383e11fc3a0744bac179cabe926d790e5d121d1aec53afdbef2588" name="a514a5572dec383e11fc3a0744bac179cabe926d790e5d121d1aec53afdbef2588"></a>STATE_INITIAL&#160;</td><td class="fielddoc"><p >Initial state. </p>
</td></tr>
<tr><td class="fieldname"><a id="a514a5572dec383e11fc3a0744bac179ca5f404f48d39362d0a2cbb5841f14ce90" name="a514a5572dec383e11fc3a0744bac179ca5f404f48d39362d0a2cbb5841f14ce90"></a>STATE_SAY_TEXT&#160;</td><td class="fielddoc"><p >Say "text" state. </p>
</td></tr>
</table>
</div>
</div>
<a id="a5fedfdc32df8f531a18124e80612929c" name="a5fedfdc32df8f531a18124e80612929c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fedfdc32df8f531a18124e80612929c">&#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_machine05a.html#a5fedfdc32df8f531a18124e80612929c">StateMachine05a::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="a5fedfdc32df8f531a18124e80612929caf9b5289d5651e38ce3650a7d7d55f987" name="a5fedfdc32df8f531a18124e80612929caf9b5289d5651e38ce3650a7d7d55f987"></a>Timeout_SAY_HELLO_id&#160;</td><td class="fielddoc"><p >Timeout id for WAIT. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a09c9b5462668ad70fc623e6c1d42add5" name="a09c9b5462668ad70fc623e6c1d42add5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09c9b5462668ad70fc623e6c1d42add5">&#9670;&nbsp;</a></span>StateMachine05a()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StateMachine05a::StateMachine05a </td>
<td>(</td>
<td class="paramtype">std::string&#160;</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="statemachine05a_8h_source.html">statemachine05a.h</a></li>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/test-bench/test5/src/app/statemachine05a.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>