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

10
src/simplified/xf/config/xf-config.h Normal file
View File

@ -0,0 +1,10 @@
#ifndef XF_CONFIG_DEFAULT_H
#define XF_CONFIG_DEFAULT_H
#warning "You should provide your own 'xf-config.h' file in your project!"
// If you need some inspiration on what to provide in the 'xf-config.h' file
// please have a look onto the 'xf-config.h' files provided in the
// XF test-bench tests.
#endif // XF_CONFIG_DEFAULT_H

6
src/simplified/xf/core/behavior.cpp Normal file
View File

@ -0,0 +1,6 @@
#include <cassert>
#include "xf/timeout.h"
#include "xf/initialevent.h"
#include "xf/behavior.h"
// TODO: Implement code for XFBehavior class

3
src/simplified/xf/core/customevent.cpp Normal file
View File

@ -0,0 +1,3 @@
#include "xf/customevent.h"
// TODO: Implement code for XFCustomEvent class

3
src/simplified/xf/core/defaulttransition.cpp Normal file
View File

@ -0,0 +1,3 @@
#include "xf/defaulttransition.h"
// TODO: Implement code for XFDefaultTransition class

3
src/simplified/xf/core/initialevent.cpp Normal file
View File

@ -0,0 +1,3 @@
#include "xf/initialevent.h"
// TODO: Implement code for XFInitialEvent class

3
src/simplified/xf/core/timeout.cpp Normal file
View File

@ -0,0 +1,3 @@
#include "xf/timeout.h"
// TODO: Implement code for XFTimeout class

2678
src/simplified/xf/doxygen/Doxyfile Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
src/simplified/xf/doxygen/images/cmd-simple-xf.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 111 KiB

BIN
src/simplified/xf/doxygen/images/comp-simple-xf.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 44 KiB

97
src/simplified/xf/doxygen/output/html/annotated.html Normal file
View File

@ -0,0 +1,97 @@
<!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>Simplified XF: Class List</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">Simplified XF<span id="projectnumber">&#160;1.1.0</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>
</div><!-- top -->
<!-- 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 class="header">
<div class="headertitle"><div class="title">Class List</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>interface</b></td><td class="desc"></td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classinterface_1_1_x_f_behavior.html" target="_self">XFBehavior</a></td><td class="desc">Interface to receive and process events </td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classinterface_1_1_x_f_dispatcher.html" target="_self">XFDispatcher</a></td><td class="desc">Interface for the <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a> dispatcher providing the event processing loop </td></tr>
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classinterface_1_1_x_f_event_queue.html" target="_self">XFEventQueue</a></td><td class="desc">Interface to be implemented by the event queue </td></tr>
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classinterface_1_1_x_f_mutex.html" target="_self">XFMutex</a></td><td class="desc">Mutex interface needed by the <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a> to access a mutex </td></tr>
<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classinterface_1_1_x_f_timeout_manager.html" target="_self">XFTimeoutManager</a></td><td class="desc">Interface for TimerManager classes (and some few 'tick' stuff already provided) </td></tr>
<tr id="row_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_dispatcher_thread.html" target="_self">DispatcherThread</a></td><td class="desc">The <a class="el" href="class_dispatcher_thread.html" title="The DispatcherThread calls the XFDispatcher execute() method in a separate thread.">DispatcherThread</a> calls the <a class="el" href="class_x_f_dispatcher.html" title="Dispatcher used in an IDF (no underlying OS).">XFDispatcher</a> execute() method in a separate thread </td></tr>
<tr id="row_2_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_x_f.html" target="_self">XF</a></td><td class="desc">Static class grouping the basic methods for the <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a> together </td></tr>
<tr id="row_3_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_x_f_behavior.html" target="_self">XFBehavior</a></td><td class="desc">Base class for state machines, activities, process and data flows </td></tr>
<tr id="row_4_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_x_f_custom_event.html" target="_self">XFCustomEvent</a></td><td class="desc">Base class for project related events </td></tr>
<tr id="row_5_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_x_f_default_transition.html" target="_self">XFDefaultTransition</a></td><td class="desc">State machine transition without trigger </td></tr>
<tr id="row_6_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_x_f_dispatcher.html" target="_self">XFDispatcher</a></td><td class="desc">Dispatcher used in an IDF (no underlying OS) </td></tr>
<tr id="row_7_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_x_f_event.html" target="_self">XFEvent</a></td><td class="desc">Base class for all types of events and timeouts </td></tr>
<tr id="row_8_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_x_f_event_queue.html" target="_self">XFEventQueue</a></td><td class="desc">Default Qt implementation for the <a class="el" href="class_x_f_event_queue.html" title="Default Qt implementation for the XFEventQueue interface.">XFEventQueue</a> interface </td></tr>
<tr id="row_9_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_x_f_event_status.html" target="_self">XFEventStatus</a></td><td class="desc">Event status returned after event processing </td></tr>
<tr id="row_10_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_x_f_initial_event.html" target="_self">XFInitialEvent</a></td><td class="desc">Initial event to start a behavior </td></tr>
<tr id="row_11_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_x_f_mutex.html" target="_self">XFMutex</a></td><td class="desc">Default Qt implementation for the <a class="el" href="class_x_f_mutex.html" title="Default Qt implementation for the XFMutex interface.">XFMutex</a> interface </td></tr>
<tr id="row_12_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_x_f_timeout.html" target="_self">XFTimeout</a></td><td class="desc">Used by the TimeoutManager to create and handle a timeout </td></tr>
<tr id="row_13_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_x_f_timeout_manager.html" target="_self">XFTimeoutManager</a></td><td class="desc">Default implementation of the <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a> TimeoutManager </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

BIN
src/simplified/xf/doxygen/output/html/bc_s.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 676 B

BIN
src/simplified/xf/doxygen/output/html/bdwn.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 147 B

150
src/simplified/xf/doxygen/output/html/behavior_8h_source.html Normal file
View File

@ -0,0 +1,150 @@
<!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>Simplified XF: C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/include/xf/behavior.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">Simplified XF<span id="projectnumber">&#160;1.1.0</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_6529456bf0e894bbd172ced5a1b441f6.html">xf</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">behavior.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 XF_BEHAVIOR_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XF_BEHAVIOR_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/interface/behavior.h&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &quot;xf/interface/dispatcher.h&quot;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &quot;xf/eventstatus.h&quot;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &quot;xf/initialevent.h&quot;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;xf/defaulttransition.h&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;xf/timeout.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">class </span><a class="code hl_class" href="class_x_f_timeout.html">XFTimeout</a>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="class_x_f_behavior.html"> 28</a></span><span class="keyword">class </span><a class="code hl_class" href="class_x_f_behavior.html">XFBehavior</a> : <span class="keyword">public</span> <a class="code hl_class" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</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">public</span>:</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor"> #define GEN(event) pushEvent(new event)</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="class_x_f_behavior.html#a2059b0b99e19ed5d126c9c724b219f5c"> 36</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="class_x_f_behavior.html#a2059b0b99e19ed5d126c9c724b219f5c">XFBehavior</a>();</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_class" href="class_x_f_behavior.html">~XFBehavior</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="class_x_f_behavior.html#a84756f7e6fb88fc3efc4bc42b5bd2be9"> 39</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_x_f_behavior.html#a84756f7e6fb88fc3efc4bc42b5bd2be9">startBehavior</a>() <span class="keyword">override</span>; </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="class_x_f_behavior.html#a633d81f9f64c4c84063837c261bdb86b"> 41</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_x_f_behavior.html#a633d81f9f64c4c84063837c261bdb86b">pushEvent</a>(<a class="code hl_class" href="class_x_f_event.html">XFEvent</a> * pEvent) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="class_x_f_behavior.html#a23d578f29658077ea678880e67b060d5"> 43</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_x_f_behavior.html#a23d578f29658077ea678880e67b060d5">deleteOnTerminate</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="class_x_f_behavior.html#ad2dd82e9165b08e36d7f967bf103bd11"> 44</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_x_f_behavior.html#ad2dd82e9165b08e36d7f967bf103bd11">setDeleteOnTerminate</a>(<span class="keywordtype">bool</span> deleteBehaviour) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="class_x_f_behavior.html#a0d52aeb051101b13f9258a63ed9b3033"> 52</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="class_x_f_event_status.html">XFEventStatus</a> <a class="code hl_function" href="class_x_f_behavior.html#a0d52aeb051101b13f9258a63ed9b3033">processEvent</a>() = 0;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="class_x_f_behavior.html#adc0a3481f70171f7f381d32c71bf179e"> 54</a></span> <span class="keyword">const</span> <a class="code hl_class" href="class_x_f_event.html">XFEvent</a> * <a class="code hl_function" href="class_x_f_behavior.html#adc0a3481f70171f7f381d32c71bf179e">getCurrentEvent</a>() <span class="keyword">const</span>; </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="class_x_f_behavior.html#a95636eba268164cbb41aa35ea48ed6c1"> 55</a></span> <a class="code hl_class" href="classinterface_1_1_x_f_dispatcher.html">interface::XFDispatcher</a> * <a class="code hl_function" href="class_x_f_behavior.html#a95636eba268164cbb41aa35ea48ed6c1">getDispatcher</a>(); </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="class_x_f_behavior.html#ab8c6694bceb44365f956de5703c210f8"> 62</a></span> <span class="keyword">const</span> <a class="code hl_class" href="class_x_f_timeout.html">XFTimeout</a> * <a class="code hl_function" href="class_x_f_behavior.html#ab8c6694bceb44365f956de5703c210f8">getCurrentTimeout</a>();</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="class_x_f_behavior.html#a7e70a67ea74a99c37061fbdf762f7a55"> 64</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_x_f_behavior.html#a7e70a67ea74a99c37061fbdf762f7a55">scheduleTimeout</a>(<span class="keywordtype">int</span> timeoutId, <span class="keywordtype">int</span> interval) { <a class="code hl_function" href="class_x_f_behavior.html#a95636eba268164cbb41aa35ea48ed6c1">getDispatcher</a>()-&gt;<a class="code hl_function" href="classinterface_1_1_x_f_dispatcher.html#afee36b51ca86b0357c0135ae89eade64">scheduleTimeout</a>(timeoutId, interval, <span class="keyword">this</span>); } </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="class_x_f_behavior.html#a753ca0d5667dca95d016c019d64e866d"> 65</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_x_f_behavior.html#a753ca0d5667dca95d016c019d64e866d">unscheduleTimeout</a>(<span class="keywordtype">int</span> timeoutId) { <a class="code hl_function" href="class_x_f_behavior.html#a95636eba268164cbb41aa35ea48ed6c1">getDispatcher</a>()-&gt;<a class="code hl_function" href="classinterface_1_1_x_f_dispatcher.html#a110619a2f91757b083420875a5ed2c51">unscheduleTimeout</a>(timeoutId, <span class="keyword">this</span>); } </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keywordtype">void</span> setCurrentEvent(<span class="keyword">const</span> <a class="code hl_class" href="class_x_f_event.html">XFEvent</a> * pEvent); </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <a class="code hl_typedef" href="classinterface_1_1_x_f_behavior.html#af194a7243dfd05f3e83508fb59fdba61">TerminateBehavior</a> process(<span class="keyword">const</span> <a class="code hl_class" href="class_x_f_event.html">XFEvent</a> * pEvent) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="class_x_f_behavior.html#ab756fe572704a385e9954c507c15924c"> 86</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="class_x_f_behavior.html#ab756fe572704a385e9954c507c15924c">deleteOnTerminate_</a>; </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="class_x_f_behavior.html#a2ddb90a65aa807034103af1e50846142"> 87</a></span> <span class="keyword">const</span> <a class="code hl_class" href="class_x_f_event.html">XFEvent</a> * <a class="code hl_variable" href="class_x_f_behavior.html#a2ddb90a65aa807034103af1e50846142">pCurrentEvent_</a>; </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>};</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// end of xf_core group</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="preprocessor">#endif </span><span class="comment">// XF_BEHAVIOR_H</span></div>
<div class="ttc" id="aclass_x_f_behavior_html"><div class="ttname"><a href="class_x_f_behavior.html">XFBehavior</a></div><div class="ttdoc">Base class for state machines, activities, process and data flows.</div><div class="ttdef"><b>Definition:</b> behavior.h:29</div></div>
<div class="ttc" id="aclass_x_f_behavior_html_a0d52aeb051101b13f9258a63ed9b3033"><div class="ttname"><a href="class_x_f_behavior.html#a0d52aeb051101b13f9258a63ed9b3033">XFBehavior::processEvent</a></div><div class="ttdeci">virtual XFEventStatus processEvent()=0</div></div>
<div class="ttc" id="aclass_x_f_behavior_html_a2059b0b99e19ed5d126c9c724b219f5c"><div class="ttname"><a href="class_x_f_behavior.html#a2059b0b99e19ed5d126c9c724b219f5c">XFBehavior::XFBehavior</a></div><div class="ttdeci">XFBehavior()</div><div class="ttdoc">Default constructor for the behavior.</div></div>
<div class="ttc" id="aclass_x_f_behavior_html_a23d578f29658077ea678880e67b060d5"><div class="ttname"><a href="class_x_f_behavior.html#a23d578f29658077ea678880e67b060d5">XFBehavior::deleteOnTerminate</a></div><div class="ttdeci">bool deleteOnTerminate() const override</div><div class="ttdoc">Tells XF to delete behavior when receiving terminate event.</div></div>
<div class="ttc" id="aclass_x_f_behavior_html_a2ddb90a65aa807034103af1e50846142"><div class="ttname"><a href="class_x_f_behavior.html#a2ddb90a65aa807034103af1e50846142">XFBehavior::pCurrentEvent_</a></div><div class="ttdeci">const XFEvent * pCurrentEvent_</div><div class="ttdoc">Reference to actually processed event.</div><div class="ttdef"><b>Definition:</b> behavior.h:87</div></div>
<div class="ttc" id="aclass_x_f_behavior_html_a633d81f9f64c4c84063837c261bdb86b"><div class="ttname"><a href="class_x_f_behavior.html#a633d81f9f64c4c84063837c261bdb86b">XFBehavior::pushEvent</a></div><div class="ttdeci">void pushEvent(XFEvent *pEvent) override</div><div class="ttdoc">Injects an event into the class.</div></div>
<div class="ttc" id="aclass_x_f_behavior_html_a753ca0d5667dca95d016c019d64e866d"><div class="ttname"><a href="class_x_f_behavior.html#a753ca0d5667dca95d016c019d64e866d">XFBehavior::unscheduleTimeout</a></div><div class="ttdeci">void unscheduleTimeout(int timeoutId)</div><div class="ttdoc">Unschedules a timeout for this state machine.</div><div class="ttdef"><b>Definition:</b> behavior.h:65</div></div>
<div class="ttc" id="aclass_x_f_behavior_html_a7e70a67ea74a99c37061fbdf762f7a55"><div class="ttname"><a href="class_x_f_behavior.html#a7e70a67ea74a99c37061fbdf762f7a55">XFBehavior::scheduleTimeout</a></div><div class="ttdeci">void scheduleTimeout(int timeoutId, int interval)</div><div class="ttdoc">Schedules a timeout for this state machine.</div><div class="ttdef"><b>Definition:</b> behavior.h:64</div></div>
<div class="ttc" id="aclass_x_f_behavior_html_a84756f7e6fb88fc3efc4bc42b5bd2be9"><div class="ttname"><a href="class_x_f_behavior.html#a84756f7e6fb88fc3efc4bc42b5bd2be9">XFBehavior::startBehavior</a></div><div class="ttdeci">void startBehavior() override</div><div class="ttdoc">Starts the behavior, resp. the state machine.</div></div>
<div class="ttc" id="aclass_x_f_behavior_html_a95636eba268164cbb41aa35ea48ed6c1"><div class="ttname"><a href="class_x_f_behavior.html#a95636eba268164cbb41aa35ea48ed6c1">XFBehavior::getDispatcher</a></div><div class="ttdeci">interface::XFDispatcher * getDispatcher()</div><div class="ttdoc">Returns reference to actual dispatcher.</div></div>
<div class="ttc" id="aclass_x_f_behavior_html_ab756fe572704a385e9954c507c15924c"><div class="ttname"><a href="class_x_f_behavior.html#ab756fe572704a385e9954c507c15924c">XFBehavior::deleteOnTerminate_</a></div><div class="ttdeci">bool deleteOnTerminate_</div><div class="ttdoc">Indicates if the behavior can be deleted after reception of a 'terminate event'.</div><div class="ttdef"><b>Definition:</b> behavior.h:86</div></div>
<div class="ttc" id="aclass_x_f_behavior_html_ab8c6694bceb44365f956de5703c210f8"><div class="ttname"><a href="class_x_f_behavior.html#ab8c6694bceb44365f956de5703c210f8">XFBehavior::getCurrentTimeout</a></div><div class="ttdeci">const XFTimeout * getCurrentTimeout()</div><div class="ttdoc">Returns a reference to the actually processed timeout.</div></div>
<div class="ttc" id="aclass_x_f_behavior_html_ad2dd82e9165b08e36d7f967bf103bd11"><div class="ttname"><a href="class_x_f_behavior.html#ad2dd82e9165b08e36d7f967bf103bd11">XFBehavior::setDeleteOnTerminate</a></div><div class="ttdeci">void setDeleteOnTerminate(bool deleteBehaviour) override</div><div class="ttdoc">Sets/Clears the 'delete on terminate' property.</div></div>
<div class="ttc" id="aclass_x_f_behavior_html_adc0a3481f70171f7f381d32c71bf179e"><div class="ttname"><a href="class_x_f_behavior.html#adc0a3481f70171f7f381d32c71bf179e">XFBehavior::getCurrentEvent</a></div><div class="ttdeci">const XFEvent * getCurrentEvent() const</div><div class="ttdoc">Returns the current event to be processed in processEvent().</div></div>
<div class="ttc" id="aclass_x_f_event_html"><div class="ttname"><a href="class_x_f_event.html">XFEvent</a></div><div class="ttdoc">Base class for all types of events and timeouts.</div><div class="ttdef"><b>Definition:</b> event.h:23</div></div>
<div class="ttc" id="aclass_x_f_event_status_html"><div class="ttname"><a href="class_x_f_event_status.html">XFEventStatus</a></div><div class="ttdoc">Event status returned after event processing.</div><div class="ttdef"><b>Definition:</b> eventstatus.h:16</div></div>
<div class="ttc" id="aclass_x_f_timeout_html"><div class="ttname"><a href="class_x_f_timeout.html">XFTimeout</a></div><div class="ttdoc">Used by the TimeoutManager to create and handle a timeout.</div><div class="ttdef"><b>Definition:</b> timeout.h:28</div></div>
<div class="ttc" id="aclassinterface_1_1_x_f_behavior_html"><div class="ttname"><a href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a></div><div class="ttdoc">Interface to receive and process events.</div><div class="ttdef"><b>Definition:</b> behavior.h:24</div></div>
<div class="ttc" id="aclassinterface_1_1_x_f_behavior_html_af194a7243dfd05f3e83508fb59fdba61"><div class="ttname"><a href="classinterface_1_1_x_f_behavior.html#af194a7243dfd05f3e83508fb59fdba61">interface::XFBehavior::TerminateBehavior</a></div><div class="ttdeci">bool TerminateBehavior</div><div class="ttdoc">Type returned by the process() method.</div><div class="ttdef"><b>Definition:</b> behavior.h:30</div></div>
<div class="ttc" id="aclassinterface_1_1_x_f_dispatcher_html"><div class="ttname"><a href="classinterface_1_1_x_f_dispatcher.html">interface::XFDispatcher</a></div><div class="ttdoc">Interface for the XF dispatcher providing the event processing loop.</div><div class="ttdef"><b>Definition:</b> dispatcher.h:29</div></div>
<div class="ttc" id="aclassinterface_1_1_x_f_dispatcher_html_a110619a2f91757b083420875a5ed2c51"><div class="ttname"><a href="classinterface_1_1_x_f_dispatcher.html#a110619a2f91757b083420875a5ed2c51">interface::XFDispatcher::unscheduleTimeout</a></div><div class="ttdeci">virtual void unscheduleTimeout(int timeoutId, interface::XFBehavior *pBehavior)=0</div><div class="ttdoc">Removes all timeouts corresponding the given parameters.</div></div>
<div class="ttc" id="aclassinterface_1_1_x_f_dispatcher_html_afee36b51ca86b0357c0135ae89eade64"><div class="ttname"><a href="classinterface_1_1_x_f_dispatcher.html#afee36b51ca86b0357c0135ae89eade64">interface::XFDispatcher::scheduleTimeout</a></div><div class="ttdeci">virtual void scheduleTimeout(int timeoutId, int interval, interface::XFBehavior *pBehavior)=0</div><div class="ttdoc">Adds a new timeout to be handled.</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

101
src/simplified/xf/doxygen/output/html/c-wrapper-functions_8h_source.html Normal file
View File

@ -0,0 +1,101 @@
<!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>Simplified XF: C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/port/idf-stm32/c-wrapper-functions.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">Simplified XF<span id="projectnumber">&#160;1.1.0</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_651562d8bf6cfd3e81eff5b570d7df50.html">port</a></li><li class="navelem"><a class="el" href="dir_5a361383a26c97640254246527d75310.html">idf-stm32</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">c-wrapper-functions.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 XF_C_WRAPPER_FUNCTIONS_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XF_C_WRAPPER_FUNCTIONS_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;stdint.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;stdbool.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__port__idf__stm32.html#ga362aeb583f552072275021bb97ea58f0">XF_tick</a>();</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>int32_t <a class="code hl_function" href="group__port__idf__stm32.html#ga94704625bc8c4d29827eab535d4f01fe">XF_tickIntervalInMilliseconds</a>();</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__port__idf__stm32.html#ga997e96d1bb5bbdcc95b1dbab4d4ca303">XF_isRunning</a>();</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>}</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="preprocessor">#endif</span> <span class="comment">// end of port_idf_stm32 group</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="preprocessor">#endif </span><span class="comment">// XF_C_WRAPPER_FUNCTIONS_H</span></div>
<div class="ttc" id="agroup__port__idf__stm32_html_ga362aeb583f552072275021bb97ea58f0"><div class="ttname"><a href="group__port__idf__stm32.html#ga362aeb583f552072275021bb97ea58f0">XF_tick</a></div><div class="ttdeci">void XF_tick()</div><div class="ttdoc">Must be called regularly in a timer ISR or software timer callback.</div><div class="ttdef"><b>Definition:</b> c-wrapper-functions.cpp:17</div></div>
<div class="ttc" id="agroup__port__idf__stm32_html_ga94704625bc8c4d29827eab535d4f01fe"><div class="ttname"><a href="group__port__idf__stm32.html#ga94704625bc8c4d29827eab535d4f01fe">XF_tickIntervalInMilliseconds</a></div><div class="ttdeci">int32_t XF_tickIntervalInMilliseconds()</div><div class="ttdef"><b>Definition:</b> c-wrapper-functions.cpp:30</div></div>
<div class="ttc" id="agroup__port__idf__stm32_html_ga997e96d1bb5bbdcc95b1dbab4d4ca303"><div class="ttname"><a href="group__port__idf__stm32.html#ga997e96d1bb5bbdcc95b1dbab4d4ca303">XF_isRunning</a></div><div class="ttdeci">bool XF_isRunning()</div><div class="ttdef"><b>Definition:</b> c-wrapper-functions.cpp:35</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

80
src/simplified/xf/doxygen/output/html/class_dispatcher_thread-members.html Normal file
View File

@ -0,0 +1,80 @@
<!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>Simplified XF: Member List</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">Simplified XF<span id="projectnumber">&#160;1.1.0</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="headertitle"><div class="title">DispatcherThread Member List</div></div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_dispatcher_thread.html">DispatcherThread</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_dispatcher_thread.html#af3d129e9f4adb01cf670eab4ba89a4ea">dispatcher_</a></td><td class="entry"><a class="el" href="class_dispatcher_thread.html">DispatcherThread</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_dispatcher_thread.html#a37fbae7ad43dd68489e489c6fc3a8ccc">DispatcherThread</a>(interface::XFDispatcher *dispatcher)</td><td class="entry"><a class="el" href="class_dispatcher_thread.html">DispatcherThread</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_dispatcher_thread.html#afe411ece9898e72f79d580ae064c0cf2">run</a>() override</td><td class="entry"><a class="el" href="class_dispatcher_thread.html">DispatcherThread</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

190
src/simplified/xf/doxygen/output/html/class_dispatcher_thread.html Normal file
View File

@ -0,0 +1,190 @@
<!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>Simplified XF: DispatcherThread 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">Simplified XF<span id="projectnumber">&#160;1.1.0</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-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_dispatcher_thread-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">DispatcherThread Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="class_dispatcher_thread.html" title="The DispatcherThread calls the XFDispatcher execute() method in a separate thread.">DispatcherThread</a> calls the <a class="el" href="class_x_f_dispatcher.html" title="Dispatcher used in an IDF (no underlying OS).">XFDispatcher</a> execute() method in a separate thread.
<a href="class_dispatcher_thread.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for DispatcherThread:</div>
<div class="dyncontent">
<div class="center"><img src="class_dispatcher_thread__inherit__graph.png" border="0" usemap="#a_dispatcher_thread_inherit__map" alt="Inheritance graph"/></div>
<map name="a_dispatcher_thread_inherit__map" id="a_dispatcher_thread_inherit__map">
<area shape="rect" title="The DispatcherThread calls the XFDispatcher execute() method in a separate thread." alt="" coords="5,131,151,223"/>
<area shape="rect" title=" " alt="" coords="42,5,114,83"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for DispatcherThread:</div>
<div class="dyncontent">
<div class="center"><img src="class_dispatcher_thread__coll__graph.png" border="0" usemap="#a_dispatcher_thread_coll__map" alt="Collaboration graph"/></div>
<map name="a_dispatcher_thread_coll__map" id="a_dispatcher_thread_coll__map">
<area shape="rect" title="The DispatcherThread calls the XFDispatcher execute() method in a separate thread." alt="" coords="38,263,183,355"/>
<area shape="rect" title=" " alt="" coords="5,64,77,141"/>
<area shape="rect" href="classinterface_1_1_x_f_dispatcher.html" title="Interface for the XF dispatcher providing the event processing loop." alt="" coords="101,5,259,200"/>
</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:a37fbae7ad43dd68489e489c6fc3a8ccc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_dispatcher_thread.html#a37fbae7ad43dd68489e489c6fc3a8ccc">DispatcherThread</a> (<a class="el" href="classinterface_1_1_x_f_dispatcher.html">interface::XFDispatcher</a> *dispatcher)</td></tr>
<tr class="memdesc:a37fbae7ad43dd68489e489c6fc3a8ccc"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_dispatcher_thread.html" title="The DispatcherThread calls the XFDispatcher execute() method in a separate thread.">DispatcherThread</a> constructor. <a href="class_dispatcher_thread.html#a37fbae7ad43dd68489e489c6fc3a8ccc">More...</a><br /></td></tr>
<tr class="separator:a37fbae7ad43dd68489e489c6fc3a8ccc"><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:afe411ece9898e72f79d580ae064c0cf2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_dispatcher_thread.html#afe411ece9898e72f79d580ae064c0cf2">run</a> () override</td></tr>
<tr class="memdesc:afe411ece9898e72f79d580ae064c0cf2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Method executed by the new thread. <a href="class_dispatcher_thread.html#afe411ece9898e72f79d580ae064c0cf2">More...</a><br /></td></tr>
<tr class="separator:afe411ece9898e72f79d580ae064c0cf2"><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:af3d129e9f4adb01cf670eab4ba89a4ea"><td class="memItemLeft" align="right" valign="top"><a id="af3d129e9f4adb01cf670eab4ba89a4ea" name="af3d129e9f4adb01cf670eab4ba89a4ea"></a>
<a class="el" href="classinterface_1_1_x_f_dispatcher.html">interface::XFDispatcher</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>dispatcher_</b></td></tr>
<tr class="memdesc:af3d129e9f4adb01cf670eab4ba89a4ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to dispatcher used by the <a class="el" href="class_dispatcher_thread.html" title="The DispatcherThread calls the XFDispatcher execute() method in a separate thread.">DispatcherThread</a>. <br /></td></tr>
<tr class="separator:af3d129e9f4adb01cf670eab4ba89a4ea"><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 >The <a class="el" href="class_dispatcher_thread.html" title="The DispatcherThread calls the XFDispatcher execute() method in a separate thread.">DispatcherThread</a> calls the <a class="el" href="class_x_f_dispatcher.html" title="Dispatcher used in an IDF (no underlying OS).">XFDispatcher</a> execute() method in a separate thread. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a37fbae7ad43dd68489e489c6fc3a8ccc" name="a37fbae7ad43dd68489e489c6fc3a8ccc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37fbae7ad43dd68489e489c6fc3a8ccc">&#9670;&nbsp;</a></span>DispatcherThread()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DispatcherThread::DispatcherThread </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classinterface_1_1_x_f_dispatcher.html">interface::XFDispatcher</a> *&#160;</td>
<td class="paramname"><em>dispatcher</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="class_dispatcher_thread.html" title="The DispatcherThread calls the XFDispatcher execute() method in a separate thread.">DispatcherThread</a> constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dispatcher</td><td>Dispatcher to be executed by the thread. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afe411ece9898e72f79d580ae064c0cf2" name="afe411ece9898e72f79d580ae064c0cf2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe411ece9898e72f79d580ae064c0cf2">&#9670;&nbsp;</a></span>run()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void DispatcherThread::run </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Method executed by the new thread. </p>
<p >For more information read the documentation of QThread. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/port/idf-qt/xf.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

5
src/simplified/xf/doxygen/output/html/class_dispatcher_thread__coll__graph.map Normal file
View File

@ -0,0 +1,5 @@
<map id="DispatcherThread" name="DispatcherThread">
<area shape="rect" id="node1" title="The DispatcherThread calls the XFDispatcher execute() method in a separate thread." alt="" coords="38,263,183,355"/>
<area shape="rect" id="node2" title=" " alt="" coords="5,64,77,141"/>
<area shape="rect" id="node3" href="$classinterface_1_1_x_f_dispatcher.html" title="Interface for the XF dispatcher providing the event processing loop." alt="" coords="101,5,259,200"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_dispatcher_thread__coll__graph.md5 Normal file
View File

@ -0,0 +1 @@
f2326b35772b233522dd76b7db263aa9

BIN
src/simplified/xf/doxygen/output/html/class_dispatcher_thread__coll__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.6 KiB

4
src/simplified/xf/doxygen/output/html/class_dispatcher_thread__inherit__graph.map Normal file
View File

@ -0,0 +1,4 @@
<map id="DispatcherThread" name="DispatcherThread">
<area shape="rect" id="node1" title="The DispatcherThread calls the XFDispatcher execute() method in a separate thread." alt="" coords="5,131,151,223"/>
<area shape="rect" id="node2" title=" " alt="" coords="42,5,114,83"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_dispatcher_thread__inherit__graph.md5 Normal file
View File

@ -0,0 +1 @@
14367da696726be43e8426ef57c8e41b

BIN
src/simplified/xf/doxygen/output/html/class_dispatcher_thread__inherit__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.2 KiB

83
src/simplified/xf/doxygen/output/html/class_x_f-members.html Normal file
View File

@ -0,0 +1,83 @@
<!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>Simplified XF: Member List</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">Simplified XF<span id="projectnumber">&#160;1.1.0</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="headertitle"><div class="title">XF Member List</div></div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_x_f.html">XF</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_x_f.html#af120f0ad4ea4d6d2ba0621aa01265e89">exec</a>()</td><td class="entry"><a class="el" href="class_x_f.html">XF</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f.html#a5718ac28d228ad3030da4b27fb55e666">execOnce</a>()</td><td class="entry"><a class="el" href="class_x_f.html">XF</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f.html#a7a831a128ccc1f024f5195338964ead5">initialize</a>(int timeInterval=10, int argc=0, char *argv[]=nullptr)</td><td class="entry"><a class="el" href="class_x_f.html">XF</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f.html#a23a9fa2916f1ea8a0bf5e9a79258652e">isInitialized_</a></td><td class="entry"><a class="el" href="class_x_f.html">XF</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f.html#a54056434143ad95d843d52b5bc1923bf">isRunning</a>()</td><td class="entry"><a class="el" href="class_x_f.html">XF</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f.html#ae8f39c1346c3207bbecca8234281ea9f">isRunning_</a></td><td class="entry"><a class="el" href="class_x_f.html">XF</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">static</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

255
src/simplified/xf/doxygen/output/html/class_x_f.html Normal file
View File

@ -0,0 +1,255 @@
<!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>Simplified XF: XF 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">Simplified XF<span id="projectnumber">&#160;1.1.0</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-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-static-attribs">Static Protected Attributes</a> &#124;
<a href="class_x_f-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">XF Class Reference<div class="ingroups"><a class="el" href="group__xf__core.html">XF Core Classes</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Static class grouping the basic methods for the <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a> together.
<a href="class_x_f.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="xf_8h_source.html">xf.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for XF:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f__coll__graph.png" border="0" usemap="#a_x_f_coll__map" alt="Collaboration graph"/></div>
<map name="a_x_f_coll__map" id="a_x_f_coll__map">
<area shape="rect" title="Static class grouping the basic methods for the XF together." alt="" coords="5,5,111,141"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a7a831a128ccc1f024f5195338964ead5"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f.html#a7a831a128ccc1f024f5195338964ead5">initialize</a> (int timeInterval=10, int argc=0, char *argv[]=nullptr)</td></tr>
<tr class="separator:a7a831a128ccc1f024f5195338964ead5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af120f0ad4ea4d6d2ba0621aa01265e89"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f.html#af120f0ad4ea4d6d2ba0621aa01265e89">exec</a> ()</td></tr>
<tr class="separator:af120f0ad4ea4d6d2ba0621aa01265e89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5718ac28d228ad3030da4b27fb55e666"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f.html#a5718ac28d228ad3030da4b27fb55e666">execOnce</a> ()</td></tr>
<tr class="separator:a5718ac28d228ad3030da4b27fb55e666"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54056434143ad95d843d52b5bc1923bf"><td class="memItemLeft" align="right" valign="top"><a id="a54056434143ad95d843d52b5bc1923bf" name="a54056434143ad95d843d52b5bc1923bf"></a>
static bool&#160;</td><td class="memItemRight" valign="bottom"><b>isRunning</b> ()</td></tr>
<tr class="memdesc:a54056434143ad95d843d52b5bc1923bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true in case the <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a> is initialized and running. <br /></td></tr>
<tr class="separator:a54056434143ad95d843d52b5bc1923bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-static-attribs" name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:a23a9fa2916f1ea8a0bf5e9a79258652e"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f.html#a23a9fa2916f1ea8a0bf5e9a79258652e">isInitialized_</a> = false</td></tr>
<tr class="memdesc:a23a9fa2916f1ea8a0bf5e9a79258652e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Changes from false to true after calling method initialize(int). Used to handle multiple calls to init(int). <a href="class_x_f.html#a23a9fa2916f1ea8a0bf5e9a79258652e">More...</a><br /></td></tr>
<tr class="separator:a23a9fa2916f1ea8a0bf5e9a79258652e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8f39c1346c3207bbecca8234281ea9f"><td class="memItemLeft" align="right" valign="top"><a id="ae8f39c1346c3207bbecca8234281ea9f" name="ae8f39c1346c3207bbecca8234281ea9f"></a>
static bool&#160;</td><td class="memItemRight" valign="bottom"><b>isRunning_</b> = false</td></tr>
<tr class="memdesc:ae8f39c1346c3207bbecca8234281ea9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tells if the <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a> is initialized and running. <br /></td></tr>
<tr class="separator:ae8f39c1346c3207bbecca8234281ea9f"><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 >Static class grouping the basic methods for the <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a> together. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af120f0ad4ea4d6d2ba0621aa01265e89" name="af120f0ad4ea4d6d2ba0621aa01265e89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af120f0ad4ea4d6d2ba0621aa01265e89">&#9670;&nbsp;</a></span>exec()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int XF::exec </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Starts execution of the framework. This results in processing the events in main loop.</p>
<p >This method is blocking. </p>
</div>
</div>
<a id="a5718ac28d228ad3030da4b27fb55e666" name="a5718ac28d228ad3030da4b27fb55e666"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5718ac28d228ad3030da4b27fb55e666">&#9670;&nbsp;</a></span>execOnce()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int XF::execOnce </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Executes once the dispatcher. To be called regularly in a while loop.</p>
<p >This method is non-blocking. </p>
</div>
</div>
<a id="a7a831a128ccc1f024f5195338964ead5" name="a7a831a128ccc1f024f5195338964ead5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a831a128ccc1f024f5195338964ead5">&#9670;&nbsp;</a></span>initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XF::initialize </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>timeInterval</em> = <code>10</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>argc</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>argv</em>[] = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Initializes the e<b>X</b>ecution <b>F</b>ramework (<a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a>). Call this method prior to initialize the other objects of the system.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timeInterval</td><td>The interval in milliseconds with which the TimeoutManager should run. </td></tr>
<tr><td class="paramname">argc</td><td>Optional parameter to pass application argument number to <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a>. </td></tr>
<tr><td class="paramname">argv</td><td>Optional parameter to pass application arguments to <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a23a9fa2916f1ea8a0bf5e9a79258652e" name="a23a9fa2916f1ea8a0bf5e9a79258652e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23a9fa2916f1ea8a0bf5e9a79258652e">&#9670;&nbsp;</a></span>isInitialized_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XF::isInitialized_ = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes from false to true after calling method initialize(int). Used to handle multiple calls to init(int). </p>
<p >In the Qt port we are going to use a QCoreApplication instance which gets executed by the <a class="el" href="class_x_f.html#af120f0ad4ea4d6d2ba0621aa01265e89">XF::exec()</a> method.</p>
<p >The default dispatcher is active in this port implementation. This means, the default dispatcher has its own thread.</p>
<p >The <a class="el" href="class_x_f.html#a5718ac28d228ad3030da4b27fb55e666">XF::execOnce()</a> method is not applicable for this port. </p>
</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/src/simplified/xf/include/xf/<a class="el" href="xf_8h_source.html">xf.h</a></li>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/port/idf-qt/xf.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

3
src/simplified/xf/doxygen/output/html/class_x_f__coll__graph.map Normal file
View File

@ -0,0 +1,3 @@
<map id="XF" name="XF">
<area shape="rect" id="node1" title="Static class grouping the basic methods for the XF together." alt="" coords="5,5,111,141"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f__coll__graph.md5 Normal file
View File

@ -0,0 +1 @@
6d9c7bc1af3e47b98c6b4ca77c06e4ef

BIN
src/simplified/xf/doxygen/output/html/class_x_f__coll__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.5 KiB

92
src/simplified/xf/doxygen/output/html/class_x_f_behavior-members.html Normal file
View File

@ -0,0 +1,92 @@
<!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>Simplified XF: Member List</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">Simplified XF<span id="projectnumber">&#160;1.1.0</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="headertitle"><div class="title">XFBehavior Member List</div></div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_x_f_behavior.html">XFBehavior</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_x_f_behavior.html#a23d578f29658077ea678880e67b060d5">deleteOnTerminate</a>() const override</td><td class="entry"><a class="el" href="class_x_f_behavior.html">XFBehavior</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_behavior.html#ab756fe572704a385e9954c507c15924c">deleteOnTerminate_</a></td><td class="entry"><a class="el" href="class_x_f_behavior.html">XFBehavior</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_behavior.html#adc0a3481f70171f7f381d32c71bf179e">getCurrentEvent</a>() const</td><td class="entry"><a class="el" href="class_x_f_behavior.html">XFBehavior</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_behavior.html#ab8c6694bceb44365f956de5703c210f8">getCurrentTimeout</a>()</td><td class="entry"><a class="el" href="class_x_f_behavior.html">XFBehavior</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_behavior.html#a95636eba268164cbb41aa35ea48ed6c1">getDispatcher</a>()</td><td class="entry"><a class="el" href="class_x_f_behavior.html">XFBehavior</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_behavior.html#a2ddb90a65aa807034103af1e50846142">pCurrentEvent_</a></td><td class="entry"><a class="el" href="class_x_f_behavior.html">XFBehavior</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_behavior.html#a0d52aeb051101b13f9258a63ed9b3033">processEvent</a>()=0</td><td class="entry"><a class="el" href="class_x_f_behavior.html">XFBehavior</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_behavior.html#a633d81f9f64c4c84063837c261bdb86b">pushEvent</a>(XFEvent *pEvent) override</td><td class="entry"><a class="el" href="class_x_f_behavior.html">XFBehavior</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_behavior.html#a7e70a67ea74a99c37061fbdf762f7a55">scheduleTimeout</a>(int timeoutId, int interval)</td><td class="entry"><a class="el" href="class_x_f_behavior.html">XFBehavior</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_behavior.html#ad2dd82e9165b08e36d7f967bf103bd11">setDeleteOnTerminate</a>(bool deleteBehaviour) override</td><td class="entry"><a class="el" href="class_x_f_behavior.html">XFBehavior</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_behavior.html#a84756f7e6fb88fc3efc4bc42b5bd2be9">startBehavior</a>() override</td><td class="entry"><a class="el" href="class_x_f_behavior.html">XFBehavior</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classinterface_1_1_x_f_behavior.html#af194a7243dfd05f3e83508fb59fdba61">TerminateBehavior</a> typedef</td><td class="entry"><a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_behavior.html#a753ca0d5667dca95d016c019d64e866d">unscheduleTimeout</a>(int timeoutId)</td><td class="entry"><a class="el" href="class_x_f_behavior.html">XFBehavior</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_behavior.html#a2059b0b99e19ed5d126c9c724b219f5c">XFBehavior</a>()</td><td class="entry"><a class="el" href="class_x_f_behavior.html">XFBehavior</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~XFBehavior</b>() override (defined in <a class="el" href="class_x_f_behavior.html">XFBehavior</a>)</td><td class="entry"><a class="el" href="class_x_f_behavior.html">XFBehavior</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

374
src/simplified/xf/doxygen/output/html/class_x_f_behavior.html Normal file
View File

@ -0,0 +1,374 @@
<!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>Simplified XF: XFBehavior 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">Simplified XF<span id="projectnumber">&#160;1.1.0</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-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_x_f_behavior-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">XFBehavior Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__xf__core.html">XF Core Classes</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Base class for state machines, activities, process and data flows.
<a href="class_x_f_behavior.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="behavior_8h_source.html">behavior.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for XFBehavior:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_behavior__inherit__graph.png" border="0" usemap="#a_x_f_behavior_inherit__map" alt="Inheritance graph"/></div>
<map name="a_x_f_behavior_inherit__map" id="a_x_f_behavior_inherit__map">
<area shape="rect" title="Base class for state machines, activities, process and data flows." alt="" coords="5,219,177,472"/>
<area shape="rect" href="classinterface_1_1_x_f_behavior.html" title="Interface to receive and process events." alt="" coords="5,5,177,171"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for XFBehavior:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_behavior__coll__graph.png" border="0" usemap="#a_x_f_behavior_coll__map" alt="Collaboration graph"/></div>
<map name="a_x_f_behavior_coll__map" id="a_x_f_behavior_coll__map">
<area shape="rect" title="Base class for state machines, activities, process and data flows." alt="" coords="5,476,177,715"/>
<area shape="rect" href="classinterface_1_1_x_f_behavior.html" title="Interface to receive and process events." alt="" coords="5,5,177,171"/>
<area shape="rect" href="class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="107,233,267,413"/>
</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:a2059b0b99e19ed5d126c9c724b219f5c"><td class="memItemLeft" align="right" valign="top"><a id="a2059b0b99e19ed5d126c9c724b219f5c" name="a2059b0b99e19ed5d126c9c724b219f5c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>XFBehavior</b> ()</td></tr>
<tr class="memdesc:a2059b0b99e19ed5d126c9c724b219f5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor for the behavior. <br /></td></tr>
<tr class="separator:a2059b0b99e19ed5d126c9c724b219f5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84756f7e6fb88fc3efc4bc42b5bd2be9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_behavior.html#a84756f7e6fb88fc3efc4bc42b5bd2be9">startBehavior</a> () override</td></tr>
<tr class="memdesc:a84756f7e6fb88fc3efc4bc42b5bd2be9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the behavior, resp. the state machine. <a href="class_x_f_behavior.html#a84756f7e6fb88fc3efc4bc42b5bd2be9">More...</a><br /></td></tr>
<tr class="separator:a84756f7e6fb88fc3efc4bc42b5bd2be9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a633d81f9f64c4c84063837c261bdb86b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_behavior.html#a633d81f9f64c4c84063837c261bdb86b">pushEvent</a> (<a class="el" href="class_x_f_event.html">XFEvent</a> *pEvent) override</td></tr>
<tr class="memdesc:a633d81f9f64c4c84063837c261bdb86b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Injects an event into the class. <a href="class_x_f_behavior.html#a633d81f9f64c4c84063837c261bdb86b">More...</a><br /></td></tr>
<tr class="separator:a633d81f9f64c4c84063837c261bdb86b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23d578f29658077ea678880e67b060d5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_behavior.html#a23d578f29658077ea678880e67b060d5">deleteOnTerminate</a> () const override</td></tr>
<tr class="memdesc:a23d578f29658077ea678880e67b060d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tells <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a> to delete behavior when receiving terminate event. <a href="class_x_f_behavior.html#a23d578f29658077ea678880e67b060d5">More...</a><br /></td></tr>
<tr class="separator:a23d578f29658077ea678880e67b060d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2dd82e9165b08e36d7f967bf103bd11"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_behavior.html#ad2dd82e9165b08e36d7f967bf103bd11">setDeleteOnTerminate</a> (bool deleteBehaviour) override</td></tr>
<tr class="memdesc:ad2dd82e9165b08e36d7f967bf103bd11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets/Clears the 'delete on terminate' property. <a href="class_x_f_behavior.html#ad2dd82e9165b08e36d7f967bf103bd11">More...</a><br /></td></tr>
<tr class="separator:ad2dd82e9165b08e36d7f967bf103bd11"><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:a0d52aeb051101b13f9258a63ed9b3033"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_x_f_event_status.html">XFEventStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_behavior.html#a0d52aeb051101b13f9258a63ed9b3033">processEvent</a> ()=0</td></tr>
<tr class="separator:a0d52aeb051101b13f9258a63ed9b3033"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc0a3481f70171f7f381d32c71bf179e"><td class="memItemLeft" align="right" valign="top"><a id="adc0a3481f70171f7f381d32c71bf179e" name="adc0a3481f70171f7f381d32c71bf179e"></a>
const <a class="el" href="class_x_f_event.html">XFEvent</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>getCurrentEvent</b> () const</td></tr>
<tr class="memdesc:adc0a3481f70171f7f381d32c71bf179e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current event to be processed in <a class="el" href="class_x_f_behavior.html#a0d52aeb051101b13f9258a63ed9b3033">processEvent()</a>. <br /></td></tr>
<tr class="separator:adc0a3481f70171f7f381d32c71bf179e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95636eba268164cbb41aa35ea48ed6c1"><td class="memItemLeft" align="right" valign="top"><a id="a95636eba268164cbb41aa35ea48ed6c1" name="a95636eba268164cbb41aa35ea48ed6c1"></a>
<a class="el" href="classinterface_1_1_x_f_dispatcher.html">interface::XFDispatcher</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>getDispatcher</b> ()</td></tr>
<tr class="memdesc:a95636eba268164cbb41aa35ea48ed6c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns reference to actual dispatcher. <br /></td></tr>
<tr class="separator:a95636eba268164cbb41aa35ea48ed6c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8c6694bceb44365f956de5703c210f8"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_x_f_timeout.html">XFTimeout</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_behavior.html#ab8c6694bceb44365f956de5703c210f8">getCurrentTimeout</a> ()</td></tr>
<tr class="memdesc:ab8c6694bceb44365f956de5703c210f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a reference to the actually processed timeout. <a href="class_x_f_behavior.html#ab8c6694bceb44365f956de5703c210f8">More...</a><br /></td></tr>
<tr class="separator:ab8c6694bceb44365f956de5703c210f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e70a67ea74a99c37061fbdf762f7a55"><td class="memItemLeft" align="right" valign="top"><a id="a7e70a67ea74a99c37061fbdf762f7a55" name="a7e70a67ea74a99c37061fbdf762f7a55"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>scheduleTimeout</b> (int timeoutId, int interval)</td></tr>
<tr class="memdesc:a7e70a67ea74a99c37061fbdf762f7a55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Schedules a timeout for this state machine. <br /></td></tr>
<tr class="separator:a7e70a67ea74a99c37061fbdf762f7a55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a753ca0d5667dca95d016c019d64e866d"><td class="memItemLeft" align="right" valign="top"><a id="a753ca0d5667dca95d016c019d64e866d" name="a753ca0d5667dca95d016c019d64e866d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>unscheduleTimeout</b> (int timeoutId)</td></tr>
<tr class="memdesc:a753ca0d5667dca95d016c019d64e866d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unschedules a timeout for this state machine. <br /></td></tr>
<tr class="separator:a753ca0d5667dca95d016c019d64e866d"><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:ab756fe572704a385e9954c507c15924c"><td class="memItemLeft" align="right" valign="top"><a id="ab756fe572704a385e9954c507c15924c" name="ab756fe572704a385e9954c507c15924c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>deleteOnTerminate_</b></td></tr>
<tr class="memdesc:ab756fe572704a385e9954c507c15924c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates if the behavior can be deleted after reception of a 'terminate event'. <br /></td></tr>
<tr class="separator:ab756fe572704a385e9954c507c15924c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ddb90a65aa807034103af1e50846142"><td class="memItemLeft" align="right" valign="top"><a id="a2ddb90a65aa807034103af1e50846142" name="a2ddb90a65aa807034103af1e50846142"></a>
const <a class="el" href="class_x_f_event.html">XFEvent</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>pCurrentEvent_</b></td></tr>
<tr class="memdesc:a2ddb90a65aa807034103af1e50846142"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference to actually processed event. <br /></td></tr>
<tr class="separator:a2ddb90a65aa807034103af1e50846142"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classinterface_1_1_x_f_behavior"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classinterface_1_1_x_f_behavior')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a></td></tr>
<tr class="memitem:af194a7243dfd05f3e83508fb59fdba61 inherit pub_types_classinterface_1_1_x_f_behavior"><td class="memItemLeft" align="right" valign="top"><a id="af194a7243dfd05f3e83508fb59fdba61" name="af194a7243dfd05f3e83508fb59fdba61"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>TerminateBehavior</b> = bool</td></tr>
<tr class="memdesc:af194a7243dfd05f3e83508fb59fdba61 inherit pub_types_classinterface_1_1_x_f_behavior"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type returned by the <a class="el" href="classinterface_1_1_x_f_behavior.html#ad52280557cdac2dc0bd025dafa9fffbb" title="Called by the dispatcher to process an event.">process()</a> method. <br /></td></tr>
<tr class="separator:af194a7243dfd05f3e83508fb59fdba61 inherit pub_types_classinterface_1_1_x_f_behavior"><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 >Base class for state machines, activities, process and data flows. </p>
<p >Reactive class implementing a behavior. This class can be used to implement a state machine behavior or an activity behavior.</p>
<p >Override the <a class="el" href="class_x_f_behavior.html#a0d52aeb051101b13f9258a63ed9b3033">processEvent()</a> operation in the inherited class to implement your state machine behavior. The <a class="el" href="class_x_f_behavior.html#a0d52aeb051101b13f9258a63ed9b3033">processEvent()</a> method gets automatically called every time an event or timeout arrives. The event (or timeout) can be accessed via the <a class="el" href="class_x_f_behavior.html#adc0a3481f70171f7f381d32c71bf179e" title="Returns the current event to be processed in processEvent().">getCurrentEvent()</a> method. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abbab72d0996325e54971d04fb875d633" name="abbab72d0996325e54971d04fb875d633"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbab72d0996325e54971d04fb875d633">&#9670;&nbsp;</a></span>~XFBehavior()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">XFBehavior::~XFBehavior </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a23d578f29658077ea678880e67b060d5" name="a23d578f29658077ea678880e67b060d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23d578f29658077ea678880e67b060d5">&#9670;&nbsp;</a></span>deleteOnTerminate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XFBehavior::deleteOnTerminate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tells <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a> to delete behavior when receiving terminate event. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_behavior.html#a19ebec4052f7e0b8f0ba85b80986bf16">interface::XFBehavior</a>.</p>
</div>
</div>
<a id="ab8c6694bceb44365f956de5703c210f8" name="ab8c6694bceb44365f956de5703c210f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8c6694bceb44365f956de5703c210f8">&#9670;&nbsp;</a></span>getCurrentTimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="class_x_f_timeout.html">XFTimeout</a> * XFBehavior::getCurrentTimeout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>Returns a reference to the actually processed timeout. </p>
<p >Will work only if the current event is of type IXFEvent::Timeout. </p>
</div>
</div>
<a id="a0d52aeb051101b13f9258a63ed9b3033" name="a0d52aeb051101b13f9258a63ed9b3033"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d52aeb051101b13f9258a63ed9b3033">&#9670;&nbsp;</a></span>processEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_x_f_event_status.html">XFEventStatus</a> XFBehavior::processEvent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Executes the current event in its implemented behavior. This method needs to be overridden to implement the behavior (i.e. state machine) needed. </p>
</div>
</div>
<a id="a633d81f9f64c4c84063837c261bdb86b" name="a633d81f9f64c4c84063837c261bdb86b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a633d81f9f64c4c84063837c261bdb86b">&#9670;&nbsp;</a></span>pushEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFBehavior::pushEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_x_f_event.html">XFEvent</a> *&#160;</td>
<td class="paramname"><em>pEvent</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Injects an event into the class. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_behavior.html#a28f0d4607468bc1d469a99e35954c204">interface::XFBehavior</a>.</p>
</div>
</div>
<a id="ad2dd82e9165b08e36d7f967bf103bd11" name="ad2dd82e9165b08e36d7f967bf103bd11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2dd82e9165b08e36d7f967bf103bd11">&#9670;&nbsp;</a></span>setDeleteOnTerminate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFBehavior::setDeleteOnTerminate </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>deleteBehaviour</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets/Clears the 'delete on terminate' property. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_behavior.html#a8d7e3cb115b567df031942552b81d919">interface::XFBehavior</a>.</p>
</div>
</div>
<a id="a84756f7e6fb88fc3efc4bc42b5bd2be9" name="a84756f7e6fb88fc3efc4bc42b5bd2be9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84756f7e6fb88fc3efc4bc42b5bd2be9">&#9670;&nbsp;</a></span>startBehavior()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFBehavior::startBehavior </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts the behavior, resp. the state machine. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_behavior.html#a03ae3f6c68bf16c51d2455d00cef2143">interface::XFBehavior</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/include/xf/<a class="el" href="behavior_8h_source.html">behavior.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

5
src/simplified/xf/doxygen/output/html/class_x_f_behavior__coll__graph.map Normal file
View File

@ -0,0 +1,5 @@
<map id="XFBehavior" name="XFBehavior">
<area shape="rect" id="node1" title="Base class for state machines, activities, process and data flows." alt="" coords="5,476,177,715"/>
<area shape="rect" id="node2" href="$classinterface_1_1_x_f_behavior.html" title="Interface to receive and process events." alt="" coords="5,5,177,171"/>
<area shape="rect" id="node3" href="$class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="107,233,267,413"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_behavior__coll__graph.md5 Normal file
View File

@ -0,0 +1 @@
669783a95659dc20623969930802a6be

BIN
src/simplified/xf/doxygen/output/html/class_x_f_behavior__coll__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

4
src/simplified/xf/doxygen/output/html/class_x_f_behavior__inherit__graph.map Normal file
View File

@ -0,0 +1,4 @@
<map id="XFBehavior" name="XFBehavior">
<area shape="rect" id="node1" title="Base class for state machines, activities, process and data flows." alt="" coords="5,219,177,472"/>
<area shape="rect" id="node2" href="$classinterface_1_1_x_f_behavior.html" title="Interface to receive and process events." alt="" coords="5,5,177,171"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_behavior__inherit__graph.md5 Normal file
View File

@ -0,0 +1 @@
0b57319781535c1d31c401eff913261e

BIN
src/simplified/xf/doxygen/output/html/class_x_f_behavior__inherit__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.4 KiB

96
src/simplified/xf/doxygen/output/html/class_x_f_custom_event-members.html Normal file
View File

@ -0,0 +1,96 @@
<!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>Simplified XF: Member List</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">Simplified XF<span id="projectnumber">&#160;1.1.0</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="headertitle"><div class="title">XFCustomEvent Member List</div></div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_x_f_custom_event.html">XFCustomEvent</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_x_f_custom_event.html#aff8ac484b7dd2c685360d83f1dde5978">bDeleteAfterConsume_</a></td><td class="entry"><a class="el" href="class_x_f_custom_event.html">XFCustomEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4e9bf5642755f9677aa9c4c415a3bcba">DefaultTransition</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_custom_event.html#ab7b119923ef1d0791542e2c7b85b6c5b">deleteAfterConsume</a>() const override</td><td class="entry"><a class="el" href="class_x_f_custom_event.html">XFCustomEvent</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4eefc024e7a72ce987c701013de3e100">Event</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a7b72b2c1edd9fba697b0bccbab3ed350">eventType_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">getBehavior</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">getEventType</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a33fdd5cc665f6224e803146d6b7ef9f6">getId</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#ae481937e76c817d67f704bfbc3ed2e30">id_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adc2df751813b38295784e246f9fe230e">Initial</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a1ec81ab9c537d5474cea2078d0d090e5">pBehavior_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#abbf3ce3d2bd6533c77900672a195320d">setBehavior</a>(interface::XFBehavior *pBehavior)</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_custom_event.html#a857fef63d9865fe47548d771ad7a036c">setDeleteAfterConsume</a>(bool bDeleteAfterConsume=true)</td><td class="entry"><a class="el" href="class_x_f_custom_event.html">XFCustomEvent</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a04f01a94d013ac0b3cd810b556427496">Timeout</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adfc2ad39d30f7a5df70c664bb2e24542">Unknown</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_custom_event.html#ac69745b360a9475342af506c30ae0414">XFCustomEvent</a>(int id, interface::XFBehavior *pBehavior=nullptr)</td><td class="entry"><a class="el" href="class_x_f_custom_event.html">XFCustomEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">XFEvent</a>(XFEventType eventType, int id=0)</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> enum name</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a81e1850b46acd477ea5a9475e12e3e1e">~XFEvent</a>()</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

283
src/simplified/xf/doxygen/output/html/class_x_f_custom_event.html Normal file
View File

@ -0,0 +1,283 @@
<!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>Simplified XF: XFCustomEvent 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">Simplified XF<span id="projectnumber">&#160;1.1.0</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-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_x_f_custom_event-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">XFCustomEvent Class Reference<div class="ingroups"><a class="el" href="group__xf__core.html">XF Core Classes</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Base class for project related events.
<a href="class_x_f_custom_event.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="customevent_8h_source.html">customevent.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for XFCustomEvent:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_custom_event__inherit__graph.png" border="0" usemap="#a_x_f_custom_event_inherit__map" alt="Inheritance graph"/></div>
<map name="a_x_f_custom_event_inherit__map" id="a_x_f_custom_event_inherit__map">
<area shape="rect" title="Base class for project related events." alt="" coords="5,248,184,355"/>
<area shape="rect" href="class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="15,5,175,200"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for XFCustomEvent:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_custom_event__coll__graph.png" border="0" usemap="#a_x_f_custom_event_coll__map" alt="Collaboration graph"/></div>
<map name="a_x_f_custom_event_coll__map" id="a_x_f_custom_event_coll__map">
<area shape="rect" title="Base class for project related events." alt="" coords="5,463,184,569"/>
<area shape="rect" href="class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="15,233,175,413"/>
<area shape="rect" href="classinterface_1_1_x_f_behavior.html" title="Interface to receive and process events." alt="" coords="9,5,181,171"/>
</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:ac69745b360a9475342af506c30ae0414"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_custom_event.html#ac69745b360a9475342af506c30ae0414">XFCustomEvent</a> (int id, <a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *pBehavior=nullptr)</td></tr>
<tr class="separator:ac69745b360a9475342af506c30ae0414"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7b119923ef1d0791542e2c7b85b6c5b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_custom_event.html#ab7b119923ef1d0791542e2c7b85b6c5b">deleteAfterConsume</a> () const override</td></tr>
<tr class="memdesc:ab7b119923ef1d0791542e2c7b85b6c5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tells the <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a> if the event should be deleted after processing. <a href="class_x_f_custom_event.html#ab7b119923ef1d0791542e2c7b85b6c5b">More...</a><br /></td></tr>
<tr class="separator:ab7b119923ef1d0791542e2c7b85b6c5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_x_f_event"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_x_f_event')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_x_f_event.html">XFEvent</a></td></tr>
<tr class="memitem:af17823d5915a117da46e571a3fa114b1 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">XFEvent</a> (<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> eventType, int id=0)</td></tr>
<tr class="memdesc:af17823d5915a117da46e571a3fa114b1 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard constructor. <a href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">More...</a><br /></td></tr>
<tr class="separator:af17823d5915a117da46e571a3fa114b1 inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81e1850b46acd477ea5a9475e12e3e1e inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a81e1850b46acd477ea5a9475e12e3e1e" name="a81e1850b46acd477ea5a9475e12e3e1e"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~XFEvent</b> ()</td></tr>
<tr class="memdesc:a81e1850b46acd477ea5a9475e12e3e1e inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class destructor. <br /></td></tr>
<tr class="separator:a81e1850b46acd477ea5a9475e12e3e1e inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abce814f103406c0a78cad6dd394ac567 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">getEventType</a> () const</td></tr>
<tr class="memdesc:abce814f103406c0a78cad6dd394ac567 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type of the event. <a href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">More...</a><br /></td></tr>
<tr class="separator:abce814f103406c0a78cad6dd394ac567 inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cc48cb3354298c94428032082840033 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">getBehavior</a> () const</td></tr>
<tr class="memdesc:a5cc48cb3354298c94428032082840033 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns pointer to behavioral class. <a href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">More...</a><br /></td></tr>
<tr class="separator:a5cc48cb3354298c94428032082840033 inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbf3ce3d2bd6533c77900672a195320d inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="abbf3ce3d2bd6533c77900672a195320d" name="abbf3ce3d2bd6533c77900672a195320d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setBehavior</b> (<a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *pBehavior)</td></tr>
<tr class="memdesc:abbf3ce3d2bd6533c77900672a195320d inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets pointer to behavioral class (see <a class="el" href="class_x_f_event.html#a1ec81ab9c537d5474cea2078d0d090e5" title="Pointer to behavioral class (ex. state-machine) processing the event.">pBehavior_</a>). Sets the behavior in which the event should be executed. <br /></td></tr>
<tr class="separator:abbf3ce3d2bd6533c77900672a195320d inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33fdd5cc665f6224e803146d6b7ef9f6 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a33fdd5cc665f6224e803146d6b7ef9f6" name="a33fdd5cc665f6224e803146d6b7ef9f6"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>getId</b> () const</td></tr>
<tr class="memdesc:a33fdd5cc665f6224e803146d6b7ef9f6 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <a class="el" href="class_x_f_event.html#ae481937e76c817d67f704bfbc3ed2e30" title="Event id to identify event in state-machine.">id_</a> identifying the event in the behaviors context. <br /></td></tr>
<tr class="separator:a33fdd5cc665f6224e803146d6b7ef9f6 inherit pub_methods_class_x_f_event"><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:a857fef63d9865fe47548d771ad7a036c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_custom_event.html#a857fef63d9865fe47548d771ad7a036c">setDeleteAfterConsume</a> (bool bDeleteAfterConsume=true)</td></tr>
<tr class="memdesc:a857fef63d9865fe47548d771ad7a036c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setter for <a class="el" href="class_x_f_custom_event.html#aff8ac484b7dd2c685360d83f1dde5978" title="True if the XF should delete event after consumption/dispatching.">bDeleteAfterConsume_</a> attribute. <a href="class_x_f_custom_event.html#a857fef63d9865fe47548d771ad7a036c">More...</a><br /></td></tr>
<tr class="separator:a857fef63d9865fe47548d771ad7a036c"><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:aff8ac484b7dd2c685360d83f1dde5978"><td class="memItemLeft" align="right" valign="top"><a id="aff8ac484b7dd2c685360d83f1dde5978" name="aff8ac484b7dd2c685360d83f1dde5978"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>bDeleteAfterConsume_</b></td></tr>
<tr class="memdesc:aff8ac484b7dd2c685360d83f1dde5978"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a> should delete event after consumption/dispatching. <br /></td></tr>
<tr class="separator:aff8ac484b7dd2c685360d83f1dde5978"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_x_f_event"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_x_f_event')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_x_f_event.html">XFEvent</a></td></tr>
<tr class="memitem:a7b72b2c1edd9fba697b0bccbab3ed350 inherit pro_attribs_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a7b72b2c1edd9fba697b0bccbab3ed350" name="a7b72b2c1edd9fba697b0bccbab3ed350"></a>
const <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a>&#160;</td><td class="memItemRight" valign="bottom"><b>eventType_</b></td></tr>
<tr class="memdesc:a7b72b2c1edd9fba697b0bccbab3ed350 inherit pro_attribs_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds the type of the event. <br /></td></tr>
<tr class="separator:a7b72b2c1edd9fba697b0bccbab3ed350 inherit pro_attribs_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae481937e76c817d67f704bfbc3ed2e30 inherit pro_attribs_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="ae481937e76c817d67f704bfbc3ed2e30" name="ae481937e76c817d67f704bfbc3ed2e30"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>id_</b></td></tr>
<tr class="memdesc:ae481937e76c817d67f704bfbc3ed2e30 inherit pro_attribs_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event id to identify event in state-machine. <br /></td></tr>
<tr class="separator:ae481937e76c817d67f704bfbc3ed2e30 inherit pro_attribs_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ec81ab9c537d5474cea2078d0d090e5 inherit pro_attribs_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a1ec81ab9c537d5474cea2078d0d090e5" name="a1ec81ab9c537d5474cea2078d0d090e5"></a>
<a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>pBehavior_</b></td></tr>
<tr class="memdesc:a1ec81ab9c537d5474cea2078d0d090e5 inherit pro_attribs_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to behavioral class (ex. state-machine) processing the event. <br /></td></tr>
<tr class="separator:a1ec81ab9c537d5474cea2078d0d090e5 inherit pro_attribs_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_class_x_f_event"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_x_f_event')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="class_x_f_event.html">XFEvent</a></td></tr>
<tr class="memitem:a944826b381ee833ffddd30342088bf91 inherit pub_types_class_x_f_event"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> { <br />
&#160;&#160;<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adfc2ad39d30f7a5df70c664bb2e24542">Unknown</a> = 0
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adc2df751813b38295784e246f9fe230e">Initial</a> = 1
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4e9bf5642755f9677aa9c4c415a3bcba">DefaultTransition</a> = 2
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4eefc024e7a72ce987c701013de3e100">Event</a> = 3
, <br />
&#160;&#160;<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a04f01a94d013ac0b3cd810b556427496">Timeout</a> = 4
<br />
}</td></tr>
<tr class="separator:a944826b381ee833ffddd30342088bf91 inherit pub_types_class_x_f_event"><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 >Base class for project related events. </p>
<p >It is possible to create custom events by deriving new classes/events from this class. All custom events have <code>#Event</code> as event type. In the state machine the event can be uniquely identified with <code><a class="el" href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567" title="Returns the type of the event.">getEventType()</a> == Event</code> and the event id <code><a class="el" href="class_x_f_event.html#a33fdd5cc665f6224e803146d6b7ef9f6" title="Returns id_ identifying the event in the behaviors context.">getId()</a></code> given to the object at construction time.</p>
<p >It is up to the devoper to handle the different event ids. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac69745b360a9475342af506c30ae0414" name="ac69745b360a9475342af506c30ae0414"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac69745b360a9475342af506c30ae0414">&#9670;&nbsp;</a></span>XFCustomEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XFCustomEvent::XFCustomEvent </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *&#160;</td>
<td class="paramname"><em>pBehavior</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Constructor for the class</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>Event identifier to identify the custom event (in the context of the behavior). </td></tr>
<tr><td class="paramname">pBehavior</td><td>The behavior for which the event was constructed (will consume the event). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab7b119923ef1d0791542e2c7b85b6c5b" name="ab7b119923ef1d0791542e2c7b85b6c5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7b119923ef1d0791542e2c7b85b6c5b">&#9670;&nbsp;</a></span>deleteAfterConsume()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XFCustomEvent::deleteAfterConsume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tells the <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a> if the event should be deleted after processing. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the event should be deleted. </dd></dl>
<p>Reimplemented from <a class="el" href="class_x_f_event.html#a917cec86b20ee75e768da336f5b18c70">XFEvent</a>.</p>
</div>
</div>
<a id="a857fef63d9865fe47548d771ad7a036c" name="a857fef63d9865fe47548d771ad7a036c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a857fef63d9865fe47548d771ad7a036c">&#9670;&nbsp;</a></span>setDeleteAfterConsume()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFCustomEvent::setDeleteAfterConsume </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>bDeleteAfterConsume</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Setter for <a class="el" href="class_x_f_custom_event.html#aff8ac484b7dd2c685360d83f1dde5978" title="True if the XF should delete event after consumption/dispatching.">bDeleteAfterConsume_</a> attribute. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bDeleteAfterConsume</td><td>Parameter to be assigned. Default: true. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/include/xf/<a class="el" href="customevent_8h_source.html">customevent.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

5
src/simplified/xf/doxygen/output/html/class_x_f_custom_event__coll__graph.map Normal file
View File

@ -0,0 +1,5 @@
<map id="XFCustomEvent" name="XFCustomEvent">
<area shape="rect" id="node1" title="Base class for project related events." alt="" coords="5,463,184,569"/>
<area shape="rect" id="node2" href="$class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="15,233,175,413"/>
<area shape="rect" id="node3" href="$classinterface_1_1_x_f_behavior.html" title="Interface to receive and process events." alt="" coords="9,5,181,171"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_custom_event__coll__graph.md5 Normal file
View File

@ -0,0 +1 @@
cde3ac54a2ecc7e269636b1dfab5716c

BIN
src/simplified/xf/doxygen/output/html/class_x_f_custom_event__coll__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.7 KiB

4
src/simplified/xf/doxygen/output/html/class_x_f_custom_event__inherit__graph.map Normal file
View File

@ -0,0 +1,4 @@
<map id="XFCustomEvent" name="XFCustomEvent">
<area shape="rect" id="node1" title="Base class for project related events." alt="" coords="5,248,184,355"/>
<area shape="rect" id="node2" href="$class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="15,5,175,200"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_custom_event__inherit__graph.md5 Normal file
View File

@ -0,0 +1 @@
5206f710f3c6233523223175deac5b52

BIN
src/simplified/xf/doxygen/output/html/class_x_f_custom_event__inherit__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.6 KiB

94
src/simplified/xf/doxygen/output/html/class_x_f_default_transition-members.html Normal file
View File

@ -0,0 +1,94 @@
<!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>Simplified XF: Member List</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">Simplified XF<span id="projectnumber">&#160;1.1.0</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="headertitle"><div class="title">XFDefaultTransition Member List</div></div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_x_f_default_transition.html">XFDefaultTransition</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4e9bf5642755f9677aa9c4c415a3bcba">DefaultTransition</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_default_transition.html#aee6aa0ae4c18b77dc2939a672c348a1b">deleteAfterConsume</a>() const override</td><td class="entry"><a class="el" href="class_x_f_default_transition.html">XFDefaultTransition</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4eefc024e7a72ce987c701013de3e100">Event</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a7b72b2c1edd9fba697b0bccbab3ed350">eventType_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">getBehavior</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">getEventType</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a33fdd5cc665f6224e803146d6b7ef9f6">getId</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#ae481937e76c817d67f704bfbc3ed2e30">id_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adc2df751813b38295784e246f9fe230e">Initial</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a1ec81ab9c537d5474cea2078d0d090e5">pBehavior_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#abbf3ce3d2bd6533c77900672a195320d">setBehavior</a>(interface::XFBehavior *pBehavior)</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a04f01a94d013ac0b3cd810b556427496">Timeout</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adfc2ad39d30f7a5df70c664bb2e24542">Unknown</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_default_transition.html#a2925af16ba3d1eb20d65138911cf38cc">XFDefaultTransition</a>()</td><td class="entry"><a class="el" href="class_x_f_default_transition.html">XFDefaultTransition</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">XFEvent</a>(XFEventType eventType, int id=0)</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> enum name</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a81e1850b46acd477ea5a9475e12e3e1e">~XFEvent</a>()</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

215
src/simplified/xf/doxygen/output/html/class_x_f_default_transition.html Normal file
View File

@ -0,0 +1,215 @@
<!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>Simplified XF: XFDefaultTransition 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">Simplified XF<span id="projectnumber">&#160;1.1.0</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="class_x_f_default_transition-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">XFDefaultTransition Class Reference<div class="ingroups"><a class="el" href="group__xf__core.html">XF Core Classes</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>State machine transition without trigger.
<a href="class_x_f_default_transition.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="defaulttransition_8h_source.html">defaulttransition.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for XFDefaultTransition:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_default_transition__inherit__graph.png" border="0" usemap="#a_x_f_default_transition_inherit__map" alt="Inheritance graph"/></div>
<map name="a_x_f_default_transition_inherit__map" id="a_x_f_default_transition_inherit__map">
<area shape="rect" title="State machine transition without trigger." alt="" coords="5,248,165,340"/>
<area shape="rect" href="class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="5,5,165,200"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for XFDefaultTransition:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_default_transition__coll__graph.png" border="0" usemap="#a_x_f_default_transition_coll__map" alt="Collaboration graph"/></div>
<map name="a_x_f_default_transition_coll__map" id="a_x_f_default_transition_coll__map">
<area shape="rect" title="State machine transition without trigger." alt="" coords="11,463,171,555"/>
<area shape="rect" href="class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="11,233,171,413"/>
<area shape="rect" href="classinterface_1_1_x_f_behavior.html" title="Interface to receive and process events." alt="" coords="5,5,177,171"/>
</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:a2925af16ba3d1eb20d65138911cf38cc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_default_transition.html#a2925af16ba3d1eb20d65138911cf38cc">XFDefaultTransition</a> ()</td></tr>
<tr class="separator:a2925af16ba3d1eb20d65138911cf38cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee6aa0ae4c18b77dc2939a672c348a1b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_default_transition.html#aee6aa0ae4c18b77dc2939a672c348a1b">deleteAfterConsume</a> () const override</td></tr>
<tr class="memdesc:aee6aa0ae4c18b77dc2939a672c348a1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <a class="el" href="class_x_f_event.html" title="Base class for all types of events and timeouts.">XFEvent</a>. <a href="class_x_f_default_transition.html#aee6aa0ae4c18b77dc2939a672c348a1b">More...</a><br /></td></tr>
<tr class="separator:aee6aa0ae4c18b77dc2939a672c348a1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_x_f_event"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_x_f_event')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_x_f_event.html">XFEvent</a></td></tr>
<tr class="memitem:af17823d5915a117da46e571a3fa114b1 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">XFEvent</a> (<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> eventType, int id=0)</td></tr>
<tr class="memdesc:af17823d5915a117da46e571a3fa114b1 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard constructor. <a href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">More...</a><br /></td></tr>
<tr class="separator:af17823d5915a117da46e571a3fa114b1 inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81e1850b46acd477ea5a9475e12e3e1e inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a81e1850b46acd477ea5a9475e12e3e1e" name="a81e1850b46acd477ea5a9475e12e3e1e"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~XFEvent</b> ()</td></tr>
<tr class="memdesc:a81e1850b46acd477ea5a9475e12e3e1e inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class destructor. <br /></td></tr>
<tr class="separator:a81e1850b46acd477ea5a9475e12e3e1e inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abce814f103406c0a78cad6dd394ac567 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">getEventType</a> () const</td></tr>
<tr class="memdesc:abce814f103406c0a78cad6dd394ac567 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type of the event. <a href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">More...</a><br /></td></tr>
<tr class="separator:abce814f103406c0a78cad6dd394ac567 inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cc48cb3354298c94428032082840033 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">getBehavior</a> () const</td></tr>
<tr class="memdesc:a5cc48cb3354298c94428032082840033 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns pointer to behavioral class. <a href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">More...</a><br /></td></tr>
<tr class="separator:a5cc48cb3354298c94428032082840033 inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbf3ce3d2bd6533c77900672a195320d inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="abbf3ce3d2bd6533c77900672a195320d" name="abbf3ce3d2bd6533c77900672a195320d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setBehavior</b> (<a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *pBehavior)</td></tr>
<tr class="memdesc:abbf3ce3d2bd6533c77900672a195320d inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets pointer to behavioral class (see <a class="el" href="class_x_f_event.html#a1ec81ab9c537d5474cea2078d0d090e5" title="Pointer to behavioral class (ex. state-machine) processing the event.">pBehavior_</a>). Sets the behavior in which the event should be executed. <br /></td></tr>
<tr class="separator:abbf3ce3d2bd6533c77900672a195320d inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33fdd5cc665f6224e803146d6b7ef9f6 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a33fdd5cc665f6224e803146d6b7ef9f6" name="a33fdd5cc665f6224e803146d6b7ef9f6"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>getId</b> () const</td></tr>
<tr class="memdesc:a33fdd5cc665f6224e803146d6b7ef9f6 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <a class="el" href="class_x_f_event.html#ae481937e76c817d67f704bfbc3ed2e30" title="Event id to identify event in state-machine.">id_</a> identifying the event in the behaviors context. <br /></td></tr>
<tr class="separator:a33fdd5cc665f6224e803146d6b7ef9f6 inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_class_x_f_event"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_x_f_event')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="class_x_f_event.html">XFEvent</a></td></tr>
<tr class="memitem:a944826b381ee833ffddd30342088bf91 inherit pub_types_class_x_f_event"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> { <br />
&#160;&#160;<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adfc2ad39d30f7a5df70c664bb2e24542">Unknown</a> = 0
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adc2df751813b38295784e246f9fe230e">Initial</a> = 1
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4e9bf5642755f9677aa9c4c415a3bcba">DefaultTransition</a> = 2
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4eefc024e7a72ce987c701013de3e100">Event</a> = 3
, <br />
&#160;&#160;<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a04f01a94d013ac0b3cd810b556427496">Timeout</a> = 4
<br />
}</td></tr>
<tr class="separator:a944826b381ee833ffddd30342088bf91 inherit pub_types_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_x_f_event"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_x_f_event')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_x_f_event.html">XFEvent</a></td></tr>
<tr class="memitem:a7b72b2c1edd9fba697b0bccbab3ed350 inherit pro_attribs_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a7b72b2c1edd9fba697b0bccbab3ed350" name="a7b72b2c1edd9fba697b0bccbab3ed350"></a>
const <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a>&#160;</td><td class="memItemRight" valign="bottom"><b>eventType_</b></td></tr>
<tr class="memdesc:a7b72b2c1edd9fba697b0bccbab3ed350 inherit pro_attribs_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds the type of the event. <br /></td></tr>
<tr class="separator:a7b72b2c1edd9fba697b0bccbab3ed350 inherit pro_attribs_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae481937e76c817d67f704bfbc3ed2e30 inherit pro_attribs_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="ae481937e76c817d67f704bfbc3ed2e30" name="ae481937e76c817d67f704bfbc3ed2e30"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>id_</b></td></tr>
<tr class="memdesc:ae481937e76c817d67f704bfbc3ed2e30 inherit pro_attribs_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event id to identify event in state-machine. <br /></td></tr>
<tr class="separator:ae481937e76c817d67f704bfbc3ed2e30 inherit pro_attribs_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ec81ab9c537d5474cea2078d0d090e5 inherit pro_attribs_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a1ec81ab9c537d5474cea2078d0d090e5" name="a1ec81ab9c537d5474cea2078d0d090e5"></a>
<a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>pBehavior_</b></td></tr>
<tr class="memdesc:a1ec81ab9c537d5474cea2078d0d090e5 inherit pro_attribs_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to behavioral class (ex. state-machine) processing the event. <br /></td></tr>
<tr class="separator:a1ec81ab9c537d5474cea2078d0d090e5 inherit pro_attribs_class_x_f_event"><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 >State machine transition without trigger. </p>
<p >Represents a transition in a state machine having no trigger.</p>
<p >In case one wants to directly transition from one state to another (without a trigger) a default transition must be pushed. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2925af16ba3d1eb20d65138911cf38cc" name="a2925af16ba3d1eb20d65138911cf38cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2925af16ba3d1eb20d65138911cf38cc">&#9670;&nbsp;</a></span>XFDefaultTransition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XFDefaultTransition::XFDefaultTransition </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Constructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aee6aa0ae4c18b77dc2939a672c348a1b" name="aee6aa0ae4c18b77dc2939a672c348a1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee6aa0ae4c18b77dc2939a672c348a1b">&#9670;&nbsp;</a></span>deleteAfterConsume()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XFDefaultTransition::deleteAfterConsume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>See <a class="el" href="class_x_f_event.html" title="Base class for all types of events and timeouts.">XFEvent</a>. </p>
<p>Reimplemented from <a class="el" href="class_x_f_event.html#a917cec86b20ee75e768da336f5b18c70">XFEvent</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/include/xf/<a class="el" href="defaulttransition_8h_source.html">defaulttransition.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

5
src/simplified/xf/doxygen/output/html/class_x_f_default_transition__coll__graph.map Normal file
View File

@ -0,0 +1,5 @@
<map id="XFDefaultTransition" name="XFDefaultTransition">
<area shape="rect" id="node1" title="State machine transition without trigger." alt="" coords="11,463,171,555"/>
<area shape="rect" id="node2" href="$class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="11,233,171,413"/>
<area shape="rect" id="node3" href="$classinterface_1_1_x_f_behavior.html" title="Interface to receive and process events." alt="" coords="5,5,177,171"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_default_transition__coll__graph.md5 Normal file
View File

@ -0,0 +1 @@
bba22e739f9941089f0687fa91fd8d29

BIN
src/simplified/xf/doxygen/output/html/class_x_f_default_transition__coll__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.2 KiB

4
src/simplified/xf/doxygen/output/html/class_x_f_default_transition__inherit__graph.map Normal file
View File

@ -0,0 +1,4 @@
<map id="XFDefaultTransition" name="XFDefaultTransition">
<area shape="rect" id="node1" title="State machine transition without trigger." alt="" coords="5,248,165,340"/>
<area shape="rect" id="node2" href="$class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="5,5,165,200"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_default_transition__inherit__graph.md5 Normal file
View File

@ -0,0 +1 @@
6289f78f4766fd87c99033094f2f88c3

BIN
src/simplified/xf/doxygen/output/html/class_x_f_default_transition__inherit__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.2 KiB

89
src/simplified/xf/doxygen/output/html/class_x_f_dispatcher-members.html Normal file
View File

@ -0,0 +1,89 @@
<!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>Simplified XF: Member List</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">Simplified XF<span id="projectnumber">&#160;1.1.0</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="headertitle"><div class="title">XFDispatcher Member List</div></div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_x_f_dispatcher.html#aed9fed4c3b80dea28d70a48e705f5926">dispatchEvent</a>(const XFEvent *pEvent) const override</td><td class="entry"><a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a></td><td class="entry"><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_dispatcher.html#a5723a225c756dde17d48b971f0633f1e">events_</a></td><td class="entry"><a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_dispatcher.html#af49bf1196f14094917a8d5223f4cd9d9">execute</a>(const void *param=nullptr) override</td><td class="entry"><a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_dispatcher.html#a6f9bbeed06f6220e2c1b9d3c3adb51e9">executeOnce</a>() override</td><td class="entry"><a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classinterface_1_1_x_f_dispatcher.html#a2f654b19fdb7dc8e770d546ab654674f">getInstance</a>()</td><td class="entry"><a class="el" href="classinterface_1_1_x_f_dispatcher.html">interface::XFDispatcher</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>interface::XFDispatcher</b> (defined in <a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a>)</td><td class="entry"><a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_dispatcher.html#a901fbafbd43609c427d3650b61ba752e">pMutex_</a></td><td class="entry"><a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_dispatcher.html#aa90c8a1c59aa2923b41cbc42af611ee1">pushEvent</a>(XFEvent *pEvent) override</td><td class="entry"><a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_dispatcher.html#adbf6b5be5913130ff3a63e43fc3601a7">scheduleTimeout</a>(int timeoutId, int interval, interface::XFBehavior *pBehavior) override</td><td class="entry"><a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_dispatcher.html#ad245be53e06cc8d9bb9256a4ffb2e01a">unscheduleTimeout</a>(int timeoutId, interface::XFBehavior *pBehavior) override</td><td class="entry"><a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>XFDispatcher</b>() (defined in <a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a>)</td><td class="entry"><a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>~XFDispatcher</b>() (defined in <a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a>)</td><td class="entry"><a class="el" href="class_x_f_dispatcher.html">XFDispatcher</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

412
src/simplified/xf/doxygen/output/html/class_x_f_dispatcher.html Normal file
View File

