Klagarge/XF
Archived
1
0
Fork 0
Code Issues Pull Requests Releases 1 Activity
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.
main
XF/test-bench/doxygen/output/html/statemachine01_8h_source.html

133 lines
17 KiB
HTML
Raw Permalink Normal View History

Initial commit
2023-09-19 13:59:49 +00:00
<!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/test1/src/app/statemachine01.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_13bf8d714d14c32ee50a8846264d07f3.html">test1</a></li><li class="navelem"><a class="el" href="dir_0d6602adb30e779fae853ef4c55ad36c.html">src</a></li><li class="navelem"><a class="el" href="dir_7fec92c331b140b3870d22bea1284287.html">app</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">statemachine01.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 STATEMACHINE01_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define STATEMACHINE01_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 &quot;xf/behavior.h&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">using namespace </span>std;</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="class_state_machine01.html"> 18</a></span><span class="keyword">class </span><a class="code hl_class" href="class_state_machine01.html">StateMachine01</a> : <span class="keyword">public</span> XFBehavior</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>{</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_function" href="class_state_machine01.html#a6e59a3d7ed9bebba660b4983f3ad4558">StateMachine01</a>(<span class="keywordtype">int</span> repeatInterval, <span class="keywordtype">string</span> text);</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_class" href="class_state_machine01.html">~StateMachine01</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> XFEventStatus <a class="code hl_function" href="class_state_machine01.html#ad6072335a0c69055427d00694cd61d8d">processEvent</a>() <span class="keyword">override</span>; </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="class_state_machine01.html#a8b9b20e0d42edff473a4918422677fbf"> 27</a></span> <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code hl_function" href="class_state_machine01.html#a8b9b20e0d42edff473a4918422677fbf">getRepeatInterval</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="class_state_machine01.html#a0c39afad88037717ef18c7386133bb9e">repeatInterval_</a>; } </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="class_state_machine01.html#aacadf4b142dbf0b9e82cc3bd822386b1"> 28</a></span> <span class="keyword">inline</span> <span class="keywordtype">string</span> <a class="code hl_function" href="class_state_machine01.html#aacadf4b142dbf0b9e82cc3bd822386b1">getText</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code hl_variable" href="class_state_machine01.html#a83719c758f1098b7dc1f0aa16392fd4e">text_</a>; } </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="class_state_machine01.html#a4c91f12289315c5c8438c87feea424d6"> 34</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <a class="code hl_enumvalue" href="class_state_machine01.html#a4c91f12289315c5c8438c87feea424d6a560e140ef292acbebd9dd834f4907f99">Timeout_SAY_HELLO_id</a> = 1 </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="class_state_machine01.html#a4c91f12289315c5c8438c87feea424d6a560e140ef292acbebd9dd834f4907f99"> 37</a></span> } <a class="code hl_enumeration" href="class_state_machine01.html#a4c91f12289315c5c8438c87feea424d6">eTimeoutId</a>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4"> 43</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> {</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4a77e7b6a6b9596d97c144ef82a0603224"> 45</a></span> <a class="code hl_enumvalue" href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4a77e7b6a6b9596d97c144ef82a0603224">STATE_UNKNOWN</a> = 0, </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4aa53cb443dce0428eabfcdea1d0ba5e15"> 46</a></span> <a class="code hl_enumvalue" href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4aa53cb443dce0428eabfcdea1d0ba5e15">STATE_INITIAL</a> = 1, </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_enumvalue" href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4a96ec8d47fea8cfbd18748f807ae0cffc">STATE_SAY_HELLO</a> = 2 </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4a96ec8d47fea8cfbd18748f807ae0cffc"> 48</a></span> } <a class="code hl_enumeration" href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4">eMainState</a>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="class_state_machine01.html#ac6209733c246d4614371735cedb49743"> 50</a></span> <a class="code hl_enumeration" href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4">eMainState</a> <a class="code hl_variable" href="class_state_machine01.html#ac6209733c246d4614371735cedb49743">currentState_</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"><a class="line" href="class_state_machine01.html#a0c39afad88037717ef18c7386133bb9e"> 52</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="class_state_machine01.html#a0c39afad88037717ef18c7386133bb9e">repeatInterval_</a>; </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="class_state_machine01.html#a83719c758f1098b7dc1f0aa16392fd4e"> 53</a></span> <span class="keywordtype">string</span> <a class="code hl_variable" href="class_state_machine01.html#a83719c758f1098b7dc1f0aa16392fd4e">text_</a>; </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>};</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#endif </span><span class="comment">// STATEMACHINE01_H</span></div>
<div class="ttc" id="aclass_state_machine01_html"><div class="ttname"><a href="class_state_machine01.html">StateMachine01</a></div><div class="ttdef"><b>Definition:</b> statemachine01.h:19</div></div>
<div class="ttc" id="aclass_state_machine01_html_a0c39afad88037717ef18c7386133bb9e"><div class="ttname"><a href="class_state_machine01.html#a0c39afad88037717ef18c7386133bb9e">StateMachine01::repeatInterval_</a></div><div class="ttdeci">int repeatInterval_</div><div class="ttdoc">Interval in milliseconds to repeat text in state machine.</div><div class="ttdef"><b>Definition:</b> statemachine01.h:52</div></div>
<div class="ttc" id="aclass_state_machine01_html_a4c91f12289315c5c8438c87feea424d6"><div class="ttname"><a href="class_state_machine01.html#a4c91f12289315c5c8438c87feea424d6">StateMachine01::eTimeoutId</a></div><div class="ttdeci">eTimeoutId</div><div class="ttdef"><b>Definition:</b> statemachine01.h:35</div></div>
<div class="ttc" id="aclass_state_machine01_html_a4c91f12289315c5c8438c87feea424d6a560e140ef292acbebd9dd834f4907f99"><div class="ttname"><a href="class_state_machine01.html#a4c91f12289315c5c8438c87feea424d6a560e140ef292acbebd9dd834f4907f99">StateMachine01::Timeout_SAY_HELLO_id</a></div><div class="ttdeci">@ Timeout_SAY_HELLO_id</div><div class="ttdoc">Timeout id for WAIT.</div><div class="ttdef"><b>Definition:</b> statemachine01.h:36</div></div>
<div class="ttc" id="aclass_state_machine01_html_a6e59a3d7ed9bebba660b4983f3ad4558"><div class="ttname"><a href="class_state_machine01.html#a6e59a3d7ed9bebba660b4983f3ad4558">StateMachine01::StateMachine01</a></div><div class="ttdeci">StateMachine01(int repeatInterval, string text)</div><div class="ttdef"><b>Definition:</b> statemachine01.cpp:11</div></div>
<div class="ttc" id="aclass_state_machine01_html_a83719c758f1098b7dc1f0aa16392fd4e"><div class="ttname"><a href="class_state_machine01.html#a83719c758f1098b7dc1f0aa16392fd4e">StateMachine01::text_</a></div><div class="ttdeci">string text_</div><div class="ttdoc">Text to display in state machine state.</div><div class="ttdef"><b>Definition:</b> statemachine01.h:53</div></div>
<div class="ttc" id="aclass_state_machine01_html_a8b9b20e0d42edff473a4918422677fbf"><div class="ttname"><a href="class_state_machine01.html#a8b9b20e0d42edff473a4918422677fbf">StateMachine01::getRepeatInterval</a></div><div class="ttdeci">int getRepeatInterval() const</div><div class="ttdoc">Returns repeat interval. Accessor for #_repeatInterval.</div><div class="ttdef"><b>Definition:</b> statemachine01.h:27</div></div>
<div class="ttc" id="aclass_state_machine01_html_a9b3e24a26eba26f2c2c3ad4792802ee4"><div class="ttname"><a href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4">StateMachine01::eMainState</a></div><div class="ttdeci">eMainState</div><div class="ttdef"><b>Definition:</b> statemachine01.h:44</div></div>
<div class="ttc" id="aclass_state_machine01_html_a9b3e24a26eba26f2c2c3ad4792802ee4a77e7b6a6b9596d97c144ef82a0603224"><div class="ttname"><a href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4a77e7b6a6b9596d97c144ef82a0603224">StateMachine01::STATE_UNKNOWN</a></div><div class="ttdeci">@ STATE_UNKNOWN</div><div class="ttdoc">Unknown state.</div><div class="ttdef"><b>Definition:</b> statemachine01.h:45</div></div>
<div class="ttc" id="aclass_state_machine01_html_a9b3e24a26eba26f2c2c3ad4792802ee4a96ec8d47fea8cfbd18748f807ae0cffc"><div class="ttname"><a href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4a96ec8d47fea8cfbd18748f807ae0cffc">StateMachine01::STATE_SAY_HELLO</a></div><div class="ttdeci">@ STATE_SAY_HELLO</div><div class="ttdoc">Say hello state.</div><div class="ttdef"><b>Definition:</b> statemachine01.h:47</div></div>
<div class="ttc" id="aclass_state_machine01_html_a9b3e24a26eba26f2c2c3ad4792802ee4aa53cb443dce0428eabfcdea1d0ba5e15"><div class="ttname"><a href="class_state_machine01.html#a9b3e24a26eba26f2c2c3ad4792802ee4aa53cb443dce0428eabfcdea1d0ba5e15">StateMachine01::STATE_INITIAL</a></div><div class="ttdeci">@ STATE_INITIAL</div><div class="ttdoc">Initial state.</div><div class="ttdef"><b>Definition:</b> statemachine01.h:46</div></div>
<div class="ttc" id="aclass_state_machine01_html_aacadf4b142dbf0b9e82cc3bd822386b1"><div class="ttname"><a href="class_state_machine01.html#aacadf4b142dbf0b9e82cc3bd822386b1">StateMachine01::getText</a></div><div class="ttdeci">string getText() const</div><div class="ttdoc">Returns text. Accessor for #_text.</div><div class="ttdef"><b>Definition:</b> statemachine01.h:28</div></div>
<div class="ttc" id="aclass_state_machine01_html_ac6209733c246d4614371735cedb49743"><div class="ttname"><a href="class_state_machine01.html#ac6209733c246d4614371735cedb49743">StateMachine01::currentState_</a></div><div class="ttdeci">eMainState currentState_</div><div class="ttdoc">Attribute indicating currently active state.</div><div class="ttdef"><b>Definition:</b> statemachine01.h:50</div></div>
<div class="ttc" id="aclass_state_machine01_html_ad6072335a0c69055427d00694cd61d8d"><div class="ttname"><a href="class_state_machine01.html#ad6072335a0c69055427d00694cd61d8d">StateMachine01::processEvent</a></div><div class="ttdeci">XFEventStatus processEvent() override</div><div class="ttdoc">Remplementation from XFBehavior.</div><div class="ttdef"><b>Definition:</b> statemachine01.cpp:23</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>
Reference in New Issue Copy Permalink