MCB1700_Welcome/Doxygen/html/structstate_transition.html

124 lines
6.8 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Labor04: stateTransition Struct 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">Labor04
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structstate_transition.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">stateTransition Struct Reference<div class="ingroups"><a class="el" href="group___s_m.html">State Machine header.</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Event table holds events that can generate a state transition.
<a href="structstate_transition.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_fsm_framework_8h_source.html">FsmFramework.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ga5cdc2c9f58e42e1c10c43dff82706129"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_m.html#ga5cdc2c9f58e42e1c10c43dff82706129">s32EventId</a></td></tr>
<tr class="separator:ga5cdc2c9f58e42e1c10c43dff82706129"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga823a0b98f2bf81fb078373a776efe79c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___s_m.html#ga7957141d271ecc40ed63ac9fb308be57">bCallbackGuard_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_m.html#ga823a0b98f2bf81fb078373a776efe79c">bGuardCb</a></td></tr>
<tr class="separator:ga823a0b98f2bf81fb078373a776efe79c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1ac8558ca920bf24327003a266e56c2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___s_m.html#gae68e0cf14cb8d6332c29de697a4c7a2d">vCallback_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_m.html#ga1ac8558ca920bf24327003a266e56c2b">vTransitionCb</a></td></tr>
<tr class="separator:ga1ac8558ca920bf24327003a266e56c2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga084f33ee7b046c6c52467c63a92ebc2b"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___s_m.html#ga084f33ee7b046c6c52467c63a92ebc2b">s32NextStateId</a></td></tr>
<tr class="separator:ga084f33ee7b046c6c52467c63a92ebc2b"><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 table holds events that can generate a state transition. </p>
<p>An entry for the event table holds the event, that generates a state transition as well as callbacks for the guard check and the transition function. A transition between two states can only be done, if an event occurs and the guard is true, otherwise the state won't change. If both are true, the transition function will be called, if there is one and the state changes to the nextStateId. A Table should only hold events for one state, so each state should have it's own event table. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="_fsm_framework_8h_source.html">FsmFramework.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="structstate_transition.html">stateTransition</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>