@ -0,0 +1,412 @@
<!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>Simplified XF: XFDispatcher 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">Simplified XF<span id="projectnumber">&#160;1.1.0</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-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="class_x_f_dispatcher-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">XFDispatcher Class Reference<div class="ingroups"><a class="el" href="group__port__common.html">XF Common Port Classes</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Dispatcher used in an IDF (no underlying OS).
<a href="class_x_f_dispatcher.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="port_2common_2dispatcher_8h_source.html">dispatcher.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for XFDispatcher:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_dispatcher__inherit__graph.png" border="0" usemap="#a_x_f_dispatcher_inherit__map" alt="Inheritance graph"/></div>
<map name="a_x_f_dispatcher_inherit__map" id="a_x_f_dispatcher_inherit__map">
<area shape="rect" title="Dispatcher used in an IDF (no underlying OS)." alt="" coords="7,248,161,443"/>
<area shape="rect" href="classinterface_1_1_x_f_dispatcher.html" title="Interface for the XF dispatcher providing the event processing loop." alt="" coords="5,5,163,200"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for XFDispatcher:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_dispatcher__coll__graph.png" border="0" usemap="#a_x_f_dispatcher_coll__map" alt="Collaboration graph"/></div>
<map name="a_x_f_dispatcher_coll__map" id="a_x_f_dispatcher_coll__map">
<area shape="rect" title="Dispatcher used in an IDF (no underlying OS)." alt="" coords="123,793,277,973"/>
<area shape="rect" href="classinterface_1_1_x_f_dispatcher.html" title="Interface for the XF dispatcher providing the event processing loop." alt="" coords="5,492,163,687"/>
<area shape="rect" href="class_x_f_event_queue.html" title="Default Qt implementation for the XFEventQueue interface." alt="" coords="305,448,441,731"/>
<area shape="rect" href="classinterface_1_1_x_f_event_queue.html" title="Interface to be implemented by the event queue." alt="" coords="357,213,523,378"/>
<area shape="rect" href="class_x_f_mutex.html" title="Default Qt implementation for the XFMutex interface." alt="" coords="238,205,333,385"/>
<area shape="rect" href="classinterface_1_1_x_f_mutex.html" title="Mutex interface needed by the XF to access a mutex." alt="" coords="220,5,351,156"/>
</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:aa90c8a1c59aa2923b41cbc42af611ee1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_dispatcher.html#aa90c8a1c59aa2923b41cbc42af611ee1">pushEvent</a> (<a class="el" href="class_x_f_event.html">XFEvent</a> *pEvent) override</td></tr>
<tr class="memdesc:aa90c8a1c59aa2923b41cbc42af611ee1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds event to the events queue. <a href="class_x_f_dispatcher.html#aa90c8a1c59aa2923b41cbc42af611ee1">More...</a><br /></td></tr>
<tr class="separator:aa90c8a1c59aa2923b41cbc42af611ee1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbf6b5be5913130ff3a63e43fc3601a7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_dispatcher.html#adbf6b5be5913130ff3a63e43fc3601a7">scheduleTimeout</a> (int timeoutId, int interval, <a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *pBehavior) override</td></tr>
<tr class="memdesc:adbf6b5be5913130ff3a63e43fc3601a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a new timeout to be handled. <a href="class_x_f_dispatcher.html#adbf6b5be5913130ff3a63e43fc3601a7">More...</a><br /></td></tr>
<tr class="separator:adbf6b5be5913130ff3a63e43fc3601a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad245be53e06cc8d9bb9256a4ffb2e01a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_dispatcher.html#ad245be53e06cc8d9bb9256a4ffb2e01a">unscheduleTimeout</a> (int timeoutId, <a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *pBehavior) override</td></tr>
<tr class="memdesc:ad245be53e06cc8d9bb9256a4ffb2e01a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes all timeouts corresponding the given parameters. <a href="class_x_f_dispatcher.html#ad245be53e06cc8d9bb9256a4ffb2e01a">More...</a><br /></td></tr>
<tr class="separator:ad245be53e06cc8d9bb9256a4ffb2e01a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f9bbeed06f6220e2c1b9d3c3adb51e9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_dispatcher.html#a6f9bbeed06f6220e2c1b9d3c3adb51e9">executeOnce</a> () override</td></tr>
<tr class="memdesc:a6f9bbeed06f6220e2c1b9d3c3adb51e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Executes once the dispatcher. <a href="class_x_f_dispatcher.html#a6f9bbeed06f6220e2c1b9d3c3adb51e9">More...</a><br /></td></tr>
<tr class="separator:a6f9bbeed06f6220e2c1b9d3c3adb51e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af49bf1196f14094917a8d5223f4cd9d9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_dispatcher.html#af49bf1196f14094917a8d5223f4cd9d9">execute</a> (const void *param=nullptr) override</td></tr>
<tr class="memdesc:af49bf1196f14094917a8d5223f4cd9d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main loop of the dispatcher. Implements event loop processing. <a href="class_x_f_dispatcher.html#af49bf1196f14094917a8d5223f4cd9d9">More...</a><br /></td></tr>
<tr class="separator:af49bf1196f14094917a8d5223f4cd9d9"><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:aed9fed4c3b80dea28d70a48e705f5926"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_dispatcher.html#aed9fed4c3b80dea28d70a48e705f5926">dispatchEvent</a> (const <a class="el" href="class_x_f_event.html">XFEvent</a> *pEvent) const override</td></tr>
<tr class="memdesc:aed9fed4c3b80dea28d70a48e705f5926"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatches the event to the corresponding behavioral part. <a href="class_x_f_dispatcher.html#aed9fed4c3b80dea28d70a48e705f5926">More...</a><br /></td></tr>
<tr class="separator:aed9fed4c3b80dea28d70a48e705f5926"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classinterface_1_1_x_f_dispatcher"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classinterface_1_1_x_f_dispatcher')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classinterface_1_1_x_f_dispatcher.html">interface::XFDispatcher</a></td></tr>
<tr class="memitem:ad3408783319457342fe3595a87af1c94 inherit pro_methods_classinterface_1_1_x_f_dispatcher"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classinterface_1_1_x_f_dispatcher.html#ad3408783319457342fe3595a87af1c94">XFDispatcher</a> ()=default</td></tr>
<tr class="separator:ad3408783319457342fe3595a87af1c94 inherit pro_methods_classinterface_1_1_x_f_dispatcher"><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:a5723a225c756dde17d48b971f0633f1e"><td class="memItemLeft" align="right" valign="top"><a id="a5723a225c756dde17d48b971f0633f1e" name="a5723a225c756dde17d48b971f0633f1e"></a>
<a class="el" href="class_x_f_event_queue.html">XFEventQueue</a>&#160;</td><td class="memItemRight" valign="bottom"><b>events_</b></td></tr>
<tr class="memdesc:a5723a225c756dde17d48b971f0633f1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queue holding events waiting to get dispatched. <br /></td></tr>
<tr class="separator:a5723a225c756dde17d48b971f0633f1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a901fbafbd43609c427d3650b61ba752e"><td class="memItemLeft" align="right" valign="top"><a id="a901fbafbd43609c427d3650b61ba752e" name="a901fbafbd43609c427d3650b61ba752e"></a>
<a class="el" href="classinterface_1_1_x_f_mutex.html">interface::XFMutex</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>pMutex_</b></td></tr>
<tr class="memdesc:a901fbafbd43609c427d3650b61ba752e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mutex to protect event queue. <br /></td></tr>
<tr class="separator:a901fbafbd43609c427d3650b61ba752e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a077275d1e1973054843c6b25ac28debf"><td class="memItemLeft" align="right" valign="top"><a id="a077275d1e1973054843c6b25ac28debf" name="a077275d1e1973054843c6b25ac28debf"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>interface::XFDispatcher</b></td></tr>
<tr class="separator:a077275d1e1973054843c6b25ac28debf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classinterface_1_1_x_f_dispatcher"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classinterface_1_1_x_f_dispatcher')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classinterface_1_1_x_f_dispatcher.html">interface::XFDispatcher</a></td></tr>
<tr class="memitem:a2f654b19fdb7dc8e770d546ab654674f inherit pub_static_methods_classinterface_1_1_x_f_dispatcher"><td class="memItemLeft" align="right" valign="top"><a id="a2f654b19fdb7dc8e770d546ab654674f" name="a2f654b19fdb7dc8e770d546ab654674f"></a>
static <a class="el" href="classinterface_1_1_x_f_dispatcher.html">XFDispatcher</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>getInstance</b> ()</td></tr>
<tr class="memdesc:a2f654b19fdb7dc8e770d546ab654674f inherit pub_static_methods_classinterface_1_1_x_f_dispatcher"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the single instance of <a class="el" href="classinterface_1_1_x_f_dispatcher.html" title="Interface for the XF dispatcher providing the event processing loop.">XFDispatcher</a>. <br /></td></tr>
<tr class="separator:a2f654b19fdb7dc8e770d546ab654674f inherit pub_static_methods_classinterface_1_1_x_f_dispatcher"><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 >Dispatcher used in an IDF (no underlying OS). </p>
<p >The dispatcher can be used when an IDF on a bare-metal embedded system is needed.</p>
<p >Only one instance of <a class="el" href="class_x_f_dispatcher.html" title="Dispatcher used in an IDF (no underlying OS).">XFDispatcher</a> is allowed (singleton pattern). It is the <a class="el" href="classinterface_1_1_x_f_dispatcher.html" title="Interface for the XF dispatcher providing the event processing loop.">interface::XFDispatcher</a> class providing the single instance of the <a class="el" href="class_x_f_dispatcher.html" title="Dispatcher used in an IDF (no underlying OS).">XFDispatcher</a> class (see <a class="el" href="classinterface_1_1_x_f_dispatcher.html#a2f654b19fdb7dc8e770d546ab654674f" title="Returns a pointer to the single instance of XFDispatcher.">interface::XFDispatcher::getInstance()</a>). </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7ad29aeaf88a26ad834bfce731f29ce3" name="a7ad29aeaf88a26ad834bfce731f29ce3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ad29aeaf88a26ad834bfce731f29ce3">&#9670;&nbsp;</a></span>~XFDispatcher()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual XFDispatcher::~XFDispatcher </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classinterface_1_1_x_f_dispatcher.html">interface::XFDispatcher</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aed9fed4c3b80dea28d70a48e705f5926" name="aed9fed4c3b80dea28d70a48e705f5926"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed9fed4c3b80dea28d70a48e705f5926">&#9670;&nbsp;</a></span>dispatchEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFDispatcher::dispatchEvent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_x_f_event.html">XFEvent</a> *&#160;</td>
<td class="paramname"><em>pEvent</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Dispatches the event to the corresponding behavioral part. </p>
<p >For example the state machine which should process the event.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pEvent</td><td>The event to dispatch </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classinterface_1_1_x_f_dispatcher.html#a65addbde50944781dd5ee0631affb701">interface::XFDispatcher</a>.</p>
</div>
</div>
<a id="af49bf1196f14094917a8d5223f4cd9d9" name="af49bf1196f14094917a8d5223f4cd9d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af49bf1196f14094917a8d5223f4cd9d9">&#9670;&nbsp;</a></span>execute()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int XFDispatcher::execute </td>
<td>(</td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>param</em> = <code>nullptr</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Main loop of the dispatcher. Implements event loop processing. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_dispatcher.html#a5f19f43b4e0780e3ea78a91af20c9dfa">interface::XFDispatcher</a>.</p>
</div>
</div>
<a id="a6f9bbeed06f6220e2c1b9d3c3adb51e9" name="a6f9bbeed06f6220e2c1b9d3c3adb51e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f9bbeed06f6220e2c1b9d3c3adb51e9">&#9670;&nbsp;</a></span>executeOnce()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFDispatcher::executeOnce </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Executes once the dispatcher. </p>
<p >Usually, this method must not be called explicitly. The standard way to call the dispatcher is to call <a class="el" href="class_x_f_dispatcher.html#af49bf1196f14094917a8d5223f4cd9d9" title="Main loop of the dispatcher. Implements event loop processing.">execute()</a>.</p>
<p >This method can be called by the Thread (or main function) if it must perform concurrent (non-XF related) tasks in addition.</p>
<p >When using this method start() must not be called. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_dispatcher.html#af31ffca7fedde5d9483e04b0b84a2e52">interface::XFDispatcher</a>.</p>
</div>
</div>
<a id="aa90c8a1c59aa2923b41cbc42af611ee1" name="aa90c8a1c59aa2923b41cbc42af611ee1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa90c8a1c59aa2923b41cbc42af611ee1">&#9670;&nbsp;</a></span>pushEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFDispatcher::pushEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_x_f_event.html">XFEvent</a> *&#160;</td>
<td class="paramname"><em>pEvent</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds event to the events queue. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_dispatcher.html#a6cdb4740b1e2a19ab037455f020e4548">interface::XFDispatcher</a>.</p>
</div>
</div>
<a id="adbf6b5be5913130ff3a63e43fc3601a7" name="adbf6b5be5913130ff3a63e43fc3601a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbf6b5be5913130ff3a63e43fc3601a7">&#9670;&nbsp;</a></span>scheduleTimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFDispatcher::scheduleTimeout </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>timeoutId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>interval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *&#160;</td>
<td class="paramname"><em>pBehavior</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a new timeout to be handled. </p>
<p >The dispatcher will forward the timeout information to the timeout manager which is responsible to handle all timeouts. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_dispatcher.html#afee36b51ca86b0357c0135ae89eade64">interface::XFDispatcher</a>.</p>
</div>
</div>
<a id="ad245be53e06cc8d9bb9256a4ffb2e01a" name="ad245be53e06cc8d9bb9256a4ffb2e01a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad245be53e06cc8d9bb9256a4ffb2e01a">&#9670;&nbsp;</a></span>unscheduleTimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFDispatcher::unscheduleTimeout </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>timeoutId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *&#160;</td>
<td class="paramname"><em>pBehavior</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes all timeouts corresponding the given parameters. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_dispatcher.html#a110619a2f91757b083420875a5ed2c51">interface::XFDispatcher</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/port/common/<a class="el" href="port_2common_2dispatcher_8h_source.html">dispatcher.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

8
src/simplified/xf/doxygen/output/html/class_x_f_dispatcher__coll__graph.map Normal file
View File

@ -0,0 +1,8 @@
<map id="XFDispatcher" name="XFDispatcher">
<area shape="rect" id="node1" title="Dispatcher used in an IDF (no underlying OS)." alt="" coords="123,793,277,973"/>
<area shape="rect" id="node2" href="$classinterface_1_1_x_f_dispatcher.html" title="Interface for the XF dispatcher providing the event processing loop." alt="" coords="5,492,163,687"/>
<area shape="rect" id="node3" href="$class_x_f_event_queue.html" title="Default Qt implementation for the XFEventQueue interface." alt="" coords="305,448,441,731"/>
<area shape="rect" id="node4" href="$classinterface_1_1_x_f_event_queue.html" title="Interface to be implemented by the event queue." alt="" coords="357,213,523,378"/>
<area shape="rect" id="node5" href="$class_x_f_mutex.html" title="Default Qt implementation for the XFMutex interface." alt="" coords="238,205,333,385"/>
<area shape="rect" id="node6" href="$classinterface_1_1_x_f_mutex.html" title="Mutex interface needed by the XF to access a mutex." alt="" coords="220,5,351,156"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_dispatcher__coll__graph.md5 Normal file
View File

@ -0,0 +1 @@
445827415ba973b649fd26dadc0b100f

BIN
src/simplified/xf/doxygen/output/html/class_x_f_dispatcher__coll__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 30 KiB

4
src/simplified/xf/doxygen/output/html/class_x_f_dispatcher__inherit__graph.map Normal file
View File

@ -0,0 +1,4 @@
<map id="XFDispatcher" name="XFDispatcher">
<area shape="rect" id="node1" title="Dispatcher used in an IDF (no underlying OS)." alt="" coords="7,248,161,443"/>
<area shape="rect" id="node2" href="$classinterface_1_1_x_f_dispatcher.html" title="Interface for the XF dispatcher providing the event processing loop." alt="" coords="5,5,163,200"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_dispatcher__inherit__graph.md5 Normal file
View File

@ -0,0 +1 @@
7e7af72170d97ce7503079a68e3a8b6e

BIN
src/simplified/xf/doxygen/output/html/class_x_f_dispatcher__inherit__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.3 KiB

93
src/simplified/xf/doxygen/output/html/class_x_f_event-members.html Normal file
View File

@ -0,0 +1,93 @@
<!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>Simplified XF: Member List</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">Simplified XF<span id="projectnumber">&#160;1.1.0</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="headertitle"><div class="title">XFEvent Member List</div></div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_x_f_event.html">XFEvent</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4e9bf5642755f9677aa9c4c415a3bcba">DefaultTransition</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a917cec86b20ee75e768da336f5b18c70">deleteAfterConsume</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4eefc024e7a72ce987c701013de3e100">Event</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a7b72b2c1edd9fba697b0bccbab3ed350">eventType_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">getBehavior</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">getEventType</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a33fdd5cc665f6224e803146d6b7ef9f6">getId</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#ae481937e76c817d67f704bfbc3ed2e30">id_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adc2df751813b38295784e246f9fe230e">Initial</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a1ec81ab9c537d5474cea2078d0d090e5">pBehavior_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#abbf3ce3d2bd6533c77900672a195320d">setBehavior</a>(interface::XFBehavior *pBehavior)</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a04f01a94d013ac0b3cd810b556427496">Timeout</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adfc2ad39d30f7a5df70c664bb2e24542">Unknown</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">XFEvent</a>(XFEventType eventType, int id=0)</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> enum name</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a81e1850b46acd477ea5a9475e12e3e1e">~XFEvent</a>()</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

331
src/simplified/xf/doxygen/output/html/class_x_f_event.html Normal file
View File

@ -0,0 +1,331 @@
<!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>Simplified XF: XFEvent 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">Simplified XF<span id="projectnumber">&#160;1.1.0</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-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_x_f_event-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">XFEvent Class Reference<div class="ingroups"><a class="el" href="group__xf__core.html">XF Core Classes</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Base class for all types of events and timeouts.
<a href="class_x_f_event.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="event_8h_source.html">event.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for XFEvent:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_event__inherit__graph.png" border="0" usemap="#a_x_f_event_inherit__map" alt="Inheritance graph"/></div>
<map name="a_x_f_event_inherit__map" id="a_x_f_event_inherit__map">
<area shape="rect" title="Base class for all types of events and timeouts." alt="" coords="300,5,460,200"/>
<area shape="rect" href="class_x_f_custom_event.html" title="Base class for project related events." alt="" coords="5,292,184,399"/>
<area shape="rect" href="class_x_f_default_transition.html" title="State machine transition without trigger." alt="" coords="208,299,368,391"/>
<area shape="rect" href="class_x_f_initial_event.html" title="Initial event to start a behavior." alt="" coords="392,299,552,391"/>
<area shape="rect" href="class_x_f_timeout.html" title="Used by the TimeoutManager to create and handle a timeout." alt="" coords="576,248,749,443"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for XFEvent:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_event__coll__graph.png" border="0" usemap="#a_x_f_event_coll__map" alt="Collaboration graph"/></div>
<map name="a_x_f_event_coll__map" id="a_x_f_event_coll__map">
<area shape="rect" title="Base class for all types of events and timeouts." alt="" coords="11,233,171,413"/>
<area shape="rect" href="classinterface_1_1_x_f_behavior.html" title="Interface to receive and process events." alt="" coords="5,5,177,171"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a944826b381ee833ffddd30342088bf91"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> { <br />
&#160;&#160;<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adfc2ad39d30f7a5df70c664bb2e24542">Unknown</a> = 0
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adc2df751813b38295784e246f9fe230e">Initial</a> = 1
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4e9bf5642755f9677aa9c4c415a3bcba">DefaultTransition</a> = 2
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4eefc024e7a72ce987c701013de3e100">Event</a> = 3
, <br />
&#160;&#160;<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a04f01a94d013ac0b3cd810b556427496">Timeout</a> = 4
<br />
}</td></tr>
<tr class="separator:a944826b381ee833ffddd30342088bf91"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:af17823d5915a117da46e571a3fa114b1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">XFEvent</a> (<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> eventType, int id=0)</td></tr>
<tr class="memdesc:af17823d5915a117da46e571a3fa114b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard constructor. <a href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">More...</a><br /></td></tr>
<tr class="separator:af17823d5915a117da46e571a3fa114b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81e1850b46acd477ea5a9475e12e3e1e"><td class="memItemLeft" align="right" valign="top"><a id="a81e1850b46acd477ea5a9475e12e3e1e" name="a81e1850b46acd477ea5a9475e12e3e1e"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~XFEvent</b> ()</td></tr>
<tr class="memdesc:a81e1850b46acd477ea5a9475e12e3e1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class destructor. <br /></td></tr>
<tr class="separator:a81e1850b46acd477ea5a9475e12e3e1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abce814f103406c0a78cad6dd394ac567"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">getEventType</a> () const</td></tr>
<tr class="memdesc:abce814f103406c0a78cad6dd394ac567"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type of the event. <a href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">More...</a><br /></td></tr>
<tr class="separator:abce814f103406c0a78cad6dd394ac567"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cc48cb3354298c94428032082840033"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">getBehavior</a> () const</td></tr>
<tr class="memdesc:a5cc48cb3354298c94428032082840033"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns pointer to behavioral class. <a href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">More...</a><br /></td></tr>
<tr class="separator:a5cc48cb3354298c94428032082840033"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbf3ce3d2bd6533c77900672a195320d"><td class="memItemLeft" align="right" valign="top"><a id="abbf3ce3d2bd6533c77900672a195320d" name="abbf3ce3d2bd6533c77900672a195320d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setBehavior</b> (<a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *pBehavior)</td></tr>
<tr class="memdesc:abbf3ce3d2bd6533c77900672a195320d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets pointer to behavioral class (see <a class="el" href="class_x_f_event.html#a1ec81ab9c537d5474cea2078d0d090e5" title="Pointer to behavioral class (ex. state-machine) processing the event.">pBehavior_</a>). Sets the behavior in which the event should be executed. <br /></td></tr>
<tr class="separator:abbf3ce3d2bd6533c77900672a195320d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33fdd5cc665f6224e803146d6b7ef9f6"><td class="memItemLeft" align="right" valign="top"><a id="a33fdd5cc665f6224e803146d6b7ef9f6" name="a33fdd5cc665f6224e803146d6b7ef9f6"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>getId</b> () const</td></tr>
<tr class="memdesc:a33fdd5cc665f6224e803146d6b7ef9f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <a class="el" href="class_x_f_event.html#ae481937e76c817d67f704bfbc3ed2e30" title="Event id to identify event in state-machine.">id_</a> identifying the event in the behaviors context. <br /></td></tr>
<tr class="separator:a33fdd5cc665f6224e803146d6b7ef9f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a917cec86b20ee75e768da336f5b18c70"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#a917cec86b20ee75e768da336f5b18c70">deleteAfterConsume</a> () const</td></tr>
<tr class="memdesc:a917cec86b20ee75e768da336f5b18c70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tells the dispatcher if the event must be deleted or not. <a href="class_x_f_event.html#a917cec86b20ee75e768da336f5b18c70">More...</a><br /></td></tr>
<tr class="separator:a917cec86b20ee75e768da336f5b18c70"><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:a7b72b2c1edd9fba697b0bccbab3ed350"><td class="memItemLeft" align="right" valign="top"><a id="a7b72b2c1edd9fba697b0bccbab3ed350" name="a7b72b2c1edd9fba697b0bccbab3ed350"></a>
const <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a>&#160;</td><td class="memItemRight" valign="bottom"><b>eventType_</b></td></tr>
<tr class="memdesc:a7b72b2c1edd9fba697b0bccbab3ed350"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds the type of the event. <br /></td></tr>
<tr class="separator:a7b72b2c1edd9fba697b0bccbab3ed350"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae481937e76c817d67f704bfbc3ed2e30"><td class="memItemLeft" align="right" valign="top"><a id="ae481937e76c817d67f704bfbc3ed2e30" name="ae481937e76c817d67f704bfbc3ed2e30"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>id_</b></td></tr>
<tr class="memdesc:ae481937e76c817d67f704bfbc3ed2e30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event id to identify event in state-machine. <br /></td></tr>
<tr class="separator:ae481937e76c817d67f704bfbc3ed2e30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ec81ab9c537d5474cea2078d0d090e5"><td class="memItemLeft" align="right" valign="top"><a id="a1ec81ab9c537d5474cea2078d0d090e5" name="a1ec81ab9c537d5474cea2078d0d090e5"></a>
<a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>pBehavior_</b></td></tr>
<tr class="memdesc:a1ec81ab9c537d5474cea2078d0d090e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to behavioral class (ex. state-machine) processing the event. <br /></td></tr>
<tr class="separator:a1ec81ab9c537d5474cea2078d0d090e5"><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 >Base class for all types of events and timeouts. </p>
<p >Requirements:</p><ul>
<li>Needs to hold a property which allows to distinguish between different types of events (<a class="el" href="class_x_f_event.html#a7b72b2c1edd9fba697b0bccbab3ed350" title="Holds the type of the event.">eventType_</a>).</li>
<li>Use an enumeration to define the type for the event type property (<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a>).</li>
<li>The event type property needs to be set at initialization time and cannot be changed afterwards. </li>
</ul>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a944826b381ee833ffddd30342088bf91" name="a944826b381ee833ffddd30342088bf91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a944826b381ee833ffddd30342088bf91">&#9670;&nbsp;</a></span>XFEventType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEvent::XFEventType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p >Defines the types of events </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a944826b381ee833ffddd30342088bf91adfc2ad39d30f7a5df70c664bb2e24542" name="a944826b381ee833ffddd30342088bf91adfc2ad39d30f7a5df70c664bb2e24542"></a>Unknown&#160;</td><td class="fielddoc"><p >Unknown state (not initialized). </p>
</td></tr>
<tr><td class="fieldname"><a id="a944826b381ee833ffddd30342088bf91adc2df751813b38295784e246f9fe230e" name="a944826b381ee833ffddd30342088bf91adc2df751813b38295784e246f9fe230e"></a>Initial&#160;</td><td class="fielddoc"><p >Initial pseudostate. </p>
</td></tr>
<tr><td class="fieldname"><a id="a944826b381ee833ffddd30342088bf91a4e9bf5642755f9677aa9c4c415a3bcba" name="a944826b381ee833ffddd30342088bf91a4e9bf5642755f9677aa9c4c415a3bcba"></a>DefaultTransition&#160;</td><td class="fielddoc"><p >Event generated by the state machine to define a default transition. </p>
</td></tr>
<tr><td class="fieldname"><a id="a944826b381ee833ffddd30342088bf91a4eefc024e7a72ce987c701013de3e100" name="a944826b381ee833ffddd30342088bf91a4eefc024e7a72ce987c701013de3e100"></a>Event&#160;</td><td class="fielddoc"><p >Custom event. </p>
</td></tr>
<tr><td class="fieldname"><a id="a944826b381ee833ffddd30342088bf91a04f01a94d013ac0b3cd810b556427496" name="a944826b381ee833ffddd30342088bf91a04f01a94d013ac0b3cd810b556427496"></a>Timeout&#160;</td><td class="fielddoc"><p >Defines a timeout event. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af17823d5915a117da46e571a3fa114b1" name="af17823d5915a117da46e571a3fa114b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af17823d5915a117da46e571a3fa114b1">&#9670;&nbsp;</a></span>XFEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">XFEvent::XFEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a>&#160;</td>
<td class="paramname"><em>eventType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>id</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Standard constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eventType</td><td>The event type to be represented by the event. </td></tr>
<tr><td class="paramname">id</td><td>State-machine specific id to identify event. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a917cec86b20ee75e768da336f5b18c70" name="a917cec86b20ee75e768da336f5b18c70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a917cec86b20ee75e768da336f5b18c70">&#9670;&nbsp;</a></span>deleteAfterConsume()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool XFEvent::deleteAfterConsume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tells the dispatcher if the event must be deleted or not. </p>
<p>Reimplemented in <a class="el" href="class_x_f_custom_event.html#ab7b119923ef1d0791542e2c7b85b6c5b">XFCustomEvent</a>, <a class="el" href="class_x_f_default_transition.html#aee6aa0ae4c18b77dc2939a672c348a1b">XFDefaultTransition</a>, <a class="el" href="class_x_f_initial_event.html#a0a2ab8ade826467db2fe796a663031fe">XFInitialEvent</a>, and <a class="el" href="class_x_f_timeout.html#a0d4154698f3337e7181a5f3455a16a93">XFTimeout</a>.</p>
</div>
</div>
<a id="a5cc48cb3354298c94428032082840033" name="a5cc48cb3354298c94428032082840033"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cc48cb3354298c94428032082840033">&#9670;&nbsp;</a></span>getBehavior()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> * XFEvent::getBehavior </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns pointer to behavioral class. </p>
<p >Returns a pointer to the behavioral class processing the event (see <a class="el" href="class_x_f_event.html#a1ec81ab9c537d5474cea2078d0d090e5" title="Pointer to behavioral class (ex. state-machine) processing the event.">pBehavior_</a>). </p>
</div>
</div>
<a id="abce814f103406c0a78cad6dd394ac567" name="abce814f103406c0a78cad6dd394ac567"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abce814f103406c0a78cad6dd394ac567">&#9670;&nbsp;</a></span>getEventType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> XFEvent::getEventType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the type of the event. </p>
<p >Can be used to distinguish between an event or a timeout. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/include/xf/<a class="el" href="event_8h_source.html">event.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

4
src/simplified/xf/doxygen/output/html/class_x_f_event__coll__graph.map Normal file
View File

@ -0,0 +1,4 @@
<map id="XFEvent" name="XFEvent">
<area shape="rect" id="node1" title="Base class for all types of events and timeouts." alt="" coords="11,233,171,413"/>
<area shape="rect" id="node2" href="$classinterface_1_1_x_f_behavior.html" title="Interface to receive and process events." alt="" coords="5,5,177,171"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_event__coll__graph.md5 Normal file
View File

@ -0,0 +1 @@
3d61b0649e2830e510fa448ab1be5bfc

BIN
src/simplified/xf/doxygen/output/html/class_x_f_event__coll__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.3 KiB

7
src/simplified/xf/doxygen/output/html/class_x_f_event__inherit__graph.map Normal file
View File

@ -0,0 +1,7 @@
<map id="XFEvent" name="XFEvent">
<area shape="rect" id="node1" title="Base class for all types of events and timeouts." alt="" coords="300,5,460,200"/>
<area shape="rect" id="node2" href="$class_x_f_custom_event.html" title="Base class for project related events." alt="" coords="5,292,184,399"/>
<area shape="rect" id="node3" href="$class_x_f_default_transition.html" title="State machine transition without trigger." alt="" coords="208,299,368,391"/>
<area shape="rect" id="node4" href="$class_x_f_initial_event.html" title="Initial event to start a behavior." alt="" coords="392,299,552,391"/>
<area shape="rect" id="node5" href="$class_x_f_timeout.html" title="Used by the TimeoutManager to create and handle a timeout." alt="" coords="576,248,749,443"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_event__inherit__graph.md5 Normal file
View File

@ -0,0 +1 @@
7ce57cdf7d0c023151a8a7816a795b43

BIN
src/simplified/xf/doxygen/output/html/class_x_f_event__inherit__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

97
src/simplified/xf/doxygen/output/html/class_x_f_event_queue-members.html Normal file
View File

@ -0,0 +1,97 @@
<!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>Simplified XF: Member List</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">Simplified XF<span id="projectnumber">&#160;1.1.0</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="headertitle"><div class="title">XFEventQueue Member List</div></div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_x_f_event_queue.html">XFEventQueue</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event_queue.html#a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a">empty</a>() const override</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event_queue.html#a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a">empty</a>() const override</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event_queue.html#af64984d52162b36ee640923a664fb446">EventQueue</a> typedef</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event_queue.html#ae37b5d871dd5c5ff1026dd318cd13e1e">EventQueue</a> typedef</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event_queue.html#a91c78f3845e8f4d128ae4b25241c09ec">front</a>() override</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event_queue.html#a91c78f3845e8f4d128ae4b25241c09ec">front</a>() override</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event_queue.html#a66f60e652b807ffb67e7e5b4b21904ce">mutex_</a></td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event_queue.html#a5c4bd0b399fc48be3ae6c092221dab9f">mutex_</a></td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event_queue.html#a374c189f0ffd430963a87ce4c75d28b4">newEvents_</a></td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event_queue.html#a53d5e0eca81e14bba6c9b9b75b0e5566">pend</a>() override</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event_queue.html#a53d5e0eca81e14bba6c9b9b75b0e5566">pend</a>() override</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event_queue.html#a40671cbd4b5731daea332eb3c6844e71">pop</a>() override</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event_queue.html#a40671cbd4b5731daea332eb3c6844e71">pop</a>() override</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event_queue.html#ab164fbfa8ad7b5c75194b2b0e8caecc4">push</a>(const XFEvent *pEvent, bool fromISR=false) override</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event_queue.html#ab164fbfa8ad7b5c75194b2b0e8caecc4">push</a>(const XFEvent *pEvent, bool fromISR=false) override</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event_queue.html#a3d6f7968984762a3a210bd4a11d9c1b3">queue_</a></td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>XFEventQueue</b>() (defined in <a class="el" href="class_x_f_event_queue.html">XFEventQueue</a>)</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>XFEventQueue</b>() (defined in <a class="el" href="class_x_f_event_queue.html">XFEventQueue</a>)</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~XFEventQueue</b>() override (defined in <a class="el" href="class_x_f_event_queue.html">XFEventQueue</a>)</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>~XFEventQueue</b>() (defined in <a class="el" href="class_x_f_event_queue.html">XFEventQueue</a>)</td><td class="entry"><a class="el" href="class_x_f_event_queue.html">XFEventQueue</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

546
src/simplified/xf/doxygen/output/html/class_x_f_event_queue.html Normal file
View File

