gem-graph/gem-graph-client
gem-graph
/
gem-graph-client
3
0
Fork 0
Code Issues 14 Pull Requests Projects Releases Activity
gem-graph-client/html/d4/d07/fsm_2dispatch_8c.html

301 lines
15 KiB
HTML
Raw Blame History

<!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" lang="en-US">
<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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gem-graph: src/fsm/dispatch.c File 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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="../../gg_calligraphie.png"/></td>
<td id="projectalign">
<div id="projectname">Gem-graph<span id="projectnumber">&#160;0.1.0</span>
</div>
<div id="projectbrief">A modelling tool based on rewriting of geometric graphs.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="../../dir_2e581129b453fd71c794a7e24f5ee6d2.html">fsm</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">dispatch.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>This Finite State Machine (fsm) describes all the possible states of the Gem-graph client and all the transitions between these states.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdbool.h&gt;</code><br />
<code>#include &quot;../../include/fsm.h&quot;</code><br />
<code>#include &quot;../../include/util.h&quot;</code><br />
<code>#include &quot;../../include/widget.h&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a435d1a5171a7d69662d701234722fee2" id="r_a435d1a5171a7d69662d701234722fee2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d07/fsm_2dispatch_8c.html#a435d1a5171a7d69662d701234722fee2">fsm_journal_publication_request</a> ()</td></tr>
<tr class="separator:a435d1a5171a7d69662d701234722fee2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c67f42f95d48ee2469c9a27d65db3e6" id="r_a8c67f42f95d48ee2469c9a27d65db3e6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d07/fsm_2dispatch_8c.html#a8c67f42f95d48ee2469c9a27d65db3e6">fsm_journal_event</a> (int severity, int source, const char *file_source, const char *function_source, const char *string_value)</td></tr>
<tr class="separator:a8c67f42f95d48ee2469c9a27d65db3e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d91f5868f20ad3b72cfa63787d87444" id="r_a8d91f5868f20ad3b72cfa63787d87444"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d07/fsm_2dispatch_8c.html#a8d91f5868f20ad3b72cfa63787d87444">fsm_init</a> (char *initial_message_from_main)</td></tr>
<tr class="separator:a8d91f5868f20ad3b72cfa63787d87444"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a770bcaeb0bd6f81cddcc3cd506468fff" id="r_a770bcaeb0bd6f81cddcc3cd506468fff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d07/fsm_2dispatch_8c.html#a770bcaeb0bd6f81cddcc3cd506468fff">fsm_set_preferences_modified</a> (bool value)</td></tr>
<tr class="separator:a770bcaeb0bd6f81cddcc3cd506468fff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b0231a311d0e85723ef9fcf38be88e3" id="r_a0b0231a311d0e85723ef9fcf38be88e3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d07/fsm_2dispatch_8c.html#a0b0231a311d0e85723ef9fcf38be88e3">fsm_get_preferences_state</a> ()</td></tr>
<tr class="separator:a0b0231a311d0e85723ef9fcf38be88e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9123915ffd10fe1ae18254898b1c0ebf" id="r_a9123915ffd10fe1ae18254898b1c0ebf"><td class="memItemLeft" align="right" valign="top"><a id="a9123915ffd10fe1ae18254898b1c0ebf" name="a9123915ffd10fe1ae18254898b1c0ebf"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>fsm_get_exec_edit</b> ()</td></tr>
<tr class="separator:a9123915ffd10fe1ae18254898b1c0ebf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90ab14081a88752d3721947a4922ee25" id="r_a90ab14081a88752d3721947a4922ee25"><td class="memItemLeft" align="right" valign="top"><a id="a90ab14081a88752d3721947a4922ee25" name="a90ab14081a88752d3721947a4922ee25"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>fsm_get_state_rules_data</b> ()</td></tr>
<tr class="separator:a90ab14081a88752d3721947a4922ee25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae921ecd39af67bb8dc0deb2cdc86125d" id="r_ae921ecd39af67bb8dc0deb2cdc86125d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d07/fsm_2dispatch_8c.html#ae921ecd39af67bb8dc0deb2cdc86125d">fsm_set_exec_edit</a> (int choice)</td></tr>
<tr class="separator:ae921ecd39af67bb8dc0deb2cdc86125d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5a464b19589ba1972c9b3aa3397945a" id="r_af5a464b19589ba1972c9b3aa3397945a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d07/fsm_2dispatch_8c.html#af5a464b19589ba1972c9b3aa3397945a">fsm_set_state_rules_data</a> (int choice)</td></tr>
<tr class="separator:af5a464b19589ba1972c9b3aa3397945a"><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>This Finite State Machine (fsm) describes all the possible states of the Gem-graph client and all the transitions between these states. </p>
<ul>
<li>OOOOOOOOOOO OOOOO OOO OOO * OO OO OO OOOO OOOO * OO OO OO OO OO OO * OOOOOO OO OO OO OO OO * OO OO OO OOO OO * OO OO OO OO * OO OO OOO OO OO * OO OOOOOO OO OO *<ul>
<li></li>
</ul>
</li>
</ul>
<p>@detailed gem-graph-client fsm (Finite State Machine) manages the four topics:</p><ul>
<li>engine (window appearance)</li>
<li>measures (current measurements)</li>
<li>results (current data acquisition and displays)</li>
<li><p class="startli">preferences (current user preferences)</p>
<p class="startli">Each state of the finite state machine (fsm) must be</p><ul>
<li>saved at the end of a work session and</li>
<li>reread (available) at the start of a new session.</li>
</ul>
<p class="startli">No state of the fsm should be defined in another module. No fsm transition needs to be executed in another module. </p>
</li>
</ul>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a0b0231a311d0e85723ef9fcf38be88e3" name="a0b0231a311d0e85723ef9fcf38be88e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b0231a311d0e85723ef9fcf38be88e3">&#9670;&#160;</a></span>fsm_get_preferences_state()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool fsm_get_preferences_state </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>phantom documentation used to test the functioning of doxygen </p>
</div>
</div>
<a id="a8d91f5868f20ad3b72cfa63787d87444" name="a8d91f5868f20ad3b72cfa63787d87444"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d91f5868f20ad3b72cfa63787d87444">&#9670;&#160;</a></span>fsm_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fsm_init </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>initial_message_from_main</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>F S M I N I T * phantom documentation used to test the functioning of doxygen </p>
</div>
</div>
<a id="a8c67f42f95d48ee2469c9a27d65db3e6" name="a8c67f42f95d48ee2469c9a27d65db3e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c67f42f95d48ee2469c9a27d65db3e6">&#9670;&#160;</a></span>fsm_journal_event()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fsm_journal_event </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>severity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>function_source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>string_value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>phantom documentation used to test the functioning of doxygen </p>
</div>
</div>
<a id="a435d1a5171a7d69662d701234722fee2" name="a435d1a5171a7d69662d701234722fee2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a435d1a5171a7d69662d701234722fee2">&#9670;&#160;</a></span>fsm_journal_publication_request()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fsm_journal_publication_request </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>phantom documentation used to test the functioning of doxygen </p>
</div>
</div>
<a id="ae921ecd39af67bb8dc0deb2cdc86125d" name="ae921ecd39af67bb8dc0deb2cdc86125d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae921ecd39af67bb8dc0deb2cdc86125d">&#9670;&#160;</a></span>fsm_set_exec_edit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fsm_set_exec_edit </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>choice</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>phantom documentation used to test the functioning of doxygen </p>
</div>
</div>
<a id="a770bcaeb0bd6f81cddcc3cd506468fff" name="a770bcaeb0bd6f81cddcc3cd506468fff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a770bcaeb0bd6f81cddcc3cd506468fff">&#9670;&#160;</a></span>fsm_set_preferences_modified()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fsm_set_preferences_modified </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>phantom documentation used to test the functioning of doxygen </p>
</div>
</div>
<a id="af5a464b19589ba1972c9b3aa3397945a" name="af5a464b19589ba1972c9b3aa3397945a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5a464b19589ba1972c9b3aa3397945a">&#9670;&#160;</a></span>fsm_set_state_rules_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fsm_set_state_rules_data </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>choice</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>phantom documentation used to test the functioning of doxygen </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated 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.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink