This repository has been archived on 2024-01-25. You can view files and clone it, but cannot push or open issues or pull requests.
XF/test-bench/doxygen/output/html/statemachine04b_8h_source.html
2023-09-19 15:59:49 +02:00

127 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: C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/test-bench/test4/src/app/statemachine04b.h Source File</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_3e0d2c868be6a3e5150a628fd2a00a9b.html">test4</a></li><li class="navelem"><a class="el" href="dir_6e75a17059e2e7fdde7c9289c2ed92a7.html">src</a></li><li class="navelem"><a class="el" href="dir_ef5ec6f15bc519b773c1cd6cf32bc83d.html">app</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">statemachine04b.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef STATEMACHINE04B_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define STATEMACHINE04B_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &quot;xf/behavior.h&quot;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="class_state_machine04b.html"> 17</a></span><span class="keyword">class </span><a class="code hl_class" href="class_state_machine04b.html">StateMachine04b</a> : <span class="keyword">public</span> XFBehavior</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>{</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_class" href="class_state_machine04b.html">StateMachine04b</a>();</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_class" href="class_state_machine04b.html">~StateMachine04b</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> XFEventStatus <a class="code hl_function" href="class_state_machine04b.html#a5f52bf9e9543660a3cf08b2bb18a3ec4">processEvent</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_state_machine04b.html#ab3740d77249ca8a8fa191a914c9a3229">isTimeoutEvent</a>(<span class="keywordtype">int</span> timeoutId); </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_state_machine04b.html#a3dda278f8e86861a4397b1a68402e799">isRestartEvent</a>() <span class="keyword">const</span>; </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="class_state_machine04b.html#a934a9e1fb8d1ce4ce79890d935951cad"> 33</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <a class="code hl_enumvalue" href="class_state_machine04b.html#a934a9e1fb8d1ce4ce79890d935951cada2c6f576f62f8eb09f97873704dd1f24f">Timeout_WAIT_id</a> = 1 </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="class_state_machine04b.html#a934a9e1fb8d1ce4ce79890d935951cada2c6f576f62f8eb09f97873704dd1f24f"> 36</a></span> } <a class="code hl_enumeration" href="class_state_machine04b.html#a934a9e1fb8d1ce4ce79890d935951cad">eTimeoutId</a>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08"> 42</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> {</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08a5e246d22804803d10077cca5cf6d55a9"> 44</a></span> <a class="code hl_enumvalue" href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08a5e246d22804803d10077cca5cf6d55a9">STATE_UNKOWN</a> = 0, </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08ac7a06f3e776da6568962cde9e46a1604"> 45</a></span> <a class="code hl_enumvalue" href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08ac7a06f3e776da6568962cde9e46a1604">STATE_INITIAL</a> = 1, </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_enumvalue" href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08acb6aed934f04df5098b9bb08610fd1b0">STATE_WAIT</a> = 2 </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08acb6aed934f04df5098b9bb08610fd1b0"> 47</a></span> } <a class="code hl_enumeration" href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08">eMainState</a>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="class_state_machine04b.html#aacec0a31225b7d0da00cdda770ac3683"> 49</a></span> <a class="code hl_enumeration" href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08">eMainState</a> <a class="code hl_variable" href="class_state_machine04b.html#aacec0a31225b7d0da00cdda770ac3683">currentState_</a>; </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="class_state_machine04b.html#acbae2fd9c84e10d49f3fcd3404e34eed"> 50</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="class_state_machine04b.html#acbae2fd9c84e10d49f3fcd3404e34eed">timeout_</a>; </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>};</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="preprocessor">#endif </span><span class="comment">// STATEMACHINE04B_H</span></div>
<div class="ttc" id="aclass_state_machine04b_html"><div class="ttname"><a href="class_state_machine04b.html">StateMachine04b</a></div><div class="ttdef"><b>Definition:</b> statemachine04b.h:18</div></div>
<div class="ttc" id="aclass_state_machine04b_html_a3dda278f8e86861a4397b1a68402e799"><div class="ttname"><a href="class_state_machine04b.html#a3dda278f8e86861a4397b1a68402e799">StateMachine04b::isRestartEvent</a></div><div class="ttdeci">bool isRestartEvent() const</div><div class="ttdoc">Returns true in case state machine is currently processing an evRestart event.</div><div class="ttdef"><b>Definition:</b> statemachine04b.cpp:81</div></div>
<div class="ttc" id="aclass_state_machine04b_html_a5f52bf9e9543660a3cf08b2bb18a3ec4"><div class="ttname"><a href="class_state_machine04b.html#a5f52bf9e9543660a3cf08b2bb18a3ec4">StateMachine04b::processEvent</a></div><div class="ttdeci">XFEventStatus processEvent() override</div><div class="ttdef"><b>Definition:</b> statemachine04b.cpp:20</div></div>
<div class="ttc" id="aclass_state_machine04b_html_a6cbedd342fba4cc152aa61e6e51f3d08"><div class="ttname"><a href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08">StateMachine04b::eMainState</a></div><div class="ttdeci">eMainState</div><div class="ttdef"><b>Definition:</b> statemachine04b.h:43</div></div>
<div class="ttc" id="aclass_state_machine04b_html_a6cbedd342fba4cc152aa61e6e51f3d08a5e246d22804803d10077cca5cf6d55a9"><div class="ttname"><a href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08a5e246d22804803d10077cca5cf6d55a9">StateMachine04b::STATE_UNKOWN</a></div><div class="ttdeci">@ STATE_UNKOWN</div><div class="ttdoc">Unkown state.</div><div class="ttdef"><b>Definition:</b> statemachine04b.h:44</div></div>
<div class="ttc" id="aclass_state_machine04b_html_a6cbedd342fba4cc152aa61e6e51f3d08ac7a06f3e776da6568962cde9e46a1604"><div class="ttname"><a href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08ac7a06f3e776da6568962cde9e46a1604">StateMachine04b::STATE_INITIAL</a></div><div class="ttdeci">@ STATE_INITIAL</div><div class="ttdoc">Initial state.</div><div class="ttdef"><b>Definition:</b> statemachine04b.h:45</div></div>
<div class="ttc" id="aclass_state_machine04b_html_a6cbedd342fba4cc152aa61e6e51f3d08acb6aed934f04df5098b9bb08610fd1b0"><div class="ttname"><a href="class_state_machine04b.html#a6cbedd342fba4cc152aa61e6e51f3d08acb6aed934f04df5098b9bb08610fd1b0">StateMachine04b::STATE_WAIT</a></div><div class="ttdeci">@ STATE_WAIT</div><div class="ttdoc">Wait for timeout state.</div><div class="ttdef"><b>Definition:</b> statemachine04b.h:46</div></div>
<div class="ttc" id="aclass_state_machine04b_html_a934a9e1fb8d1ce4ce79890d935951cad"><div class="ttname"><a href="class_state_machine04b.html#a934a9e1fb8d1ce4ce79890d935951cad">StateMachine04b::eTimeoutId</a></div><div class="ttdeci">eTimeoutId</div><div class="ttdef"><b>Definition:</b> statemachine04b.h:34</div></div>
<div class="ttc" id="aclass_state_machine04b_html_a934a9e1fb8d1ce4ce79890d935951cada2c6f576f62f8eb09f97873704dd1f24f"><div class="ttname"><a href="class_state_machine04b.html#a934a9e1fb8d1ce4ce79890d935951cada2c6f576f62f8eb09f97873704dd1f24f">StateMachine04b::Timeout_WAIT_id</a></div><div class="ttdeci">@ Timeout_WAIT_id</div><div class="ttdoc">Timeout id for WAIT.</div><div class="ttdef"><b>Definition:</b> statemachine04b.h:35</div></div>
<div class="ttc" id="aclass_state_machine04b_html_aacec0a31225b7d0da00cdda770ac3683"><div class="ttname"><a href="class_state_machine04b.html#aacec0a31225b7d0da00cdda770ac3683">StateMachine04b::currentState_</a></div><div class="ttdeci">eMainState currentState_</div><div class="ttdoc">Attribute indicating currently active state.</div><div class="ttdef"><b>Definition:</b> statemachine04b.h:49</div></div>
<div class="ttc" id="aclass_state_machine04b_html_ab3740d77249ca8a8fa191a914c9a3229"><div class="ttname"><a href="class_state_machine04b.html#ab3740d77249ca8a8fa191a914c9a3229">StateMachine04b::isTimeoutEvent</a></div><div class="ttdeci">bool isTimeoutEvent(int timeoutId)</div><div class="ttdoc">Returns true in case state machine is currently processing a timeout.</div><div class="ttdef"><b>Definition:</b> statemachine04b.cpp:75</div></div>
<div class="ttc" id="aclass_state_machine04b_html_acbae2fd9c84e10d49f3fcd3404e34eed"><div class="ttname"><a href="class_state_machine04b.html#acbae2fd9c84e10d49f3fcd3404e34eed">StateMachine04b::timeout_</a></div><div class="ttdeci">int timeout_</div><div class="ttdoc">Timeout attribute counting rised timeouts in state machine.</div><div class="ttdef"><b>Definition:</b> statemachine04b.h:50</div></div>
</div><!-- fragment --></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>