@ -0,0 +1,546 @@
<!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>Simplified XF: XFEventQueue 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">Simplified XF<span id="projectnumber">&#160;1.1.0</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-attribs">Protected Attributes</a> &#124;
<a href="class_x_f_event_queue-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">XFEventQueue Class Reference<div class="ingroups"><a class="el" href="group__port__idf__qt.html">IDF Qt Port Classes</a> &#124; <a class="el" href="group__port__idf__stm32.html">IDF STM32 Port Classes</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Default Qt implementation for the <a class="el" href="class_x_f_event_queue.html" title="Default Qt implementation for the XFEventQueue interface.">XFEventQueue</a> interface.
<a href="class_x_f_event_queue.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="port_2idf-qt_2eventqueue_8h_source.html">eventqueue.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for XFEventQueue:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_event_queue__inherit__graph.png" border="0" usemap="#a_x_f_event_queue_inherit__map" alt="Inheritance graph"/></div>
<map name="a_x_f_event_queue_inherit__map" id="a_x_f_event_queue_inherit__map">
<area shape="rect" title="Default Qt implementation for the XFEventQueue interface." alt="" coords="20,219,156,531"/>
<area shape="rect" href="classinterface_1_1_x_f_event_queue.html" title="Interface to be implemented by the event queue." alt="" coords="5,5,171,171"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for XFEventQueue:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_event_queue__coll__graph.png" border="0" usemap="#a_x_f_event_queue_coll__map" alt="Collaboration graph"/></div>
<map name="a_x_f_event_queue_coll__map" id="a_x_f_event_queue_coll__map">
<area shape="rect" title="Default Qt implementation for the XFEventQueue interface." alt="" coords="20,448,156,731"/>
<area shape="rect" href="classinterface_1_1_x_f_event_queue.html" title="Interface to be implemented by the event queue." alt="" coords="5,213,171,378"/>
<area shape="rect" href="class_x_f_mutex.html" title="Default Qt implementation for the XFMutex interface." alt="" coords="195,205,290,385"/>
<area shape="rect" href="classinterface_1_1_x_f_mutex.html" title="Mutex interface needed by the XF to access a mutex." alt="" coords="177,5,308,156"/>
</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:a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event_queue.html#a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a">empty</a> () const override</td></tr>
<tr class="memdesc:a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if no event is in the queue. <a href="class_x_f_event_queue.html#a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a">More...</a><br /></td></tr>
<tr class="separator:a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab164fbfa8ad7b5c75194b2b0e8caecc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event_queue.html#ab164fbfa8ad7b5c75194b2b0e8caecc4">push</a> (const <a class="el" href="class_x_f_event.html">XFEvent</a> *pEvent, bool fromISR=false) override</td></tr>
<tr class="memdesc:ab164fbfa8ad7b5c75194b2b0e8caecc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pushes the given event onto the queue. Returns false if the event could not be pushed. <a href="class_x_f_event_queue.html#ab164fbfa8ad7b5c75194b2b0e8caecc4">More...</a><br /></td></tr>
<tr class="separator:ab164fbfa8ad7b5c75194b2b0e8caecc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91c78f3845e8f4d128ae4b25241c09ec"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_x_f_event.html">XFEvent</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event_queue.html#a91c78f3845e8f4d128ae4b25241c09ec">front</a> () override</td></tr>
<tr class="memdesc:a91c78f3845e8f4d128ae4b25241c09ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns pointer to next event to pop. <a href="class_x_f_event_queue.html#a91c78f3845e8f4d128ae4b25241c09ec">More...</a><br /></td></tr>
<tr class="separator:a91c78f3845e8f4d128ae4b25241c09ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40671cbd4b5731daea332eb3c6844e71"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event_queue.html#a40671cbd4b5731daea332eb3c6844e71">pop</a> () override</td></tr>
<tr class="memdesc:a40671cbd4b5731daea332eb3c6844e71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pops the next event from the queue. <a href="class_x_f_event_queue.html#a40671cbd4b5731daea332eb3c6844e71">More...</a><br /></td></tr>
<tr class="separator:a40671cbd4b5731daea332eb3c6844e71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53d5e0eca81e14bba6c9b9b75b0e5566"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event_queue.html#a53d5e0eca81e14bba6c9b9b75b0e5566">pend</a> () override</td></tr>
<tr class="memdesc:a53d5e0eca81e14bba6c9b9b75b0e5566"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for the next event to arrive. Returns true if an event is in the queue. <a href="class_x_f_event_queue.html#a53d5e0eca81e14bba6c9b9b75b0e5566">More...</a><br /></td></tr>
<tr class="separator:a53d5e0eca81e14bba6c9b9b75b0e5566"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event_queue.html#a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a">empty</a> () const override</td></tr>
<tr class="memdesc:a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if no event is in the queue. <a href="class_x_f_event_queue.html#a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a">More...</a><br /></td></tr>
<tr class="separator:a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab164fbfa8ad7b5c75194b2b0e8caecc4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event_queue.html#ab164fbfa8ad7b5c75194b2b0e8caecc4">push</a> (const <a class="el" href="class_x_f_event.html">XFEvent</a> *pEvent, bool fromISR=false) override</td></tr>
<tr class="memdesc:ab164fbfa8ad7b5c75194b2b0e8caecc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pushes the given event onto the queue. <a href="class_x_f_event_queue.html#ab164fbfa8ad7b5c75194b2b0e8caecc4">More...</a><br /></td></tr>
<tr class="separator:ab164fbfa8ad7b5c75194b2b0e8caecc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91c78f3845e8f4d128ae4b25241c09ec"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_x_f_event.html">XFEvent</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event_queue.html#a91c78f3845e8f4d128ae4b25241c09ec">front</a> () override</td></tr>
<tr class="memdesc:a91c78f3845e8f4d128ae4b25241c09ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns pointer to next event to pop. <a href="class_x_f_event_queue.html#a91c78f3845e8f4d128ae4b25241c09ec">More...</a><br /></td></tr>
<tr class="separator:a91c78f3845e8f4d128ae4b25241c09ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40671cbd4b5731daea332eb3c6844e71"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event_queue.html#a40671cbd4b5731daea332eb3c6844e71">pop</a> () override</td></tr>
<tr class="memdesc:a40671cbd4b5731daea332eb3c6844e71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pops the next event from the queue. <a href="class_x_f_event_queue.html#a40671cbd4b5731daea332eb3c6844e71">More...</a><br /></td></tr>
<tr class="separator:a40671cbd4b5731daea332eb3c6844e71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53d5e0eca81e14bba6c9b9b75b0e5566"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event_queue.html#a53d5e0eca81e14bba6c9b9b75b0e5566">pend</a> () override</td></tr>
<tr class="memdesc:a53d5e0eca81e14bba6c9b9b75b0e5566"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for the next event to arrive. Returns true if an event is in the queue. <a href="class_x_f_event_queue.html#a53d5e0eca81e14bba6c9b9b75b0e5566">More...</a><br /></td></tr>
<tr class="separator:a53d5e0eca81e14bba6c9b9b75b0e5566"><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:af64984d52162b36ee640923a664fb446"><td class="memItemLeft" align="right" valign="top"><a id="af64984d52162b36ee640923a664fb446" name="af64984d52162b36ee640923a664fb446"></a>
typedef QQueue&lt; const <a class="el" href="class_x_f_event.html">XFEvent</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>EventQueue</b></td></tr>
<tr class="memdesc:af64984d52162b36ee640923a664fb446"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of the event queue. <br /></td></tr>
<tr class="separator:af64984d52162b36ee640923a664fb446"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae37b5d871dd5c5ff1026dd318cd13e1e"><td class="memItemLeft" align="right" valign="top"><a id="ae37b5d871dd5c5ff1026dd318cd13e1e" name="ae37b5d871dd5c5ff1026dd318cd13e1e"></a>
typedef std::queue&lt; const <a class="el" href="class_x_f_event.html">XFEvent</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>EventQueue</b></td></tr>
<tr class="memdesc:ae37b5d871dd5c5ff1026dd318cd13e1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of the event queue. <br /></td></tr>
<tr class="separator:ae37b5d871dd5c5ff1026dd318cd13e1e"><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:a66f60e652b807ffb67e7e5b4b21904ce"><td class="memItemLeft" align="right" valign="top"><a id="a66f60e652b807ffb67e7e5b4b21904ce" name="a66f60e652b807ffb67e7e5b4b21904ce"></a>
QMutex&#160;</td><td class="memItemRight" valign="bottom"><b>mutex_</b></td></tr>
<tr class="memdesc:a66f60e652b807ffb67e7e5b4b21904ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mutex (non-recursive) protecting access to _queue. <br /></td></tr>
<tr class="separator:a66f60e652b807ffb67e7e5b4b21904ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a374c189f0ffd430963a87ce4c75d28b4"><td class="memItemLeft" align="right" valign="top"><a id="a374c189f0ffd430963a87ce4c75d28b4" name="a374c189f0ffd430963a87ce4c75d28b4"></a>
QWaitCondition&#160;</td><td class="memItemRight" valign="bottom"><b>newEvents_</b></td></tr>
<tr class="memdesc:a374c189f0ffd430963a87ce4c75d28b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait condition to let thread wait until a new event arrives. <br /></td></tr>
<tr class="separator:a374c189f0ffd430963a87ce4c75d28b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d6f7968984762a3a210bd4a11d9c1b3"><td class="memItemLeft" align="right" valign="top"><a id="a3d6f7968984762a3a210bd4a11d9c1b3" name="a3d6f7968984762a3a210bd4a11d9c1b3"></a>
<a class="el" href="class_x_f_event_queue.html#af64984d52162b36ee640923a664fb446">EventQueue</a>&#160;</td><td class="memItemRight" valign="bottom"><b>queue_</b></td></tr>
<tr class="memdesc:a3d6f7968984762a3a210bd4a11d9c1b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal queue holding the events. <br /></td></tr>
<tr class="separator:a3d6f7968984762a3a210bd4a11d9c1b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c4bd0b399fc48be3ae6c092221dab9f"><td class="memItemLeft" align="right" valign="top"><a id="a5c4bd0b399fc48be3ae6c092221dab9f" name="a5c4bd0b399fc48be3ae6c092221dab9f"></a>
<a class="el" href="class_x_f_mutex.html">Mutex</a>&#160;</td><td class="memItemRight" valign="bottom"><b>mutex_</b></td></tr>
<tr class="memdesc:a5c4bd0b399fc48be3ae6c092221dab9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mutex protecting access to queue_. <br /></td></tr>
<tr class="separator:a5c4bd0b399fc48be3ae6c092221dab9f"><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 >Default Qt implementation for the <a class="el" href="class_x_f_event_queue.html" title="Default Qt implementation for the XFEventQueue interface.">XFEventQueue</a> interface. </p>
<p >Default implementation of the event queue using a <code>std::queue</code> as container.</p>
<p >This class does not provide a blocking <a class="el" href="class_x_f_event_queue.html#a53d5e0eca81e14bba6c9b9b75b0e5566" title="Wait for the next event to arrive. Returns true if an event is in the queue.">pend()</a> method. This means that this class can be used in an IDF, but is not the right choice for a RTOS based <a class="el" href="class_x_f.html" title="Static class grouping the basic methods for the XF together.">XF</a>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="acb2fbd054f98b64b9554dd2d099a3331" name="acb2fbd054f98b64b9554dd2d099a3331"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb2fbd054f98b64b9554dd2d099a3331">&#9670;&nbsp;</a></span>~XFEventQueue() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">XFEventQueue::~XFEventQueue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classinterface_1_1_x_f_event_queue.html">interface::XFEventQueue</a>.</p>
</div>
</div>
<a id="affb0fd3cb6d837c59176a316cba6c290" name="affb0fd3cb6d837c59176a316cba6c290"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affb0fd3cb6d837c59176a316cba6c290">&#9670;&nbsp;</a></span>~XFEventQueue() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual XFEventQueue::~XFEventQueue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classinterface_1_1_x_f_event_queue.html">interface::XFEventQueue</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a" name="a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a">&#9670;&nbsp;</a></span>empty() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XFEventQueue::empty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if no event is in the queue. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_event_queue.html#ac233817695332ff2c5d5d153a8956347">interface::XFEventQueue</a>.</p>
</div>
</div>
<a id="a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a" name="a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d8dd5aa2e2ac3fc8dcf67d7ec3dcd3a">&#9670;&nbsp;</a></span>empty() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XFEventQueue::empty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if no event is in the queue. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_event_queue.html#ac233817695332ff2c5d5d153a8956347">interface::XFEventQueue</a>.</p>
</div>
</div>
<a id="a91c78f3845e8f4d128ae4b25241c09ec" name="a91c78f3845e8f4d128ae4b25241c09ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91c78f3845e8f4d128ae4b25241c09ec">&#9670;&nbsp;</a></span>front() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="class_x_f_event.html">XFEvent</a> * XFEventQueue::front </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns pointer to next event to pop. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_event_queue.html#a3050eeb0a1286bd5be22fba67cd52157">interface::XFEventQueue</a>.</p>
</div>
</div>
<a id="a91c78f3845e8f4d128ae4b25241c09ec" name="a91c78f3845e8f4d128ae4b25241c09ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91c78f3845e8f4d128ae4b25241c09ec">&#9670;&nbsp;</a></span>front() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="class_x_f_event.html">XFEvent</a> * XFEventQueue::front </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns pointer to next event to pop. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_event_queue.html#a3050eeb0a1286bd5be22fba67cd52157">interface::XFEventQueue</a>.</p>
</div>
</div>
<a id="a53d5e0eca81e14bba6c9b9b75b0e5566" name="a53d5e0eca81e14bba6c9b9b75b0e5566"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53d5e0eca81e14bba6c9b9b75b0e5566">&#9670;&nbsp;</a></span>pend() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XFEventQueue::pend </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait for the next event to arrive. Returns true if an event is in the queue. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_event_queue.html#af7bd7c5d6fa604536de8249f897013c4">interface::XFEventQueue</a>.</p>
</div>
</div>
<a id="a53d5e0eca81e14bba6c9b9b75b0e5566" name="a53d5e0eca81e14bba6c9b9b75b0e5566"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53d5e0eca81e14bba6c9b9b75b0e5566">&#9670;&nbsp;</a></span>pend() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XFEventQueue::pend </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait for the next event to arrive. Returns true if an event is in the queue. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_event_queue.html#af7bd7c5d6fa604536de8249f897013c4">interface::XFEventQueue</a>.</p>
</div>
</div>
<a id="a40671cbd4b5731daea332eb3c6844e71" name="a40671cbd4b5731daea332eb3c6844e71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40671cbd4b5731daea332eb3c6844e71">&#9670;&nbsp;</a></span>pop() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFEventQueue::pop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pops the next event from the queue. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_event_queue.html#a7f231860c5c4abdabe6db23f0dc0df66">interface::XFEventQueue</a>.</p>
</div>
</div>
<a id="a40671cbd4b5731daea332eb3c6844e71" name="a40671cbd4b5731daea332eb3c6844e71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40671cbd4b5731daea332eb3c6844e71">&#9670;&nbsp;</a></span>pop() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFEventQueue::pop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pops the next event from the queue. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_event_queue.html#a7f231860c5c4abdabe6db23f0dc0df66">interface::XFEventQueue</a>.</p>
</div>
</div>
<a id="ab164fbfa8ad7b5c75194b2b0e8caecc4" name="ab164fbfa8ad7b5c75194b2b0e8caecc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab164fbfa8ad7b5c75194b2b0e8caecc4">&#9670;&nbsp;</a></span>push() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XFEventQueue::push </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_x_f_event.html">XFEvent</a> *&#160;</td>
<td class="paramname"><em>pEvent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>fromISR</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pushes the given event onto the queue. Returns false if the event could not be pushed. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_event_queue.html#afe428e2ae5a3447a593b043c6c592e42">interface::XFEventQueue</a>.</p>
</div>
</div>
<a id="ab164fbfa8ad7b5c75194b2b0e8caecc4" name="ab164fbfa8ad7b5c75194b2b0e8caecc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab164fbfa8ad7b5c75194b2b0e8caecc4">&#9670;&nbsp;</a></span>push() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XFEventQueue::push </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_x_f_event.html">XFEvent</a> *&#160;</td>
<td class="paramname"><em>pEvent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>fromISR</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pushes the given event onto the queue. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_event_queue.html#afe428e2ae5a3447a593b043c6c592e42">interface::XFEventQueue</a>.</p>
</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/src/simplified/xf/port/idf-qt/<a class="el" href="port_2idf-qt_2eventqueue_8h_source.html">eventqueue.h</a></li>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/port/idf-stm32/<a class="el" href="port_2idf-stm32_2eventqueue_8h_source.html">eventqueue.h</a></li>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/port/idf-qt/eventqueue.cpp</li>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/port/idf-stm32/eventqueue.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

6
src/simplified/xf/doxygen/output/html/class_x_f_event_queue__coll__graph.map Normal file
View File

@ -0,0 +1,6 @@
<map id="XFEventQueue" name="XFEventQueue">
<area shape="rect" id="node1" title="Default Qt implementation for the XFEventQueue interface." alt="" coords="20,448,156,731"/>
<area shape="rect" id="node2" href="$classinterface_1_1_x_f_event_queue.html" title="Interface to be implemented by the event queue." alt="" coords="5,213,171,378"/>
<area shape="rect" id="node3" href="$class_x_f_mutex.html" title="Default Qt implementation for the XFMutex interface." alt="" coords="195,205,290,385"/>
<area shape="rect" id="node4" href="$classinterface_1_1_x_f_mutex.html" title="Mutex interface needed by the XF to access a mutex." alt="" coords="177,5,308,156"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_event_queue__coll__graph.md5 Normal file
View File

@ -0,0 +1 @@
0a7bb316315ef242e55bfd2b7ba96d03

BIN
src/simplified/xf/doxygen/output/html/class_x_f_event_queue__coll__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

4
src/simplified/xf/doxygen/output/html/class_x_f_event_queue__inherit__graph.map Normal file
View File

@ -0,0 +1,4 @@
<map id="XFEventQueue" name="XFEventQueue">
<area shape="rect" id="node1" title="Default Qt implementation for the XFEventQueue interface." alt="" coords="20,219,156,531"/>
<area shape="rect" id="node2" href="$classinterface_1_1_x_f_event_queue.html" title="Interface to be implemented by the event queue." alt="" coords="5,5,171,171"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_event_queue__inherit__graph.md5 Normal file
View File

@ -0,0 +1 @@
58089606e5401c3fa769907b2cce73c4

BIN
src/simplified/xf/doxygen/output/html/class_x_f_event_queue__inherit__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.4 KiB

88
src/simplified/xf/doxygen/output/html/class_x_f_event_status-members.html Normal file
View File

@ -0,0 +1,88 @@
<!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>Simplified XF: Member List</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">Simplified XF<span id="projectnumber">&#160;1.1.0</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="headertitle"><div class="title">XFEventStatus Member List</div></div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_x_f_event_status.html">XFEventStatus</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520fafa48367d81ae56e4a4312c172fc3bddc">Consumed</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event_status.html">XFEventStatus</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520f">eEventStatus</a> enum name</td><td class="entry"><a class="el" href="class_x_f_event_status.html">XFEventStatus</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event_status.html#a24123948f7c56f793e75cfa51a7199cf">is</a>(const eEventStatus eventStatus) const</td><td class="entry"><a class="el" href="class_x_f_event_status.html">XFEventStatus</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520fa619ade43444917a3cbbd0d806614a007">NotConsumed</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event_status.html">XFEventStatus</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event_status.html#a46751b6a5a371e38a3aa5b049a1de813">operator==</a>(const XFEventStatus::eEventStatus &amp;eventStatus) const</td><td class="entry"><a class="el" href="class_x_f_event_status.html">XFEventStatus</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event_status.html#a5782bdf58db36d8f09ce936f23129004">operator|=</a>(const XFEventStatus &amp;eventStatus)</td><td class="entry"><a class="el" href="class_x_f_event_status.html">XFEventStatus</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520fa70119b07e0f3b80171c74eb4abf29dea">RegionFinished</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event_status.html">XFEventStatus</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event_status.html#a44a906459a1d26817a6eceb46c6514f7">status_</a></td><td class="entry"><a class="el" href="class_x_f_event_status.html">XFEventStatus</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520fa8d3b26da0a8fd77cdb2af2e9a18d954b">Terminate</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event_status.html">XFEventStatus</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>Unknown</b> enum value (defined in <a class="el" href="class_x_f_event_status.html">XFEventStatus</a>)</td><td class="entry"><a class="el" href="class_x_f_event_status.html">XFEventStatus</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event_status.html#a5d94f7b57653a3a30d0d66a4114e994f">XFEventStatus</a>(eEventStatus eventStatus=Unknown)</td><td class="entry"><a class="el" href="class_x_f_event_status.html">XFEventStatus</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

251
src/simplified/xf/doxygen/output/html/class_x_f_event_status.html Normal file
View File

@ -0,0 +1,251 @@
<!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>Simplified XF: XFEventStatus 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">Simplified XF<span id="projectnumber">&#160;1.1.0</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-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_x_f_event_status-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">XFEventStatus Class Reference<div class="ingroups"><a class="el" href="group__xf__core.html">XF Core Classes</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Event status returned after event processing.
<a href="class_x_f_event_status.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="eventstatus_8h_source.html">eventstatus.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for XFEventStatus:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_event_status__coll__graph.png" border="0" usemap="#a_x_f_event_status_coll__map" alt="Collaboration graph"/></div>
<map name="a_x_f_event_status_coll__map" id="a_x_f_event_status_coll__map">
<area shape="rect" title="Event status returned after event processing." alt="" coords="5,5,132,127"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac34e2c129013264955388a63de39520f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520f">eEventStatus</a> { <br />
&#160;&#160;<b>Unknown</b> = 0
, <a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520fafa48367d81ae56e4a4312c172fc3bddc">Consumed</a> = 0x0001
, <a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520fa619ade43444917a3cbbd0d806614a007">NotConsumed</a> = 0x0002
, <a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520fa70119b07e0f3b80171c74eb4abf29dea">RegionFinished</a> = 0x0004
, <br />
&#160;&#160;<a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520fa8d3b26da0a8fd77cdb2af2e9a18d954b">Terminate</a> = 0x0008
<br />
}</td></tr>
<tr class="separator:ac34e2c129013264955388a63de39520f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a5d94f7b57653a3a30d0d66a4114e994f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event_status.html#a5d94f7b57653a3a30d0d66a4114e994f">XFEventStatus</a> (<a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520f">eEventStatus</a> eventStatus=Unknown)</td></tr>
<tr class="separator:a5d94f7b57653a3a30d0d66a4114e994f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46751b6a5a371e38a3aa5b049a1de813"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event_status.html#a46751b6a5a371e38a3aa5b049a1de813">operator==</a> (const <a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520f">XFEventStatus::eEventStatus</a> &amp;eventStatus) const</td></tr>
<tr class="separator:a46751b6a5a371e38a3aa5b049a1de813"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5782bdf58db36d8f09ce936f23129004"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event_status.html#a5782bdf58db36d8f09ce936f23129004">operator|=</a> (const <a class="el" href="class_x_f_event_status.html">XFEventStatus</a> &amp;eventStatus)</td></tr>
<tr class="memdesc:a5782bdf58db36d8f09ce936f23129004"><td class="mdescLeft">&#160;</td><td class="mdescRight">OR assignment. <a href="class_x_f_event_status.html#a5782bdf58db36d8f09ce936f23129004">More...</a><br /></td></tr>
<tr class="separator:a5782bdf58db36d8f09ce936f23129004"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24123948f7c56f793e75cfa51a7199cf"><td class="memItemLeft" align="right" valign="top"><a id="a24123948f7c56f793e75cfa51a7199cf" name="a24123948f7c56f793e75cfa51a7199cf"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>is</b> (const <a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520f">eEventStatus</a> eventStatus) const</td></tr>
<tr class="memdesc:a24123948f7c56f793e75cfa51a7199cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the given event status (r-value) is present in the actual (l-value). <br /></td></tr>
<tr class="separator:a24123948f7c56f793e75cfa51a7199cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a44a906459a1d26817a6eceb46c6514f7"><td class="memItemLeft" align="right" valign="top"><a id="a44a906459a1d26817a6eceb46c6514f7" name="a44a906459a1d26817a6eceb46c6514f7"></a>
<a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520f">eEventStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><b>status_</b></td></tr>
<tr class="memdesc:a44a906459a1d26817a6eceb46c6514f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attribute containing the status of the event. <br /></td></tr>
<tr class="separator:a44a906459a1d26817a6eceb46c6514f7"><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 >Event status returned after event processing. </p>
<p >The <a class="el" href="class_x_f_event_status.html" title="Event status returned after event processing.">XFEventStatus</a> is used after consumption of an event. It gives an information on how the event was consument and how the framework should react. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ac34e2c129013264955388a63de39520f" name="ac34e2c129013264955388a63de39520f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac34e2c129013264955388a63de39520f">&#9670;&nbsp;</a></span>eEventStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520f">XFEventStatus::eEventStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p >Status values about the event processed.</p>
<dl class="section see"><dt>See also</dt><dd>XFBehavior::process </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac34e2c129013264955388a63de39520fafa48367d81ae56e4a4312c172fc3bddc" name="ac34e2c129013264955388a63de39520fafa48367d81ae56e4a4312c172fc3bddc"></a>Consumed&#160;</td><td class="fielddoc"><p >Event consumed. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac34e2c129013264955388a63de39520fa619ade43444917a3cbbd0d806614a007" name="ac34e2c129013264955388a63de39520fa619ade43444917a3cbbd0d806614a007"></a>NotConsumed&#160;</td><td class="fielddoc"><p >Event not consumed. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac34e2c129013264955388a63de39520fa70119b07e0f3b80171c74eb4abf29dea" name="ac34e2c129013264955388a63de39520fa70119b07e0f3b80171c74eb4abf29dea"></a>RegionFinished&#160;</td><td class="fielddoc"><p >Composite state machine finished. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac34e2c129013264955388a63de39520fa8d3b26da0a8fd77cdb2af2e9a18d954b" name="ac34e2c129013264955388a63de39520fa8d3b26da0a8fd77cdb2af2e9a18d954b"></a>Terminate&#160;</td><td class="fielddoc"><p >Terminate state machine. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5d94f7b57653a3a30d0d66a4114e994f" name="a5d94f7b57653a3a30d0d66a4114e994f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d94f7b57653a3a30d0d66a4114e994f">&#9670;&nbsp;</a></span>XFEventStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">XFEventStatus::XFEventStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520f">eEventStatus</a>&#160;</td>
<td class="paramname"><em>eventStatus</em> = <code>Unknown</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Constructor</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eventStatus</td><td>Initial value of the event status. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a46751b6a5a371e38a3aa5b049a1de813" name="a46751b6a5a371e38a3aa5b049a1de813"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46751b6a5a371e38a3aa5b049a1de813">&#9670;&nbsp;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XFEventStatus::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_x_f_event_status.html#ac34e2c129013264955388a63de39520f">XFEventStatus::eEventStatus</a> &amp;&#160;</td>
<td class="paramname"><em>eventStatus</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Checks if both variables contain the same event status. </p>
</div>
</div>
<a id="a5782bdf58db36d8f09ce936f23129004" name="a5782bdf58db36d8f09ce936f23129004"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5782bdf58db36d8f09ce936f23129004">&#9670;&nbsp;</a></span>operator|=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFEventStatus::operator|= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_x_f_event_status.html">XFEventStatus</a> &amp;&#160;</td>
<td class="paramname"><em>eventStatus</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>OR assignment. </p>
<p >OR's the right event status with the left event status. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/include/xf/<a class="el" href="eventstatus_8h_source.html">eventstatus.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

3
src/simplified/xf/doxygen/output/html/class_x_f_event_status__coll__graph.map Normal file
View File

@ -0,0 +1,3 @@
<map id="XFEventStatus" name="XFEventStatus">
<area shape="rect" id="node1" title="Event status returned after event processing." alt="" coords="5,5,132,127"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_event_status__coll__graph.md5 Normal file
View File

@ -0,0 +1 @@
19bfc5b1346f63d2d80d6fa5a3d5a33d

BIN
src/simplified/xf/doxygen/output/html/class_x_f_event_status__coll__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.3 KiB

94
src/simplified/xf/doxygen/output/html/class_x_f_initial_event-members.html Normal file
View File

@ -0,0 +1,94 @@
<!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>Simplified XF: Member List</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">Simplified XF<span id="projectnumber">&#160;1.1.0</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="headertitle"><div class="title">XFInitialEvent Member List</div></div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_x_f_initial_event.html">XFInitialEvent</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4e9bf5642755f9677aa9c4c415a3bcba">DefaultTransition</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_initial_event.html#a0a2ab8ade826467db2fe796a663031fe">deleteAfterConsume</a>() const override</td><td class="entry"><a class="el" href="class_x_f_initial_event.html">XFInitialEvent</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4eefc024e7a72ce987c701013de3e100">Event</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a7b72b2c1edd9fba697b0bccbab3ed350">eventType_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">getBehavior</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">getEventType</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a33fdd5cc665f6224e803146d6b7ef9f6">getId</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#ae481937e76c817d67f704bfbc3ed2e30">id_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adc2df751813b38295784e246f9fe230e">Initial</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a1ec81ab9c537d5474cea2078d0d090e5">pBehavior_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#abbf3ce3d2bd6533c77900672a195320d">setBehavior</a>(interface::XFBehavior *pBehavior)</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a04f01a94d013ac0b3cd810b556427496">Timeout</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adfc2ad39d30f7a5df70c664bb2e24542">Unknown</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">XFEvent</a>(XFEventType eventType, int id=0)</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> enum name</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>XFInitialEvent</b>() (defined in <a class="el" href="class_x_f_initial_event.html">XFInitialEvent</a>)</td><td class="entry"><a class="el" href="class_x_f_initial_event.html">XFInitialEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a81e1850b46acd477ea5a9475e12e3e1e">~XFEvent</a>()</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

193
src/simplified/xf/doxygen/output/html/class_x_f_initial_event.html Normal file
View File

@ -0,0 +1,193 @@
<!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>Simplified XF: XFInitialEvent 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">Simplified XF<span id="projectnumber">&#160;1.1.0</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="class_x_f_initial_event-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">XFInitialEvent Class Reference<div class="ingroups"><a class="el" href="group__xf__core.html">XF Core Classes</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Initial event to start a behavior.
<a href="class_x_f_initial_event.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="initialevent_8h_source.html">initialevent.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for XFInitialEvent:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_initial_event__inherit__graph.png" border="0" usemap="#a_x_f_initial_event_inherit__map" alt="Inheritance graph"/></div>
<map name="a_x_f_initial_event_inherit__map" id="a_x_f_initial_event_inherit__map">
<area shape="rect" title="Initial event to start a behavior." alt="" coords="5,248,165,340"/>
<area shape="rect" href="class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="5,5,165,200"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for XFInitialEvent:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_initial_event__coll__graph.png" border="0" usemap="#a_x_f_initial_event_coll__map" alt="Collaboration graph"/></div>
<map name="a_x_f_initial_event_coll__map" id="a_x_f_initial_event_coll__map">
<area shape="rect" title="Initial event to start a behavior." alt="" coords="11,463,171,555"/>
<area shape="rect" href="class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="11,233,171,413"/>
<area shape="rect" href="classinterface_1_1_x_f_behavior.html" title="Interface to receive and process events." alt="" coords="5,5,177,171"/>
</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:a0a2ab8ade826467db2fe796a663031fe"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_initial_event.html#a0a2ab8ade826467db2fe796a663031fe">deleteAfterConsume</a> () const override</td></tr>
<tr class="memdesc:a0a2ab8ade826467db2fe796a663031fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <a class="el" href="class_x_f_event.html" title="Base class for all types of events and timeouts.">XFEvent</a>. <a href="class_x_f_initial_event.html#a0a2ab8ade826467db2fe796a663031fe">More...</a><br /></td></tr>
<tr class="separator:a0a2ab8ade826467db2fe796a663031fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_x_f_event"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_x_f_event')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_x_f_event.html">XFEvent</a></td></tr>
<tr class="memitem:af17823d5915a117da46e571a3fa114b1 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">XFEvent</a> (<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> eventType, int id=0)</td></tr>
<tr class="memdesc:af17823d5915a117da46e571a3fa114b1 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard constructor. <a href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">More...</a><br /></td></tr>
<tr class="separator:af17823d5915a117da46e571a3fa114b1 inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81e1850b46acd477ea5a9475e12e3e1e inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a81e1850b46acd477ea5a9475e12e3e1e" name="a81e1850b46acd477ea5a9475e12e3e1e"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~XFEvent</b> ()</td></tr>
<tr class="memdesc:a81e1850b46acd477ea5a9475e12e3e1e inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class destructor. <br /></td></tr>
<tr class="separator:a81e1850b46acd477ea5a9475e12e3e1e inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abce814f103406c0a78cad6dd394ac567 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">getEventType</a> () const</td></tr>
<tr class="memdesc:abce814f103406c0a78cad6dd394ac567 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type of the event. <a href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">More...</a><br /></td></tr>
<tr class="separator:abce814f103406c0a78cad6dd394ac567 inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cc48cb3354298c94428032082840033 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">getBehavior</a> () const</td></tr>
<tr class="memdesc:a5cc48cb3354298c94428032082840033 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns pointer to behavioral class. <a href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">More...</a><br /></td></tr>
<tr class="separator:a5cc48cb3354298c94428032082840033 inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbf3ce3d2bd6533c77900672a195320d inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="abbf3ce3d2bd6533c77900672a195320d" name="abbf3ce3d2bd6533c77900672a195320d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setBehavior</b> (<a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *pBehavior)</td></tr>
<tr class="memdesc:abbf3ce3d2bd6533c77900672a195320d inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets pointer to behavioral class (see <a class="el" href="class_x_f_event.html#a1ec81ab9c537d5474cea2078d0d090e5" title="Pointer to behavioral class (ex. state-machine) processing the event.">pBehavior_</a>). Sets the behavior in which the event should be executed. <br /></td></tr>
<tr class="separator:abbf3ce3d2bd6533c77900672a195320d inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33fdd5cc665f6224e803146d6b7ef9f6 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a33fdd5cc665f6224e803146d6b7ef9f6" name="a33fdd5cc665f6224e803146d6b7ef9f6"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>getId</b> () const</td></tr>
<tr class="memdesc:a33fdd5cc665f6224e803146d6b7ef9f6 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <a class="el" href="class_x_f_event.html#ae481937e76c817d67f704bfbc3ed2e30" title="Event id to identify event in state-machine.">id_</a> identifying the event in the behaviors context. <br /></td></tr>
<tr class="separator:a33fdd5cc665f6224e803146d6b7ef9f6 inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_class_x_f_event"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_x_f_event')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="class_x_f_event.html">XFEvent</a></td></tr>
<tr class="memitem:a944826b381ee833ffddd30342088bf91 inherit pub_types_class_x_f_event"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> { <br />
&#160;&#160;<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adfc2ad39d30f7a5df70c664bb2e24542">Unknown</a> = 0
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adc2df751813b38295784e246f9fe230e">Initial</a> = 1
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4e9bf5642755f9677aa9c4c415a3bcba">DefaultTransition</a> = 2
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4eefc024e7a72ce987c701013de3e100">Event</a> = 3
, <br />
&#160;&#160;<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a04f01a94d013ac0b3cd810b556427496">Timeout</a> = 4
<br />
}</td></tr>
<tr class="separator:a944826b381ee833ffddd30342088bf91 inherit pub_types_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_x_f_event"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_x_f_event')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_x_f_event.html">XFEvent</a></td></tr>
<tr class="memitem:a7b72b2c1edd9fba697b0bccbab3ed350 inherit pro_attribs_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a7b72b2c1edd9fba697b0bccbab3ed350" name="a7b72b2c1edd9fba697b0bccbab3ed350"></a>
const <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a>&#160;</td><td class="memItemRight" valign="bottom"><b>eventType_</b></td></tr>
<tr class="memdesc:a7b72b2c1edd9fba697b0bccbab3ed350 inherit pro_attribs_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds the type of the event. <br /></td></tr>
<tr class="separator:a7b72b2c1edd9fba697b0bccbab3ed350 inherit pro_attribs_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae481937e76c817d67f704bfbc3ed2e30 inherit pro_attribs_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="ae481937e76c817d67f704bfbc3ed2e30" name="ae481937e76c817d67f704bfbc3ed2e30"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>id_</b></td></tr>
<tr class="memdesc:ae481937e76c817d67f704bfbc3ed2e30 inherit pro_attribs_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event id to identify event in state-machine. <br /></td></tr>
<tr class="separator:ae481937e76c817d67f704bfbc3ed2e30 inherit pro_attribs_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ec81ab9c537d5474cea2078d0d090e5 inherit pro_attribs_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a1ec81ab9c537d5474cea2078d0d090e5" name="a1ec81ab9c537d5474cea2078d0d090e5"></a>
<a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>pBehavior_</b></td></tr>
<tr class="memdesc:a1ec81ab9c537d5474cea2078d0d090e5 inherit pro_attribs_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to behavioral class (ex. state-machine) processing the event. <br /></td></tr>
<tr class="separator:a1ec81ab9c537d5474cea2078d0d090e5 inherit pro_attribs_class_x_f_event"><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 >Initial event to start a behavior. </p>
<p >Represents for example the first transition executed in a state machine. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a0a2ab8ade826467db2fe796a663031fe" name="a0a2ab8ade826467db2fe796a663031fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a2ab8ade826467db2fe796a663031fe">&#9670;&nbsp;</a></span>deleteAfterConsume()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XFInitialEvent::deleteAfterConsume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>See <a class="el" href="class_x_f_event.html" title="Base class for all types of events and timeouts.">XFEvent</a>. </p>
<p>Reimplemented from <a class="el" href="class_x_f_event.html#a917cec86b20ee75e768da336f5b18c70">XFEvent</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/include/xf/<a class="el" href="initialevent_8h_source.html">initialevent.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

5
src/simplified/xf/doxygen/output/html/class_x_f_initial_event__coll__graph.map Normal file
View File

@ -0,0 +1,5 @@
<map id="XFInitialEvent" name="XFInitialEvent">
<area shape="rect" id="node1" title="Initial event to start a behavior." alt="" coords="11,463,171,555"/>
<area shape="rect" id="node2" href="$class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="11,233,171,413"/>
<area shape="rect" id="node3" href="$classinterface_1_1_x_f_behavior.html" title="Interface to receive and process events." alt="" coords="5,5,177,171"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_initial_event__coll__graph.md5 Normal file
View File

@ -0,0 +1 @@
d964f4c1430e430f00f74a2a69513c8b

BIN
src/simplified/xf/doxygen/output/html/class_x_f_initial_event__coll__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.1 KiB

4
src/simplified/xf/doxygen/output/html/class_x_f_initial_event__inherit__graph.map Normal file
View File

@ -0,0 +1,4 @@
<map id="XFInitialEvent" name="XFInitialEvent">
<area shape="rect" id="node1" title="Initial event to start a behavior." alt="" coords="5,248,165,340"/>
<area shape="rect" id="node2" href="$class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="5,5,165,200"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_initial_event__inherit__graph.md5 Normal file
View File

@ -0,0 +1 @@
d9d7955c12ef07ba7eb030aa09637d8e

BIN
src/simplified/xf/doxygen/output/html/class_x_f_initial_event__inherit__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.2 KiB

90
src/simplified/xf/doxygen/output/html/class_x_f_mutex-members.html Normal file
View File

@ -0,0 +1,90 @@
<!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>Simplified XF: Member List</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">Simplified XF<span id="projectnumber">&#160;1.1.0</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="headertitle"><div class="title">XFMutex Member List</div></div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_x_f_mutex.html">XFMutex</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classinterface_1_1_x_f_mutex.html#a7f48fd9da6c5d4766cf60543d2e8d48d">create</a>()</td><td class="entry"><a class="el" href="classinterface_1_1_x_f_mutex.html">interface::XFMutex</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>interface::XFMutex</b> (defined in <a class="el" href="class_x_f_mutex.html">XFMutex</a>)</td><td class="entry"><a class="el" href="class_x_f_mutex.html">XFMutex</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_mutex.html#a0ba8e69809b734834831b483484a100c">lock</a>() override</td><td class="entry"><a class="el" href="class_x_f_mutex.html">XFMutex</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_mutex.html#a0ba8e69809b734834831b483484a100c">lock</a>() override</td><td class="entry"><a class="el" href="class_x_f_mutex.html">XFMutex</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_mutex.html#a9959f62c1c62d19cfb282400fe0e7509">mutex_</a></td><td class="entry"><a class="el" href="class_x_f_mutex.html">XFMutex</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_mutex.html#aa730a84538b386cae15b5c78f1a125af">tryLock</a>(int32_t timeout=0) override</td><td class="entry"><a class="el" href="class_x_f_mutex.html">XFMutex</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_mutex.html#aa730a84538b386cae15b5c78f1a125af">tryLock</a>(int32_t timeout=0) override</td><td class="entry"><a class="el" href="class_x_f_mutex.html">XFMutex</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_mutex.html#afc627db4f9392a9b47db64e670036b99">unlock</a>() override</td><td class="entry"><a class="el" href="class_x_f_mutex.html">XFMutex</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_mutex.html#afc627db4f9392a9b47db64e670036b99">unlock</a>() override</td><td class="entry"><a class="el" href="class_x_f_mutex.html">XFMutex</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>XFEventQueue</b> (defined in <a class="el" href="class_x_f_mutex.html">XFMutex</a>)</td><td class="entry"><a class="el" href="class_x_f_mutex.html">XFMutex</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_mutex.html#a89b72b33a9448fa8383860d9d3d64dcf">XFMutex</a>()=default</td><td class="entry"><a class="el" href="class_x_f_mutex.html">XFMutex</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_mutex.html#a89b72b33a9448fa8383860d9d3d64dcf">XFMutex</a>()=default</td><td class="entry"><a class="el" href="class_x_f_mutex.html">XFMutex</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~XFMutex</b>()=default (defined in <a class="el" href="classinterface_1_1_x_f_mutex.html">interface::XFMutex</a>)</td><td class="entry"><a class="el" href="classinterface_1_1_x_f_mutex.html">interface::XFMutex</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

346
src/simplified/xf/doxygen/output/html/class_x_f_mutex.html Normal file
View File

@ -0,0 +1,346 @@
<!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>Simplified XF: XFMutex 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">Simplified XF<span id="projectnumber">&#160;1.1.0</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-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="class_x_f_mutex-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">XFMutex Class Reference<div class="ingroups"><a class="el" href="group__port__idf__qt.html">IDF Qt Port Classes</a> &#124; <a class="el" href="group__port__idf__stm32.html">IDF STM32 Port Classes</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Default Qt implementation for the <a class="el" href="class_x_f_mutex.html" title="Default Qt implementation for the XFMutex interface.">XFMutex</a> interface.
<a href="class_x_f_mutex.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="port_2idf-qt_2mutex_8h_source.html">mutex.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for XFMutex:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_mutex__inherit__graph.png" border="0" usemap="#a_x_f_mutex_inherit__map" alt="Inheritance graph"/></div>
<map name="a_x_f_mutex_inherit__map" id="a_x_f_mutex_inherit__map">
<area shape="rect" title="Default Qt implementation for the XFMutex interface." alt="" coords="23,204,118,384"/>
<area shape="rect" href="classinterface_1_1_x_f_mutex.html" title="Mutex interface needed by the XF to access a mutex." alt="" coords="5,5,136,156"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for XFMutex:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_mutex__coll__graph.png" border="0" usemap="#a_x_f_mutex_coll__map" alt="Collaboration graph"/></div>
<map name="a_x_f_mutex_coll__map" id="a_x_f_mutex_coll__map">
<area shape="rect" title="Default Qt implementation for the XFMutex interface." alt="" coords="23,204,118,384"/>
<area shape="rect" href="classinterface_1_1_x_f_mutex.html" title="Mutex interface needed by the XF to access a mutex." alt="" coords="5,5,136,156"/>
</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:a0ba8e69809b734834831b483484a100c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_mutex.html#a0ba8e69809b734834831b483484a100c">lock</a> () override</td></tr>
<tr class="memdesc:a0ba8e69809b734834831b483484a100c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocks until the mutex becomes available. <a href="class_x_f_mutex.html#a0ba8e69809b734834831b483484a100c">More...</a><br /></td></tr>
<tr class="separator:a0ba8e69809b734834831b483484a100c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc627db4f9392a9b47db64e670036b99"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_mutex.html#afc627db4f9392a9b47db64e670036b99">unlock</a> () override</td></tr>
<tr class="memdesc:afc627db4f9392a9b47db64e670036b99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases the mutex so it can be taken by other threads. <a href="class_x_f_mutex.html#afc627db4f9392a9b47db64e670036b99">More...</a><br /></td></tr>
<tr class="separator:afc627db4f9392a9b47db64e670036b99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa730a84538b386cae15b5c78f1a125af"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_mutex.html#aa730a84538b386cae15b5c78f1a125af">tryLock</a> (int32_t timeout=0) override</td></tr>
<tr class="memdesc:aa730a84538b386cae15b5c78f1a125af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tries to get the mutex. <a href="class_x_f_mutex.html#aa730a84538b386cae15b5c78f1a125af">More...</a><br /></td></tr>
<tr class="separator:aa730a84538b386cae15b5c78f1a125af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ba8e69809b734834831b483484a100c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_mutex.html#a0ba8e69809b734834831b483484a100c">lock</a> () override</td></tr>
<tr class="memdesc:a0ba8e69809b734834831b483484a100c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocks until the mutex becomes available. <a href="class_x_f_mutex.html#a0ba8e69809b734834831b483484a100c">More...</a><br /></td></tr>
<tr class="separator:a0ba8e69809b734834831b483484a100c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc627db4f9392a9b47db64e670036b99"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_mutex.html#afc627db4f9392a9b47db64e670036b99">unlock</a> () override</td></tr>
<tr class="memdesc:afc627db4f9392a9b47db64e670036b99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases the mutex so it can be taken by other threads. <a href="class_x_f_mutex.html#afc627db4f9392a9b47db64e670036b99">More...</a><br /></td></tr>
<tr class="separator:afc627db4f9392a9b47db64e670036b99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa730a84538b386cae15b5c78f1a125af"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_mutex.html#aa730a84538b386cae15b5c78f1a125af">tryLock</a> (int32_t timeout=0) override</td></tr>
<tr class="memdesc:aa730a84538b386cae15b5c78f1a125af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tries to get the mutex. <a href="class_x_f_mutex.html#aa730a84538b386cae15b5c78f1a125af">More...</a><br /></td></tr>
<tr class="separator:aa730a84538b386cae15b5c78f1a125af"><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:a89b72b33a9448fa8383860d9d3d64dcf"><td class="memItemLeft" align="right" valign="top"><a id="a89b72b33a9448fa8383860d9d3d64dcf" name="a89b72b33a9448fa8383860d9d3d64dcf"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>XFMutex</b> ()=default</td></tr>
<tr class="memdesc:a89b72b33a9448fa8383860d9d3d64dcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Do not allow to directly create an object of this class. Call <a class="el" href="classinterface_1_1_x_f_mutex.html#a7f48fd9da6c5d4766cf60543d2e8d48d" title="Creates and returns a new mutex instance.">interface::XFMutex::create()</a> instead. <br /></td></tr>
<tr class="separator:a89b72b33a9448fa8383860d9d3d64dcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89b72b33a9448fa8383860d9d3d64dcf"><td class="memItemLeft" align="right" valign="top"><a id="a89b72b33a9448fa8383860d9d3d64dcf" name="a89b72b33a9448fa8383860d9d3d64dcf"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>XFMutex</b> ()=default</td></tr>
<tr class="memdesc:a89b72b33a9448fa8383860d9d3d64dcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Do not allow to directly create an object of this class. Call <a class="el" href="classinterface_1_1_x_f_mutex.html#a7f48fd9da6c5d4766cf60543d2e8d48d" title="Creates and returns a new mutex instance.">interface::XFMutex::create()</a> instead. <br /></td></tr>
<tr class="separator:a89b72b33a9448fa8383860d9d3d64dcf"><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:a9959f62c1c62d19cfb282400fe0e7509"><td class="memItemLeft" align="right" valign="top"><a id="a9959f62c1c62d19cfb282400fe0e7509" name="a9959f62c1c62d19cfb282400fe0e7509"></a>
QMutex&#160;</td><td class="memItemRight" valign="bottom"><b>mutex_</b></td></tr>
<tr class="memdesc:a9959f62c1c62d19cfb282400fe0e7509"><td class="mdescLeft">&#160;</td><td class="mdescRight">The real mutex. <br /></td></tr>
<tr class="separator:a9959f62c1c62d19cfb282400fe0e7509"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a124fc9886b5bd5d0066b289ab1c871d3"><td class="memItemLeft" align="right" valign="top"><a id="a124fc9886b5bd5d0066b289ab1c871d3" name="a124fc9886b5bd5d0066b289ab1c871d3"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>interface::XFMutex</b></td></tr>
<tr class="separator:a124fc9886b5bd5d0066b289ab1c871d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf77680ef65e279e9c666d1d94d89190"><td class="memItemLeft" align="right" valign="top"><a id="aaf77680ef65e279e9c666d1d94d89190" name="aaf77680ef65e279e9c666d1d94d89190"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>XFEventQueue</b></td></tr>
<tr class="separator:aaf77680ef65e279e9c666d1d94d89190"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classinterface_1_1_x_f_mutex"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classinterface_1_1_x_f_mutex')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classinterface_1_1_x_f_mutex.html">interface::XFMutex</a></td></tr>
<tr class="memitem:a7f48fd9da6c5d4766cf60543d2e8d48d inherit pub_static_methods_classinterface_1_1_x_f_mutex"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classinterface_1_1_x_f_mutex.html">XFMutex</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classinterface_1_1_x_f_mutex.html#a7f48fd9da6c5d4766cf60543d2e8d48d">create</a> ()</td></tr>
<tr class="memdesc:a7f48fd9da6c5d4766cf60543d2e8d48d inherit pub_static_methods_classinterface_1_1_x_f_mutex"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates and returns a new mutex instance. <a href="classinterface_1_1_x_f_mutex.html#a7f48fd9da6c5d4766cf60543d2e8d48d">More...</a><br /></td></tr>
<tr class="separator:a7f48fd9da6c5d4766cf60543d2e8d48d inherit pub_static_methods_classinterface_1_1_x_f_mutex"><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 >Default Qt implementation for the <a class="el" href="class_x_f_mutex.html" title="Default Qt implementation for the XFMutex interface.">XFMutex</a> interface. </p>
<p >Default IDF implementation <a class="el" href="class_x_f_mutex.html" title="Default Qt implementation for the XFMutex interface.">XFMutex</a> interface.</p>
<p >This class uses <code>enterCritical()</code> and <code>exitCritical()</code> functions which must be provided by the platform. Therefore, this mutex implementation can be used in Embedded Systems without OS. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a0ba8e69809b734834831b483484a100c" name="a0ba8e69809b734834831b483484a100c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ba8e69809b734834831b483484a100c">&#9670;&nbsp;</a></span>lock() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFMutex::lock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Blocks until the mutex becomes available. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_mutex.html#a37b990e79385bae3fa7fab35a86c75b3">interface::XFMutex</a>.</p>
</div>
</div>
<a id="a0ba8e69809b734834831b483484a100c" name="a0ba8e69809b734834831b483484a100c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ba8e69809b734834831b483484a100c">&#9670;&nbsp;</a></span>lock() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFMutex::lock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Blocks until the mutex becomes available. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_mutex.html#a37b990e79385bae3fa7fab35a86c75b3">interface::XFMutex</a>.</p>
</div>
</div>
<a id="aa730a84538b386cae15b5c78f1a125af" name="aa730a84538b386cae15b5c78f1a125af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa730a84538b386cae15b5c78f1a125af">&#9670;&nbsp;</a></span>tryLock() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XFMutex::tryLock </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>timeout</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to get the mutex. </p>
<p >If timeout is 0 method will leave immediately and then the return parameter indicates it the mutex could be taken or not. Giving a negative value will block the thread until the mutex becomes available. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_mutex.html#ac90bb5e91af283dbd68f150d92a1cccf">interface::XFMutex</a>.</p>
</div>
</div>
<a id="aa730a84538b386cae15b5c78f1a125af" name="aa730a84538b386cae15b5c78f1a125af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa730a84538b386cae15b5c78f1a125af">&#9670;&nbsp;</a></span>tryLock() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XFMutex::tryLock </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>timeout</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to get the mutex. </p>
<p >If timeout is 0 method will leave immediately and then the return parameter indicates it the mutex could be taken or not. Giving a negative value will block the thread until the mutex becomes available. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_mutex.html#ac90bb5e91af283dbd68f150d92a1cccf">interface::XFMutex</a>.</p>
</div>
</div>
<a id="afc627db4f9392a9b47db64e670036b99" name="afc627db4f9392a9b47db64e670036b99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc627db4f9392a9b47db64e670036b99">&#9670;&nbsp;</a></span>unlock() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFMutex::unlock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases the mutex so it can be taken by other threads. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_mutex.html#a201ab90921e662591f0623155f986834">interface::XFMutex</a>.</p>
</div>
</div>
<a id="afc627db4f9392a9b47db64e670036b99" name="afc627db4f9392a9b47db64e670036b99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc627db4f9392a9b47db64e670036b99">&#9670;&nbsp;</a></span>unlock() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XFMutex::unlock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases the mutex so it can be taken by other threads. </p>
<p>Implements <a class="el" href="classinterface_1_1_x_f_mutex.html#a201ab90921e662591f0623155f986834">interface::XFMutex</a>.</p>
</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/src/simplified/xf/port/idf-qt/<a class="el" href="port_2idf-qt_2mutex_8h_source.html">mutex.h</a></li>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/port/idf-stm32/<a class="el" href="port_2idf-stm32_2mutex_8h_source.html">mutex.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

4
src/simplified/xf/doxygen/output/html/class_x_f_mutex__coll__graph.map Normal file
View File

@ -0,0 +1,4 @@
<map id="XFMutex" name="XFMutex">
<area shape="rect" id="node1" title="Default Qt implementation for the XFMutex interface." alt="" coords="23,204,118,384"/>
<area shape="rect" id="node2" href="$classinterface_1_1_x_f_mutex.html" title="Mutex interface needed by the XF to access a mutex." alt="" coords="5,5,136,156"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_mutex__coll__graph.md5 Normal file
View File

@ -0,0 +1 @@
15247caabaafe4359efd9fc1693941f2

BIN
src/simplified/xf/doxygen/output/html/class_x_f_mutex__coll__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.4 KiB

4
src/simplified/xf/doxygen/output/html/class_x_f_mutex__inherit__graph.map Normal file
View File

@ -0,0 +1,4 @@
<map id="XFMutex" name="XFMutex">
<area shape="rect" id="node1" title="Default Qt implementation for the XFMutex interface." alt="" coords="23,204,118,384"/>
<area shape="rect" id="node2" href="$classinterface_1_1_x_f_mutex.html" title="Mutex interface needed by the XF to access a mutex." alt="" coords="5,5,136,156"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_mutex__inherit__graph.md5 Normal file
View File

@ -0,0 +1 @@
15247caabaafe4359efd9fc1693941f2

BIN
src/simplified/xf/doxygen/output/html/class_x_f_mutex__inherit__graph.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.4 KiB

103
src/simplified/xf/doxygen/output/html/class_x_f_timeout-members.html Normal file
View File

@ -0,0 +1,103 @@
<!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>Simplified XF: Member List</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">Simplified XF<span id="projectnumber">&#160;1.1.0</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="headertitle"><div class="title">XFTimeout Member List</div></div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="class_x_f_timeout.html">XFTimeout</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_x_f_timeout.html#af95f95b9c6f48f2bcafc4f0e8bed6b6d">addToRelTicks</a>(int ticksToAdd)</td><td class="entry"><a class="el" href="class_x_f_timeout.html">XFTimeout</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4e9bf5642755f9677aa9c4c415a3bcba">DefaultTransition</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_timeout.html#a0d4154698f3337e7181a5f3455a16a93">deleteAfterConsume</a>() const override</td><td class="entry"><a class="el" href="class_x_f_timeout.html">XFTimeout</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4eefc024e7a72ce987c701013de3e100">Event</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a7b72b2c1edd9fba697b0bccbab3ed350">eventType_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">getBehavior</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">getEventType</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a33fdd5cc665f6224e803146d6b7ef9f6">getId</a>() const</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_timeout.html#a24112378919076ab91bc898564749b0f">getInterval</a>() const</td><td class="entry"><a class="el" href="class_x_f_timeout.html">XFTimeout</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_timeout.html#a3e6ade37aa4ffc14312ec63a1cbb49db">getRelTicks</a>() const</td><td class="entry"><a class="el" href="class_x_f_timeout.html">XFTimeout</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#ae481937e76c817d67f704bfbc3ed2e30">id_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adc2df751813b38295784e246f9fe230e">Initial</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>interface::XFTimeoutManager</b> (defined in <a class="el" href="class_x_f_timeout.html">XFTimeout</a>)</td><td class="entry"><a class="el" href="class_x_f_timeout.html">XFTimeout</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_timeout.html#afc6c70ad70b7ec81bb66c6f61f217013">interval_</a></td><td class="entry"><a class="el" href="class_x_f_timeout.html">XFTimeout</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_timeout.html#a6b82c572dab611bf18175fe502b22181">operator==</a>(const XFTimeout &amp;timeout) const</td><td class="entry"><a class="el" href="class_x_f_timeout.html">XFTimeout</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a1ec81ab9c537d5474cea2078d0d090e5">pBehavior_</a></td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_timeout.html#a43cbab239bd4636142f078e9335f05eb">relTicks_</a></td><td class="entry"><a class="el" href="class_x_f_timeout.html">XFTimeout</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#abbf3ce3d2bd6533c77900672a195320d">setBehavior</a>(interface::XFBehavior *pBehavior)</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_timeout.html#ae0b2beefd067a4c84f1c37b9cf04fab2">setRelTicks</a>(int relTicks)</td><td class="entry"><a class="el" href="class_x_f_timeout.html">XFTimeout</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_timeout.html#afe1d6c0d58e92c2c1cfc12e0906d8bb1">substractFromRelTicks</a>(int ticksToSubstract)</td><td class="entry"><a class="el" href="class_x_f_timeout.html">XFTimeout</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a04f01a94d013ac0b3cd810b556427496">Timeout</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adfc2ad39d30f7a5df70c664bb2e24542">Unknown</a> enum value</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">XFEvent</a>(XFEventType eventType, int id=0)</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> enum name</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_x_f_timeout.html#a04d1affe5a2667165f27dcad094ba5bb">XFTimeout</a>(int id, int interval, interface::XFBehavior *pBehavior=nullptr)</td><td class="entry"><a class="el" href="class_x_f_timeout.html">XFTimeout</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_x_f_event.html#a81e1850b46acd477ea5a9475e12e3e1e">~XFEvent</a>()</td><td class="entry"><a class="el" href="class_x_f_event.html">XFEvent</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

300
src/simplified/xf/doxygen/output/html/class_x_f_timeout.html Normal file
View File

@ -0,0 +1,300 @@
<!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>Simplified XF: XFTimeout 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">Simplified XF<span id="projectnumber">&#160;1.1.0</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-attribs">Protected Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="class_x_f_timeout-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">XFTimeout Class Reference<div class="ingroups"><a class="el" href="group__xf__core.html">XF Core Classes</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Used by the TimeoutManager to create and handle a timeout.
<a href="class_x_f_timeout.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="timeout_8h_source.html">timeout.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for XFTimeout:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_timeout__inherit__graph.png" border="0" usemap="#a_x_f_timeout_inherit__map" alt="Inheritance graph"/></div>
<map name="a_x_f_timeout_inherit__map" id="a_x_f_timeout_inherit__map">
<area shape="rect" title="Used by the TimeoutManager to create and handle a timeout." alt="" coords="5,248,179,443"/>
<area shape="rect" href="class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="12,5,172,200"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for XFTimeout:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_f_timeout__coll__graph.png" border="0" usemap="#a_x_f_timeout_coll__map" alt="Collaboration graph"/></div>
<map name="a_x_f_timeout_coll__map" id="a_x_f_timeout_coll__map">
<area shape="rect" title="Used by the TimeoutManager to create and handle a timeout." alt="" coords="5,463,179,657"/>
<area shape="rect" href="class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="12,233,172,413"/>
<area shape="rect" href="classinterface_1_1_x_f_behavior.html" title="Interface to receive and process events." alt="" coords="6,5,178,171"/>
</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:a04d1affe5a2667165f27dcad094ba5bb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_timeout.html#a04d1affe5a2667165f27dcad094ba5bb">XFTimeout</a> (int id, int interval, <a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *pBehavior=nullptr)</td></tr>
<tr class="separator:a04d1affe5a2667165f27dcad094ba5bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b82c572dab611bf18175fe502b22181"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_timeout.html#a6b82c572dab611bf18175fe502b22181">operator==</a> (const <a class="el" href="class_x_f_timeout.html">XFTimeout</a> &amp;timeout) const</td></tr>
<tr class="separator:a6b82c572dab611bf18175fe502b22181"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d4154698f3337e7181a5f3455a16a93"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_timeout.html#a0d4154698f3337e7181a5f3455a16a93">deleteAfterConsume</a> () const override</td></tr>
<tr class="memdesc:a0d4154698f3337e7181a5f3455a16a93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tells the dispatcher if the event must be deleted or not. <a href="class_x_f_timeout.html#a0d4154698f3337e7181a5f3455a16a93">More...</a><br /></td></tr>
<tr class="separator:a0d4154698f3337e7181a5f3455a16a93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24112378919076ab91bc898564749b0f"><td class="memItemLeft" align="right" valign="top"><a id="a24112378919076ab91bc898564749b0f" name="a24112378919076ab91bc898564749b0f"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>getInterval</b> () const</td></tr>
<tr class="memdesc:a24112378919076ab91bc898564749b0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the timeout interval in milliseconds. <br /></td></tr>
<tr class="separator:a24112378919076ab91bc898564749b0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0b2beefd067a4c84f1c37b9cf04fab2"><td class="memItemLeft" align="right" valign="top"><a id="ae0b2beefd067a4c84f1c37b9cf04fab2" name="ae0b2beefd067a4c84f1c37b9cf04fab2"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setRelTicks</b> (int relTicks)</td></tr>
<tr class="memdesc:ae0b2beefd067a4c84f1c37b9cf04fab2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets remaining ticks. <br /></td></tr>
<tr class="separator:ae0b2beefd067a4c84f1c37b9cf04fab2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e6ade37aa4ffc14312ec63a1cbb49db"><td class="memItemLeft" align="right" valign="top"><a id="a3e6ade37aa4ffc14312ec63a1cbb49db" name="a3e6ade37aa4ffc14312ec63a1cbb49db"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>getRelTicks</b> () const</td></tr>
<tr class="memdesc:a3e6ade37aa4ffc14312ec63a1cbb49db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns remaining ticks. <br /></td></tr>
<tr class="separator:a3e6ade37aa4ffc14312ec63a1cbb49db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe1d6c0d58e92c2c1cfc12e0906d8bb1"><td class="memItemLeft" align="right" valign="top"><a id="afe1d6c0d58e92c2c1cfc12e0906d8bb1" name="afe1d6c0d58e92c2c1cfc12e0906d8bb1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>substractFromRelTicks</b> (int ticksToSubstract)</td></tr>
<tr class="memdesc:afe1d6c0d58e92c2c1cfc12e0906d8bb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Substracts <code>ticksToSubstract</code> from remaining ticks. <br /></td></tr>
<tr class="separator:afe1d6c0d58e92c2c1cfc12e0906d8bb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af95f95b9c6f48f2bcafc4f0e8bed6b6d"><td class="memItemLeft" align="right" valign="top"><a id="af95f95b9c6f48f2bcafc4f0e8bed6b6d" name="af95f95b9c6f48f2bcafc4f0e8bed6b6d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>addToRelTicks</b> (int ticksToAdd)</td></tr>
<tr class="memdesc:af95f95b9c6f48f2bcafc4f0e8bed6b6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds <code>ticksToAdd</code> to remaining ticks. <br /></td></tr>
<tr class="separator:af95f95b9c6f48f2bcafc4f0e8bed6b6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_x_f_event"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_x_f_event')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_x_f_event.html">XFEvent</a></td></tr>
<tr class="memitem:af17823d5915a117da46e571a3fa114b1 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">XFEvent</a> (<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> eventType, int id=0)</td></tr>
<tr class="memdesc:af17823d5915a117da46e571a3fa114b1 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard constructor. <a href="class_x_f_event.html#af17823d5915a117da46e571a3fa114b1">More...</a><br /></td></tr>
<tr class="separator:af17823d5915a117da46e571a3fa114b1 inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81e1850b46acd477ea5a9475e12e3e1e inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a81e1850b46acd477ea5a9475e12e3e1e" name="a81e1850b46acd477ea5a9475e12e3e1e"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~XFEvent</b> ()</td></tr>
<tr class="memdesc:a81e1850b46acd477ea5a9475e12e3e1e inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class destructor. <br /></td></tr>
<tr class="separator:a81e1850b46acd477ea5a9475e12e3e1e inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abce814f103406c0a78cad6dd394ac567 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">getEventType</a> () const</td></tr>
<tr class="memdesc:abce814f103406c0a78cad6dd394ac567 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type of the event. <a href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567">More...</a><br /></td></tr>
<tr class="separator:abce814f103406c0a78cad6dd394ac567 inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cc48cb3354298c94428032082840033 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">getBehavior</a> () const</td></tr>
<tr class="memdesc:a5cc48cb3354298c94428032082840033 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns pointer to behavioral class. <a href="class_x_f_event.html#a5cc48cb3354298c94428032082840033">More...</a><br /></td></tr>
<tr class="separator:a5cc48cb3354298c94428032082840033 inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbf3ce3d2bd6533c77900672a195320d inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="abbf3ce3d2bd6533c77900672a195320d" name="abbf3ce3d2bd6533c77900672a195320d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setBehavior</b> (<a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *pBehavior)</td></tr>
<tr class="memdesc:abbf3ce3d2bd6533c77900672a195320d inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets pointer to behavioral class (see <a class="el" href="class_x_f_event.html#a1ec81ab9c537d5474cea2078d0d090e5" title="Pointer to behavioral class (ex. state-machine) processing the event.">pBehavior_</a>). Sets the behavior in which the event should be executed. <br /></td></tr>
<tr class="separator:abbf3ce3d2bd6533c77900672a195320d inherit pub_methods_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33fdd5cc665f6224e803146d6b7ef9f6 inherit pub_methods_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a33fdd5cc665f6224e803146d6b7ef9f6" name="a33fdd5cc665f6224e803146d6b7ef9f6"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>getId</b> () const</td></tr>
<tr class="memdesc:a33fdd5cc665f6224e803146d6b7ef9f6 inherit pub_methods_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <a class="el" href="class_x_f_event.html#ae481937e76c817d67f704bfbc3ed2e30" title="Event id to identify event in state-machine.">id_</a> identifying the event in the behaviors context. <br /></td></tr>
<tr class="separator:a33fdd5cc665f6224e803146d6b7ef9f6 inherit pub_methods_class_x_f_event"><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:afc6c70ad70b7ec81bb66c6f61f217013"><td class="memItemLeft" align="right" valign="top"><a id="afc6c70ad70b7ec81bb66c6f61f217013" name="afc6c70ad70b7ec81bb66c6f61f217013"></a>
const int&#160;</td><td class="memItemRight" valign="bottom"><b>interval_</b></td></tr>
<tr class="memdesc:afc6c70ad70b7ec81bb66c6f61f217013"><td class="mdescLeft">&#160;</td><td class="mdescRight">Timeout interval in milliseconds. <br /></td></tr>
<tr class="separator:afc6c70ad70b7ec81bb66c6f61f217013"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43cbab239bd4636142f078e9335f05eb"><td class="memItemLeft" align="right" valign="top"><a id="a43cbab239bd4636142f078e9335f05eb" name="a43cbab239bd4636142f078e9335f05eb"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>relTicks_</b></td></tr>
<tr class="memdesc:a43cbab239bd4636142f078e9335f05eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used by the TimeoutManager to calculate remaining time (in milliseconds). Can get negative! <br /></td></tr>
<tr class="separator:a43cbab239bd4636142f078e9335f05eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_class_x_f_event"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_x_f_event')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_x_f_event.html">XFEvent</a></td></tr>
<tr class="memitem:a7b72b2c1edd9fba697b0bccbab3ed350 inherit pro_attribs_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a7b72b2c1edd9fba697b0bccbab3ed350" name="a7b72b2c1edd9fba697b0bccbab3ed350"></a>
const <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a>&#160;</td><td class="memItemRight" valign="bottom"><b>eventType_</b></td></tr>
<tr class="memdesc:a7b72b2c1edd9fba697b0bccbab3ed350 inherit pro_attribs_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds the type of the event. <br /></td></tr>
<tr class="separator:a7b72b2c1edd9fba697b0bccbab3ed350 inherit pro_attribs_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae481937e76c817d67f704bfbc3ed2e30 inherit pro_attribs_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="ae481937e76c817d67f704bfbc3ed2e30" name="ae481937e76c817d67f704bfbc3ed2e30"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>id_</b></td></tr>
<tr class="memdesc:ae481937e76c817d67f704bfbc3ed2e30 inherit pro_attribs_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event id to identify event in state-machine. <br /></td></tr>
<tr class="separator:ae481937e76c817d67f704bfbc3ed2e30 inherit pro_attribs_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ec81ab9c537d5474cea2078d0d090e5 inherit pro_attribs_class_x_f_event"><td class="memItemLeft" align="right" valign="top"><a id="a1ec81ab9c537d5474cea2078d0d090e5" name="a1ec81ab9c537d5474cea2078d0d090e5"></a>
<a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>pBehavior_</b></td></tr>
<tr class="memdesc:a1ec81ab9c537d5474cea2078d0d090e5 inherit pro_attribs_class_x_f_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to behavioral class (ex. state-machine) processing the event. <br /></td></tr>
<tr class="separator:a1ec81ab9c537d5474cea2078d0d090e5 inherit pro_attribs_class_x_f_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a577e5773defd862102d4eb0df15c64b7"><td class="memItemLeft" align="right" valign="top"><a id="a577e5773defd862102d4eb0df15c64b7" name="a577e5773defd862102d4eb0df15c64b7"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>interface::XFTimeoutManager</b></td></tr>
<tr class="separator:a577e5773defd862102d4eb0df15c64b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_class_x_f_event"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_x_f_event')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="class_x_f_event.html">XFEvent</a></td></tr>
<tr class="memitem:a944826b381ee833ffddd30342088bf91 inherit pub_types_class_x_f_event"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91">XFEventType</a> { <br />
&#160;&#160;<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adfc2ad39d30f7a5df70c664bb2e24542">Unknown</a> = 0
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91adc2df751813b38295784e246f9fe230e">Initial</a> = 1
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4e9bf5642755f9677aa9c4c415a3bcba">DefaultTransition</a> = 2
, <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a4eefc024e7a72ce987c701013de3e100">Event</a> = 3
, <br />
&#160;&#160;<a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a04f01a94d013ac0b3cd810b556427496">Timeout</a> = 4
<br />
}</td></tr>
<tr class="separator:a944826b381ee833ffddd30342088bf91 inherit pub_types_class_x_f_event"><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 >Used by the TimeoutManager to create and handle a timeout. </p>
<p >Timeouts are created automatically by the TimeoutManager when scheduling a timeout. After expiration they are queued to the event queue and afterwards dispatched to the corresonding behavior.</p>
<p >A timeout can be identified by checking against <a class="el" href="class_x_f_event.html#a944826b381ee833ffddd30342088bf91a04f01a94d013ac0b3cd810b556427496" title="Defines a timeout event.">Timeout</a> using the <code><a class="el" href="class_x_f_event.html#abce814f103406c0a78cad6dd394ac567" title="Returns the type of the event.">getEventType()</a></code> method.</p>
<p ><a class="el" href="class_x_f_timeout.html" title="Used by the TimeoutManager to create and handle a timeout.">XFTimeout</a> is inheriting from <a class="el" href="class_x_f_event.html" title="Base class for all types of events and timeouts.">XFEvent</a>, so every timeout is also an event. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a04d1affe5a2667165f27dcad094ba5bb" name="a04d1affe5a2667165f27dcad094ba5bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04d1affe5a2667165f27dcad094ba5bb">&#9670;&nbsp;</a></span>XFTimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XFTimeout::XFTimeout </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>interval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classinterface_1_1_x_f_behavior.html">interface::XFBehavior</a> *&#160;</td>
<td class="paramname"><em>pBehavior</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Constructor of the class. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>The id given by the behavioral class to uniquely identifying the timeout </td></tr>
<tr><td class="paramname">interval</td><td>The interval in milliseconds the timeout expires </td></tr>
<tr><td class="paramname">pBehavior</td><td>Pointer to behavioral class to which the timeout belongs </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0d4154698f3337e7181a5f3455a16a93" name="a0d4154698f3337e7181a5f3455a16a93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d4154698f3337e7181a5f3455a16a93">&#9670;&nbsp;</a></span>deleteAfterConsume()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool XFTimeout::deleteAfterConsume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tells the dispatcher if the event must be deleted or not. </p>
<p>Reimplemented from <a class="el" href="class_x_f_event.html#a917cec86b20ee75e768da336f5b18c70">XFEvent</a>.</p>
</div>
</div>
<a id="a6b82c572dab611bf18175fe502b22181" name="a6b82c572dab611bf18175fe502b22181"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b82c572dab611bf18175fe502b22181">&#9670;&nbsp;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XFTimeout::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_x_f_timeout.html">XFTimeout</a> &amp;&#160;</td>
<td class="paramname"><em>timeout</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p >Operator checks if <a class="el" href="class_x_f_event.html#a1ec81ab9c537d5474cea2078d0d090e5" title="Pointer to behavioral class (ex. state-machine) processing the event.">pBehavior_</a> and <a class="el" href="class_x_f_event.html#ae481937e76c817d67f704bfbc3ed2e30" title="Event id to identify event in state-machine.">id_</a> are equal and returns true if so. All other attributes get no attention. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/thomas.sterren/Desktop/PTR_XF_Release/03-release/work/src/simplified/xf/include/xf/<a class="el" href="timeout_8h_source.html">timeout.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 19 2023 10:34:43 for Simplified XF 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>

5
src/simplified/xf/doxygen/output/html/class_x_f_timeout__coll__graph.map Normal file
View File

@ -0,0 +1,5 @@
<map id="XFTimeout" name="XFTimeout">
<area shape="rect" id="node1" title="Used by the TimeoutManager to create and handle a timeout." alt="" coords="5,463,179,657"/>
<area shape="rect" id="node2" href="$class_x_f_event.html" title="Base class for all types of events and timeouts." alt="" coords="12,233,172,413"/>
<area shape="rect" id="node3" href="$classinterface_1_1_x_f_behavior.html" title="Interface to receive and process events." alt="" coords="6,5,178,171"/>
</map>

1
src/simplified/xf/doxygen/output/html/class_x_f_timeout__coll__graph.md5 Normal file
View File

@ -0,0 +1 @@
b0f82e272c719dfb7c95001c5fb00fbb

Some files were not shown because too many files have changed in this diff Show More