1491 lines
86 KiB
HTML
1491 lines
86 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" 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: include/fsm.h 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="../../logo icon mini.png"/></td>
|
|
<td id="projectalign">
|
|
<div id="projectname">Gem-graph<span id="projectnumber"> 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&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&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_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">fsm.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>fsm (Finite State Machine) management header
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <stdbool.h></code><br />
|
|
<code>#include <stddef.h></code><br />
|
|
<code>#include <string.h></code><br />
|
|
<code>#include <gtk-4.0/gtk/gtk.h></code><br />
|
|
</div><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d08/structfsm__struct__journal__unit.html">fsm_struct_journal_unit</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">structure of a journal element <a href="../../d7/d08/structfsm__struct__journal__unit.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">required to initialise a double-chained list <a href="../../d9/d03/structfsm__struct__journal.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d00/structfsm__struct__list__tool.html">fsm_struct_list_tool</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <a href="../../d5/d00/structfsm__struct__list__tool.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d04/structfsm__struct__list__data.html">fsm_struct_list_data</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <a href="../../d9/d04/structfsm__struct__list__data.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/d07/structfsm__struct__list__disp.html">fsm_struct_list_disp</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <a href="../../d1/d07/structfsm__struct__list__disp.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:a47ac95b770c96c317621e1296488e576" id="r_a47ac95b770c96c317621e1296488e576"><td class="memItemLeft" align="right" valign="top"><a id="a47ac95b770c96c317621e1296488e576" name="a47ac95b770c96c317621e1296488e576"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>JOURNAL_LOG_MAX_LENGTH</b>   255</td></tr>
|
|
<tr class="memdesc:a47ac95b770c96c317621e1296488e576"><td class="mdescLeft"> </td><td class="mdescRight">arbitrary <br /></td></tr>
|
|
<tr class="separator:a47ac95b770c96c317621e1296488e576"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7af169265cd716e940b65232410d462e" id="r_a7af169265cd716e940b65232410d462e"><td class="memItemLeft" align="right" valign="top"><a id="a7af169265cd716e940b65232410d462e" name="a7af169265cd716e940b65232410d462e"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>n_rules</b>   128</td></tr>
|
|
<tr class="memdesc:a7af169265cd716e940b65232410d462e"><td class="mdescLeft"> </td><td class="mdescRight">arbitrary <br /></td></tr>
|
|
<tr class="separator:a7af169265cd716e940b65232410d462e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c57f0fbc36487a6b6a61a688968bd5f" id="r_a1c57f0fbc36487a6b6a61a688968bd5f"><td class="memItemLeft" align="right" valign="top"><a id="a1c57f0fbc36487a6b6a61a688968bd5f" name="a1c57f0fbc36487a6b6a61a688968bd5f"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>n_objects</b>   32</td></tr>
|
|
<tr class="memdesc:a1c57f0fbc36487a6b6a61a688968bd5f"><td class="mdescLeft"> </td><td class="mdescRight">arbitrary too, <br /></td></tr>
|
|
<tr class="separator:a1c57f0fbc36487a6b6a61a688968bd5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ac624784cce4cd90e2845b9a2d86412" id="r_a6ac624784cce4cd90e2845b9a2d86412"><td class="memItemLeft" align="right" valign="top"><a id="a6ac624784cce4cd90e2845b9a2d86412" name="a6ac624784cce4cd90e2845b9a2d86412"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>n_situations</b>   128</td></tr>
|
|
<tr class="memdesc:a6ac624784cce4cd90e2845b9a2d86412"><td class="mdescLeft"> </td><td class="mdescRight">and so on... <br /></td></tr>
|
|
<tr class="separator:a6ac624784cce4cd90e2845b9a2d86412"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:a6160d10d0af3ce294bde1326f8afba6d" id="r_a6160d10d0af3ce294bde1326f8afba6d"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="../../d7/d08/structfsm__struct__journal__unit.html">fsm_struct_journal_unit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a6160d10d0af3ce294bde1326f8afba6d">fsm_struct_journal_unit</a></td></tr>
|
|
<tr class="memdesc:a6160d10d0af3ce294bde1326f8afba6d"><td class="mdescLeft"> </td><td class="mdescRight">structure of a journal element <br /></td></tr>
|
|
<tr class="separator:a6160d10d0af3ce294bde1326f8afba6d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78376e470b28fc9869a090d21f2bf9a0" id="r_a78376e470b28fc9869a090d21f2bf9a0"><td class="memItemLeft" align="right" valign="top"><a id="a78376e470b28fc9869a090d21f2bf9a0" name="a78376e470b28fc9869a090d21f2bf9a0"></a>
|
|
typedef struct <a class="el" href="../../d5/d00/structfsm__struct__list__tool.html">fsm_struct_list_tool</a> </td><td class="memItemRight" valign="bottom"><b>fsm_struct_list_tool</b></td></tr>
|
|
<tr class="memdesc:a78376e470b28fc9869a090d21f2bf9a0"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:a78376e470b28fc9869a090d21f2bf9a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1448aeec62ef3a2adf8f4d364c794ab0" id="r_a1448aeec62ef3a2adf8f4d364c794ab0"><td class="memItemLeft" align="right" valign="top"><a id="a1448aeec62ef3a2adf8f4d364c794ab0" name="a1448aeec62ef3a2adf8f4d364c794ab0"></a>
|
|
typedef struct <a class="el" href="../../d9/d04/structfsm__struct__list__data.html">fsm_struct_list_data</a> </td><td class="memItemRight" valign="bottom"><b>fsm_struct_list_data</b></td></tr>
|
|
<tr class="memdesc:a1448aeec62ef3a2adf8f4d364c794ab0"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:a1448aeec62ef3a2adf8f4d364c794ab0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae905cedfa44ca2088de1b4cb5d3777db" id="r_ae905cedfa44ca2088de1b4cb5d3777db"><td class="memItemLeft" align="right" valign="top"><a id="ae905cedfa44ca2088de1b4cb5d3777db" name="ae905cedfa44ca2088de1b4cb5d3777db"></a>
|
|
typedef struct <a class="el" href="../../d1/d07/structfsm__struct__list__disp.html">fsm_struct_list_disp</a> </td><td class="memItemRight" valign="bottom"><b>fsm_struct_list_disp</b></td></tr>
|
|
<tr class="memdesc:ae905cedfa44ca2088de1b4cb5d3777db"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:ae905cedfa44ca2088de1b4cb5d3777db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ab761a6fdf1ac1e26a44f8f9524aa6da7" id="r_ab761a6fdf1ac1e26a44f8f9524aa6da7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#ab761a6fdf1ac1e26a44f8f9524aa6da7">fsm_enum_journal_severity</a> { <br />
|
|
  <a class="el" href="../../dd/d01/fsm_8h.html#ab761a6fdf1ac1e26a44f8f9524aa6da7a651d8a47a6976d6fe05c0e03fb4cd2d0">FATAL</a>
|
|
, <a class="el" href="../../dd/d01/fsm_8h.html#ab761a6fdf1ac1e26a44f8f9524aa6da7a2fd6f336d08340583bd620a7f5694c90">ERROR</a>
|
|
, <a class="el" href="../../dd/d01/fsm_8h.html#ab761a6fdf1ac1e26a44f8f9524aa6da7a74dac7ac23d5b810db6d4067f14e8676">WARN</a>
|
|
, <a class="el" href="../../dd/d01/fsm_8h.html#ab761a6fdf1ac1e26a44f8f9524aa6da7a748005382152808a72b1a9177d9dc806">INFO</a>
|
|
, <br />
|
|
  <a class="el" href="../../dd/d01/fsm_8h.html#ab761a6fdf1ac1e26a44f8f9524aa6da7a0593585da9181e972974c1274d8f2b4f">DEBUG</a>
|
|
, <a class="el" href="../../dd/d01/fsm_8h.html#ab761a6fdf1ac1e26a44f8f9524aa6da7a7fa27e82c6c4f69434225ed81e5d151e">TRACE</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:ab761a6fdf1ac1e26a44f8f9524aa6da7"><td class="mdescLeft"> </td><td class="mdescRight">Conforms to canonical log levels: FATAL, ERROR, WARN, INFO, DEBUG, TRACE. <a href="../../dd/d01/fsm_8h.html#ab761a6fdf1ac1e26a44f8f9524aa6da7">More...</a><br /></td></tr>
|
|
<tr class="separator:ab761a6fdf1ac1e26a44f8f9524aa6da7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae17fff59df266673b42b150568f1804c" id="r_ae17fff59df266673b42b150568f1804c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#ae17fff59df266673b42b150568f1804c">fsm_enum_journal_source</a> { <br />
|
|
  <b>SOURCE</b>
|
|
, <b>TARGET</b>
|
|
, <b>JOURNAL</b>
|
|
, <b>FSM</b>
|
|
, <br />
|
|
  <b>PREFER</b>
|
|
, <b>MAIN</b>
|
|
, <b>APP</b>
|
|
, <b>WIDGETS</b>
|
|
, <br />
|
|
  <b>SIGNAL</b>
|
|
, <b>MAIN_WINDOW</b>
|
|
, <b>DIALOG_WINDOW</b>
|
|
, <b>MODAL_WINDOW</b>
|
|
, <br />
|
|
  <b>TEXT_WINDOW</b>
|
|
, <b>AUTO_NOTIFICATION</b>
|
|
, <b>TOPBAR</b>
|
|
, <b>TOPBAR_LEFT</b>
|
|
, <br />
|
|
  <b>TOPBAR_RIGHT</b>
|
|
, <b>TOPBAR_CENTER</b>
|
|
, <b>SYNTH_PAGE</b>
|
|
, <b>STATE_PAGE</b>
|
|
, <br />
|
|
  <b>RULES_PAGE</b>
|
|
, <b>MEASURES_PAGE</b>
|
|
, <b>RESULTS_PAGE</b>
|
|
, <b>SenumYNTH_GLAREA</b>
|
|
, <br />
|
|
  <b>SYNTH_ALL_RESULTS</b>
|
|
, <b>SYNTH_TIME_DEP_RESULTS</b>
|
|
, <b>SYNTH_TIME_INDEP_RESULTS</b>
|
|
, <b>STATE_TOP</b>
|
|
, <br />
|
|
  <b>STATE_BOTTOM</b>
|
|
, <b>STATE_GLAREA</b>
|
|
, <b>STATE_CAMERA</b>
|
|
, <b>RULE_GEOMETRY</b>
|
|
, <br />
|
|
  <b>RULE_GLAREA</b>
|
|
, <b>RULE_CAMERA</b>
|
|
, <b>RULE_ALGEBRA</b>
|
|
, <b>RULE_CONDITION</b>
|
|
, <br />
|
|
  <b>RULE_ASSIGN</b>
|
|
, <b>RULE_ID</b>
|
|
, <b>RULES_TREE</b>
|
|
, <b>RULES_COMPARE</b>
|
|
, <br />
|
|
  <b>RULES_USE</b>
|
|
, <b>MEASURES_TOOLS</b>
|
|
, <b>MEASURES__ACTIVITY</b>
|
|
, <b>MEASURES__DISPLAY</b>
|
|
, <br />
|
|
  <b>RESULTS</b>
|
|
, <b>TIME_DEP_RESULTS</b>
|
|
, <b>TIME_INDEP_RESULTS</b>
|
|
, <b>WIDGET</b>
|
|
, <br />
|
|
  <b>BUTTON</b>
|
|
, <b>SCROLL</b>
|
|
, <b>GLAREA</b>
|
|
, <b>TEXT</b>
|
|
, <br />
|
|
  <b>LABEL</b>
|
|
, <b>TREE</b>
|
|
, <b>SLIDER</b>
|
|
, <b>EXPANDER</b>
|
|
, <br />
|
|
  <b>ENTRY</b>
|
|
, <b>SWITCH_STATE_RULES_DATA</b>
|
|
, <b>SLIDER_X</b>
|
|
, <b>SLIDER_Y</b>
|
|
, <br />
|
|
  <b>SLIDER_Z</b>
|
|
, <b>SLIDER_A</b>
|
|
, <b>SLIDER_B</b>
|
|
, <b>SLIDER_C</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:ae17fff59df266673b42b150568f1804c"><td class="mdescLeft"> </td><td class="mdescRight">arbitrary values that can help the logging filter work more efficiently <a href="../../dd/d01/fsm_8h.html#ae17fff59df266673b42b150568f1804c">More...</a><br /></td></tr>
|
|
<tr class="separator:ae17fff59df266673b42b150568f1804c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7804536bf1011457f3d850e350772dca" id="r_a7804536bf1011457f3d850e350772dca"><td class="memItemLeft" align="right" valign="top"><a id="a7804536bf1011457f3d850e350772dca" name="a7804536bf1011457f3d850e350772dca"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a7804536bf1011457f3d850e350772dca">fsm_enum_exec_edit</a> { <b>EXEC</b>
|
|
, <b>EDIT</b>
|
|
}</td></tr>
|
|
<tr class="memdesc:a7804536bf1011457f3d850e350772dca"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:a7804536bf1011457f3d850e350772dca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa1132278a581ee80526ff5806e6ffa04" id="r_aa1132278a581ee80526ff5806e6ffa04"><td class="memItemLeft" align="right" valign="top"><a id="aa1132278a581ee80526ff5806e6ffa04" name="aa1132278a581ee80526ff5806e6ffa04"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#aa1132278a581ee80526ff5806e6ffa04">fsm_enum_state_rules_data</a> { <b>SYNTH</b>
|
|
, <b>STATE</b>
|
|
, <b>RULES</b>
|
|
, <b>DATA</b>
|
|
}</td></tr>
|
|
<tr class="memdesc:aa1132278a581ee80526ff5806e6ffa04"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:aa1132278a581ee80526ff5806e6ffa04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5063f92d2c3765c7a4b664f5fc46143f" id="r_a5063f92d2c3765c7a4b664f5fc46143f"><td class="memItemLeft" align="right" valign="top"><a id="a5063f92d2c3765c7a4b664f5fc46143f" name="a5063f92d2c3765c7a4b664f5fc46143f"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a5063f92d2c3765c7a4b664f5fc46143f">fsm_enum_store_restore_reset</a> { <b>STORE</b>
|
|
, <b>RESTORE</b>
|
|
, <b>RESET</b>
|
|
}</td></tr>
|
|
<tr class="memdesc:a5063f92d2c3765c7a4b664f5fc46143f"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:a5063f92d2c3765c7a4b664f5fc46143f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06801f1f421dca2f4390645cb5b53c0c" id="r_a06801f1f421dca2f4390645cb5b53c0c"><td class="memItemLeft" align="right" valign="top"><a id="a06801f1f421dca2f4390645cb5b53c0c" name="a06801f1f421dca2f4390645cb5b53c0c"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a06801f1f421dca2f4390645cb5b53c0c">fsm_enum_measure_type</a> { <b>DATE_RULE_EXEC</b>
|
|
, <b>RULE_EXEC_NB</b>
|
|
, <b>OBJECT_NB</b>
|
|
, <b>ELAPSED_TIME</b>
|
|
}</td></tr>
|
|
<tr class="memdesc:a06801f1f421dca2f4390645cb5b53c0c"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:a06801f1f421dca2f4390645cb5b53c0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a76c4b511ecf3ddbc9e6d110641be665b" id="r_a76c4b511ecf3ddbc9e6d110641be665b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a76c4b511ecf3ddbc9e6d110641be665b">fsm_journal_publish</a> (<a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> jj)</td></tr>
|
|
<tr class="memdesc:a76c4b511ecf3ddbc9e6d110641be665b"><td class="mdescLeft"> </td><td class="mdescRight">publish all the logs today just print in the console TODO > in a file <br /></td></tr>
|
|
<tr class="separator:a76c4b511ecf3ddbc9e6d110641be665b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6db4255fc3be03e0df09e7eda86b079" id="r_ae6db4255fc3be03e0df09e7eda86b079"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#ae6db4255fc3be03e0df09e7eda86b079">fsm_journal_init</a> (<a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> *jj)</td></tr>
|
|
<tr class="memdesc:ae6db4255fc3be03e0df09e7eda86b079"><td class="mdescLeft"> </td><td class="mdescRight">init the journal <br /></td></tr>
|
|
<tr class="separator:ae6db4255fc3be03e0df09e7eda86b079"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00a6887e7c3875580234d3a621589b72" id="r_a00a6887e7c3875580234d3a621589b72"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a00a6887e7c3875580234d3a621589b72">fsm_journal_push_front</a> (<a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> *jj, const char *file_source, const char *function_source, const char *string_value)</td></tr>
|
|
<tr class="memdesc:a00a6887e7c3875580234d3a621589b72"><td class="mdescLeft"> </td><td class="mdescRight">add an event <br /></td></tr>
|
|
<tr class="separator:a00a6887e7c3875580234d3a621589b72"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6738f8ff2fb7cb835d3ac62f1428c68" id="r_af6738f8ff2fb7cb835d3ac62f1428c68"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#af6738f8ff2fb7cb835d3ac62f1428c68">fsm_journal_clear</a> (<a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> *jj, const char *file_source, const char *function_source, const char *string_value)</td></tr>
|
|
<tr class="memdesc:af6738f8ff2fb7cb835d3ac62f1428c68"><td class="mdescLeft"> </td><td class="mdescRight">usefulness ? (systematic ^c) <br /></td></tr>
|
|
<tr class="separator:af6738f8ff2fb7cb835d3ac62f1428c68"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e063d297e80c32e2bac1ec04f24ecc2" id="r_a9e063d297e80c32e2bac1ec04f24ecc2"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a9e063d297e80c32e2bac1ec04f24ecc2">fsm_journal_pop_back</a> (<a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> *jj, const char *file_source, const char *function_source, const char *string_value)</td></tr>
|
|
<tr class="memdesc:a9e063d297e80c32e2bac1ec04f24ecc2"><td class="mdescLeft"> </td><td class="mdescRight">remove an event <br /></td></tr>
|
|
<tr class="separator:a9e063d297e80c32e2bac1ec04f24ecc2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bc11a62378ff09ae3cbd8f40fa7fecd" id="r_a2bc11a62378ff09ae3cbd8f40fa7fecd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a2bc11a62378ff09ae3cbd8f40fa7fecd">fsm_journal_length</a> (<a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> jj)</td></tr>
|
|
<tr class="memdesc:a2bc11a62378ff09ae3cbd8f40fa7fecd"><td class="mdescLeft"> </td><td class="mdescRight">get journal_length <br /></td></tr>
|
|
<tr class="separator:a2bc11a62378ff09ae3cbd8f40fa7fecd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa414af4170798735875067122c33df8f" id="r_aa414af4170798735875067122c33df8f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#aa414af4170798735875067122c33df8f">fsm_journal_seek</a> (<a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> jj, long usec, const char *file_source, const char *function_source, const char *string_value)</td></tr>
|
|
<tr class="memdesc:aa414af4170798735875067122c33df8f"><td class="mdescLeft"> </td><td class="mdescRight">seek for an event <br /></td></tr>
|
|
<tr class="separator:aa414af4170798735875067122c33df8f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a435d1a5171a7d69662d701234722fee2" id="r_a435d1a5171a7d69662d701234722fee2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a435d1a5171a7d69662d701234722fee2">fsm_journal_publication_request</a> ()</td></tr>
|
|
<tr class="memdesc:a435d1a5171a7d69662d701234722fee2"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="../../d4/d07/fsm_2dispatch_8c.html#a435d1a5171a7d69662d701234722fee2" title="The fsm_journal_publication_request() is called only once, by main(), just after closing the app and ...">fsm_journal_publication_request()</a> is called only once, by <a class="el" href="../../d0/d09/main_8c.html#a3c04138a5bfe5d72780bb7e82a18e627">main()</a>, just after closing the app and before ending the program. <br /></td></tr>
|
|
<tr class="separator:a435d1a5171a7d69662d701234722fee2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c67f42f95d48ee2469c9a27d65db3e6" id="r_a8c67f42f95d48ee2469c9a27d65db3e6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.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="memdesc:a8c67f42f95d48ee2469c9a27d65db3e6"><td class="mdescLeft"> </td><td class="mdescRight">It is mandatory for any event to call this function to be published in the journal. <br /></td></tr>
|
|
<tr class="separator:a8c67f42f95d48ee2469c9a27d65db3e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d131c81f05d5ee502b715db0e4e172a" id="r_a9d131c81f05d5ee502b715db0e4e172a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a9d131c81f05d5ee502b715db0e4e172a">fsm_init</a> (char *message)</td></tr>
|
|
<tr class="memdesc:a9d131c81f05d5ee502b715db0e4e172a"><td class="mdescLeft"> </td><td class="mdescRight">fsm init is the first function called by <a class="el" href="../../d0/d09/main_8c.html" title="Gem-graph-client main file.">main.c</a> It initiates the journal and the four lists: 'measures', 'results', 'displayables results' and 'preferences'. <br /></td></tr>
|
|
<tr class="separator:a9d131c81f05d5ee502b715db0e4e172a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa02db2c62f7507eabfcc9a41f0e660b6" id="r_aa02db2c62f7507eabfcc9a41f0e660b6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#aa02db2c62f7507eabfcc9a41f0e660b6">fsm_list_init_preferences</a> ()</td></tr>
|
|
<tr class="separator:aa02db2c62f7507eabfcc9a41f0e660b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5da29952715596bf17643f907bd64daf" id="r_a5da29952715596bf17643f907bd64daf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a5da29952715596bf17643f907bd64daf">fsm_list_init_measures</a> ()</td></tr>
|
|
<tr class="separator:a5da29952715596bf17643f907bd64daf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae228c78b1697ffd299d415ce2bdce515" id="r_ae228c78b1697ffd299d415ce2bdce515"><td class="memItemLeft" align="right" valign="top"><a id="ae228c78b1697ffd299d415ce2bdce515" name="ae228c78b1697ffd299d415ce2bdce515"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>fsm_list_init_results</b> ()</td></tr>
|
|
<tr class="memdesc:ae228c78b1697ffd299d415ce2bdce515"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:ae228c78b1697ffd299d415ce2bdce515"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8eaa768708ebc21d710a8cc6144af1d3" id="r_a8eaa768708ebc21d710a8cc6144af1d3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a8eaa768708ebc21d710a8cc6144af1d3">fsm_list_init_displayables</a> ()</td></tr>
|
|
<tr class="separator:a8eaa768708ebc21d710a8cc6144af1d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9123915ffd10fe1ae18254898b1c0ebf" id="r_a9123915ffd10fe1ae18254898b1c0ebf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a9123915ffd10fe1ae18254898b1c0ebf">fsm_get_exec_edit</a> ()</td></tr>
|
|
<tr class="memdesc:a9123915ffd10fe1ae18254898b1c0ebf"><td class="mdescLeft"> </td><td class="mdescRight">some client pages (in particular "state" and "rules") will be displayed and behave differently depending on whether the fsm is in edit or run state. <br /></td></tr>
|
|
<tr class="separator:a9123915ffd10fe1ae18254898b1c0ebf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a90ab14081a88752d3721947a4922ee25" id="r_a90ab14081a88752d3721947a4922ee25"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a90ab14081a88752d3721947a4922ee25">fsm_get_state_rules_data</a> ()</td></tr>
|
|
<tr class="memdesc:a90ab14081a88752d3721947a4922ee25"><td class="mdescLeft"> </td><td class="mdescRight">The value of the static int choice_STATE_RULES_DATA can be one of the enum include/fsm enum fsm_enum_state_rules_data. <br /></td></tr>
|
|
<tr class="separator:a90ab14081a88752d3721947a4922ee25"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f8ada2e7bb701277fc6c5a378b93c88" id="r_a1f8ada2e7bb701277fc6c5a378b93c88"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a1f8ada2e7bb701277fc6c5a378b93c88">fsm_set_exec_edit</a> (int value)</td></tr>
|
|
<tr class="memdesc:a1f8ada2e7bb701277fc6c5a378b93c88"><td class="mdescLeft"> </td><td class="mdescRight">setter for the static value: 'choice_STATE_RULES_DATA' (in this file) <br /></td></tr>
|
|
<tr class="separator:a1f8ada2e7bb701277fc6c5a378b93c88"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1cd2f8cf1891095e1496c76b17aed7f2" id="r_a1cd2f8cf1891095e1496c76b17aed7f2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a1cd2f8cf1891095e1496c76b17aed7f2">fsm_set_state_rules_data</a> (int value)</td></tr>
|
|
<tr class="memdesc:a1cd2f8cf1891095e1496c76b17aed7f2"><td class="mdescLeft"> </td><td class="mdescRight">setter for the static value: 'choice_STATE_RULES_DATA' (in this file) <br /></td></tr>
|
|
<tr class="separator:a1cd2f8cf1891095e1496c76b17aed7f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a42a491a3a432cf572b3c2ed84a00d927" id="r_a42a491a3a432cf572b3c2ed84a00d927"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a42a491a3a432cf572b3c2ed84a00d927">fsm_set_store_restore_reset</a> (int choice, int value)</td></tr>
|
|
<tr class="separator:a42a491a3a432cf572b3c2ed84a00d927"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b0231a311d0e85723ef9fcf38be88e3" id="r_a0b0231a311d0e85723ef9fcf38be88e3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a0b0231a311d0e85723ef9fcf38be88e3">fsm_get_preferences_state</a> ()</td></tr>
|
|
<tr class="memdesc:a0b0231a311d0e85723ef9fcf38be88e3"><td class="mdescLeft"> </td><td class="mdescRight">getter for the static boolean: 'preferences_have_been_modified' <br /></td></tr>
|
|
<tr class="separator:a0b0231a311d0e85723ef9fcf38be88e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a770bcaeb0bd6f81cddcc3cd506468fff" id="r_a770bcaeb0bd6f81cddcc3cd506468fff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a770bcaeb0bd6f81cddcc3cd506468fff">fsm_set_preferences_modified</a> (bool value)</td></tr>
|
|
<tr class="memdesc:a770bcaeb0bd6f81cddcc3cd506468fff"><td class="mdescLeft"> </td><td class="mdescRight">setter for the static boolean: 'preferences_have_been_modified' <br /></td></tr>
|
|
<tr class="separator:a770bcaeb0bd6f81cddcc3cd506468fff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c711a88f128da33895ebd6cdf96ed66" id="r_a6c711a88f128da33895ebd6cdf96ed66"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a6c711a88f128da33895ebd6cdf96ed66">fsm_add_measure</a> (char *measure_name)</td></tr>
|
|
<tr class="separator:a6c711a88f128da33895ebd6cdf96ed66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac59294a7ff6934d0704c85aaf08dc268" id="r_ac59294a7ff6934d0704c85aaf08dc268"><td class="memItemLeft" align="right" valign="top"><a id="ac59294a7ff6934d0704c85aaf08dc268" name="ac59294a7ff6934d0704c85aaf08dc268"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>fsm_add_result</b> (char *result_name)</td></tr>
|
|
<tr class="memdesc:ac59294a7ff6934d0704c85aaf08dc268"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:ac59294a7ff6934d0704c85aaf08dc268"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa69a9ce07b26ad1863960c6f0d1303b5" id="r_aa69a9ce07b26ad1863960c6f0d1303b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#aa69a9ce07b26ad1863960c6f0d1303b5">fsm_add_displayable</a> (char *displayable_name)</td></tr>
|
|
<tr class="separator:aa69a9ce07b26ad1863960c6f0d1303b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb1b857c9ec1ab39d6cb7cdf683a08d1" id="r_abb1b857c9ec1ab39d6cb7cdf683a08d1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#abb1b857c9ec1ab39d6cb7cdf683a08d1">fsm_reset_all_situations_values</a> (int value)</td></tr>
|
|
<tr class="separator:abb1b857c9ec1ab39d6cb7cdf683a08d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae5d5ccdff72b50a67c62ae920224c927" id="r_ae5d5ccdff72b50a67c62ae920224c927"><td class="memItemLeft" align="right" valign="top"><a id="ae5d5ccdff72b50a67c62ae920224c927" name="ae5d5ccdff72b50a67c62ae920224c927"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>fsm_tools_list_insert</b> (<a class="el" href="../../d5/d00/structfsm__struct__list__tool.html">fsm_struct_list_tool</a> **tl, int value)</td></tr>
|
|
<tr class="memdesc:ae5d5ccdff72b50a67c62ae920224c927"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:ae5d5ccdff72b50a67c62ae920224c927"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a680078a92dca5a303408d5d997b47848" id="r_a680078a92dca5a303408d5d997b47848"><td class="memItemLeft" align="right" valign="top"><a id="a680078a92dca5a303408d5d997b47848" name="a680078a92dca5a303408d5d997b47848"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>fsm_tools_list_pop</b> (<a class="el" href="../../d5/d00/structfsm__struct__list__tool.html">fsm_struct_list_tool</a> **tl)</td></tr>
|
|
<tr class="memdesc:a680078a92dca5a303408d5d997b47848"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:a680078a92dca5a303408d5d997b47848"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5849dc2b70ef4683f15e6f4b33575780" id="r_a5849dc2b70ef4683f15e6f4b33575780"><td class="memItemLeft" align="right" valign="top"><a id="a5849dc2b70ef4683f15e6f4b33575780" name="a5849dc2b70ef4683f15e6f4b33575780"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>fsm_tools_list_length</b> (<a class="el" href="../../d5/d00/structfsm__struct__list__tool.html">fsm_struct_list_tool</a> *tl)</td></tr>
|
|
<tr class="memdesc:a5849dc2b70ef4683f15e6f4b33575780"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:a5849dc2b70ef4683f15e6f4b33575780"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac25c0b170bac58e699bb9e1533393b6a" id="r_ac25c0b170bac58e699bb9e1533393b6a"><td class="memItemLeft" align="right" valign="top"><a id="ac25c0b170bac58e699bb9e1533393b6a" name="ac25c0b170bac58e699bb9e1533393b6a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>fsm_tools_list_clear</b> (<a class="el" href="../../d5/d00/structfsm__struct__list__tool.html">fsm_struct_list_tool</a> **tl)</td></tr>
|
|
<tr class="memdesc:ac25c0b170bac58e699bb9e1533393b6a"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:ac25c0b170bac58e699bb9e1533393b6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c87d4ebbff9faab298659b295b5ea15" id="r_a1c87d4ebbff9faab298659b295b5ea15"><td class="memItemLeft" align="right" valign="top"><a id="a1c87d4ebbff9faab298659b295b5ea15" name="a1c87d4ebbff9faab298659b295b5ea15"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>fsm_tools_list_view</b> (<a class="el" href="../../d5/d00/structfsm__struct__list__tool.html">fsm_struct_list_tool</a> *tl)</td></tr>
|
|
<tr class="memdesc:a1c87d4ebbff9faab298659b295b5ea15"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:a1c87d4ebbff9faab298659b295b5ea15"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a274e703d76bfc06daa46ec5924187fa3" id="r_a274e703d76bfc06daa46ec5924187fa3"><td class="memItemLeft" align="right" valign="top"><a id="a274e703d76bfc06daa46ec5924187fa3" name="a274e703d76bfc06daa46ec5924187fa3"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>fsm_tools_list_test</b> ()</td></tr>
|
|
<tr class="memdesc:a274e703d76bfc06daa46ec5924187fa3"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:a274e703d76bfc06daa46ec5924187fa3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae81ba1733710f5b2db1a5b253d7adaf7" id="r_ae81ba1733710f5b2db1a5b253d7adaf7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#ae81ba1733710f5b2db1a5b253d7adaf7">fsm_rule_trig_measure</a> (int rule_id, int object_id, int measure_id)</td></tr>
|
|
<tr class="separator:ae81ba1733710f5b2db1a5b253d7adaf7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb8e63af534703319fa3d909f166501c" id="r_aeb8e63af534703319fa3d909f166501c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#aeb8e63af534703319fa3d909f166501c">fsm_add_data</a> (<a class="el" href="../../d9/d04/structfsm__struct__list__data.html">fsm_struct_list_data</a> d, int *p_data, int *p_target)</td></tr>
|
|
<tr class="memdesc:aeb8e63af534703319fa3d909f166501c"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:aeb8e63af534703319fa3d909f166501c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a51424f38912d7ac0f5df50d6f073bfff" id="r_a51424f38912d7ac0f5df50d6f073bfff"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a51424f38912d7ac0f5df50d6f073bfff">fsm_get_data</a> (<a class="el" href="../../d9/d04/structfsm__struct__list__data.html">fsm_struct_list_data</a> d, int from, int to)</td></tr>
|
|
<tr class="memdesc:a51424f38912d7ac0f5df50d6f073bfff"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:a51424f38912d7ac0f5df50d6f073bfff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9682b83c800a1d48695a58744997d4d8" id="r_a9682b83c800a1d48695a58744997d4d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d01/fsm_8h.html#a9682b83c800a1d48695a58744997d4d8">fsm_remove_data</a> (<a class="el" href="../../d9/d04/structfsm__struct__list__data.html">fsm_struct_list_data</a> d, int *p_data)</td></tr>
|
|
<tr class="memdesc:a9682b83c800a1d48695a58744997d4d8"><td class="mdescLeft"> </td><td class="mdescRight">phantom documentation <br /></td></tr>
|
|
<tr class="separator:a9682b83c800a1d48695a58744997d4d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>fsm (Finite State Machine) management header </p>
|
|
<p>This file is part of Gem-graph. </p>
|
|
</div><h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="a6160d10d0af3ce294bde1326f8afba6d" name="a6160d10d0af3ce294bde1326f8afba6d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6160d10d0af3ce294bde1326f8afba6d">◆ </a></span>fsm_struct_journal_unit</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="../../d7/d08/structfsm__struct__journal__unit.html">fsm_struct_journal_unit</a> <a class="el" href="../../d7/d08/structfsm__struct__journal__unit.html">fsm_struct_journal_unit</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>structure of a journal element </p>
|
|
<dl class="section see"><dt>See also</dt><dd>use in src/fsm/dispatch/fsm_journal_event() </dd>
|
|
<dd>
|
|
use in src/journal/fsm_journal_push_front() </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="ab761a6fdf1ac1e26a44f8f9524aa6da7" name="ab761a6fdf1ac1e26a44f8f9524aa6da7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab761a6fdf1ac1e26a44f8f9524aa6da7">◆ </a></span>fsm_enum_journal_severity</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="../../dd/d01/fsm_8h.html#ab761a6fdf1ac1e26a44f8f9524aa6da7">fsm_enum_journal_severity</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Conforms to canonical log levels: FATAL, ERROR, WARN, INFO, DEBUG, TRACE. </p>
|
|
<ul>
|
|
<li><p class="startli">* * * - J O U R N A L M E T A R U L E S - * * * *</p>
|
|
<p class="startli">ref: sudo cat /var/log/messages</p>
|
|
<p class="startli">structure d'un log:</p>
|
|
</li>
|
|
<li>date</li>
|
|
<li>rang (n° d'ordre)</li>
|
|
<li>fichier</li>
|
|
<li>fonction</li>
|
|
<li>valeur, paramètre, descriptif, contexte,... (tout ce qui peut contribuer à améliorer la compréhension du journal) any value that can qualify the event and provides useful information when reading the log.</li>
|
|
</ul>
|
|
<hr />
|
|
<p>Un seul <a class="el" href="../../dd/d01/fsm_8h.html#a8c67f42f95d48ee2469c9a27d65db3e6" title="It is mandatory for any event to call this function to be published in the journal.">fsm_journal_event()</a> par fonction ? sauf si cette fonction génère plusieurs autres fonctions d'intérêt ?</p>
|
|
<p>S'il y a deux <a class="el" href="../../dd/d01/fsm_8h.html#a8c67f42f95d48ee2469c9a27d65db3e6" title="It is mandatory for any event to call this function to be published in the journal.">fsm_journal_event()</a> (begin / end) dans une fonction, ils doivent avoir la même étiquette (les mêmes valeurs) : SEVERITY & SOURCE</p>
|
|
<ul>
|
|
<li>* * * - J O U R N A L M E T A R U L E S - * * * <br />
|
|
</li>
|
|
</ul>
|
|
<p><a href="https://betterstack.com/community/guides/logging/logging-best-practices/">https://betterstack.com/community/guides/logging/logging-best-practices/</a> <a href="https://en.wikipedia.org/wiki/Syslog">https://en.wikipedia.org/wiki/Syslog</a> </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab761a6fdf1ac1e26a44f8f9524aa6da7a651d8a47a6976d6fe05c0e03fb4cd2d0" name="ab761a6fdf1ac1e26a44f8f9524aa6da7a651d8a47a6976d6fe05c0e03fb4cd2d0"></a>FATAL </td><td class="fielddoc"><p>(or CRITICAL) an unrecoverable failure that prevents the whole application from doing any further useful work </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ab761a6fdf1ac1e26a44f8f9524aa6da7a2fd6f336d08340583bd620a7f5694c90" name="ab761a6fdf1ac1e26a44f8f9524aa6da7a2fd6f336d08340583bd620a7f5694c90"></a>ERROR </td><td class="fielddoc"><p>a conditions that hinder the execution of a specific operation within an application and is unrecoverable </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ab761a6fdf1ac1e26a44f8f9524aa6da7a74dac7ac23d5b810db6d4067f14e8676" name="ab761a6fdf1ac1e26a44f8f9524aa6da7a74dac7ac23d5b810db6d4067f14e8676"></a>WARN </td><td class="fielddoc"><p>something unexpected has occurred, but the application can continue to function normally for the time being </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ab761a6fdf1ac1e26a44f8f9524aa6da7a748005382152808a72b1a9177d9dc806" name="ab761a6fdf1ac1e26a44f8f9524aa6da7a748005382152808a72b1a9177d9dc806"></a>INFO </td><td class="fielddoc"><p>(or MESSAGE) a significant event occurs while the system is operating normally </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ab761a6fdf1ac1e26a44f8f9524aa6da7a0593585da9181e972974c1274d8f2b4f" name="ab761a6fdf1ac1e26a44f8f9524aa6da7a0593585da9181e972974c1274d8f2b4f"></a>DEBUG </td><td class="fielddoc"><p>a description of system states in sufficient detail to give developers clues as to the cause of an error </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ab761a6fdf1ac1e26a44f8f9524aa6da7a7fa27e82c6c4f69434225ed81e5d151e" name="ab761a6fdf1ac1e26a44f8f9524aa6da7a7fa27e82c6c4f69434225ed81e5d151e"></a>TRACE </td><td class="fielddoc"><p>provides a systematic overview of code execution but comes at a cost in terms of performance </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae17fff59df266673b42b150568f1804c" name="ae17fff59df266673b42b150568f1804c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae17fff59df266673b42b150568f1804c">◆ </a></span>fsm_enum_journal_source</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="../../dd/d01/fsm_8h.html#ae17fff59df266673b42b150568f1804c">fsm_enum_journal_source</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>arbitrary values that can help the logging filter work more efficiently </p>
|
|
<dl class="section see"><dt>See also</dt><dd>src/fsm/dispatch/fsm_journal_event()) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="aeb8e63af534703319fa3d909f166501c" name="aeb8e63af534703319fa3d909f166501c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeb8e63af534703319fa3d909f166501c">◆ </a></span>fsm_add_data()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_add_data </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d9/d04/structfsm__struct__list__data.html">fsm_struct_list_data</a> </td>
|
|
<td class="paramname"><em>d</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>p_data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>p_target</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>phantom documentation </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">d</td><td></td></tr>
|
|
<tr><td class="paramname">*p_data</td><td></td></tr>
|
|
<tr><td class="paramname">*p_target</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa69a9ce07b26ad1863960c6f0d1303b5" name="aa69a9ce07b26ad1863960c6f0d1303b5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa69a9ce07b26ad1863960c6f0d1303b5">◆ </a></span>fsm_add_displayable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_add_displayable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>displayable_name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section date"><dt>Date</dt><dd></dd></dl>
|
|
<dl class="section author"><dt>Author</dt><dd></dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd></dd>
|
|
<dd>
|
|
</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">displayable_name</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6c711a88f128da33895ebd6cdf96ed66" name="a6c711a88f128da33895ebd6cdf96ed66"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6c711a88f128da33895ebd6cdf96ed66">◆ </a></span>fsm_add_measure()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_add_measure </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>measure_name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd>src/widget/measure/dispatch/widget_measure_event_occurences_nb() </dd>
|
|
<dd>
|
|
src/widget/measure/dispatch/widget_measure_event_occurences_dates() </dd>
|
|
<dd>
|
|
src/widget/measure/dispatch/widget_measure_event_occurences_situations() </dd>
|
|
<dd>
|
|
src/widget/measure/dispatch/widget_measure_time_elapsed_between_two_events() </dd>
|
|
<dd>
|
|
src/widget/measure/dispatch/widget_measure_third_event_occurences_in_between()</dd>
|
|
<dd>
|
|
src/fsm/dispatch/fsm_journal_event() </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">*measure_name</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a51424f38912d7ac0f5df50d6f073bfff" name="a51424f38912d7ac0f5df50d6f073bfff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a51424f38912d7ac0f5df50d6f073bfff">◆ </a></span>fsm_get_data()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int fsm_get_data </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d9/d04/structfsm__struct__list__data.html">fsm_struct_list_data</a> </td>
|
|
<td class="paramname"><em>d</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>from</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>to</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>phantom documentation </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">d</td><td></td></tr>
|
|
<tr><td class="paramname">from</td><td></td></tr>
|
|
<tr><td class="paramname">to</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9123915ffd10fe1ae18254898b1c0ebf" name="a9123915ffd10fe1ae18254898b1c0ebf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9123915ffd10fe1ae18254898b1c0ebf">◆ </a></span>fsm_get_exec_edit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int fsm_get_exec_edit </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>some client pages (in particular "state" and "rules") will be displayed and behave differently depending on whether the fsm is in edit or run state. </p>
|
|
<p>Any function which modifies the appearance or behavior of these pages must use this getter to access the choice_EXEC_EDIT value.</p>
|
|
<p>see include/fsm enum fsm_enum_exec_edit { EXEC, EDIT } The current int may be replaced by a boolean . TODO</p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-06</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd>src/widget/one_rule/dispatch </dd>
|
|
<dd>
|
|
src/widget/state/dispatch * 2 </dd>
|
|
<dd>
|
|
src/signal</dd>
|
|
<dd>
|
|
choice_EXEC_EDIT and </dd>
|
|
<dd>
|
|
include/fsm/enum <a class="el" href="../../dd/d01/fsm_8h.html#a7804536bf1011457f3d850e350772dca" title="phantom documentation">fsm_enum_exec_edit</a> {}</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>choice_EXEC_EDIT </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0b0231a311d0e85723ef9fcf38be88e3" name="a0b0231a311d0e85723ef9fcf38be88e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0b0231a311d0e85723ef9fcf38be88e3">◆ </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>getter for the static boolean: 'preferences_have_been_modified' </p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-08</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd>TODO A function must obtain this boolean when it stores the current state of the fsm (including <a class="el" href="../../d3/d0f/structpreferences.html">preferences</a>) before closing the current session.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>preferences_have_been_modified </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a90ab14081a88752d3721947a4922ee25" name="a90ab14081a88752d3721947a4922ee25"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a90ab14081a88752d3721947a4922ee25">◆ </a></span>fsm_get_state_rules_data()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int fsm_get_state_rules_data </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The value of the static int choice_STATE_RULES_DATA can be one of the enum include/fsm enum fsm_enum_state_rules_data. </p>
|
|
<p>To each value is associated a different page and different possible behaviors. Any function that modifies the client window must get this value.</p>
|
|
<p>see include/fsm enum fsm_enum_state_rules_data { SYNTH, STATE, RULES, DATA }</p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-06</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd>src/widget/topbar/left </dd>
|
|
<dd>
|
|
src/signal</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>choice_STATE_RULES_DATA </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9d131c81f05d5ee502b715db0e4e172a" name="a9d131c81f05d5ee502b715db0e4e172a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d131c81f05d5ee502b715db0e4e172a">◆ </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 * </td>
|
|
<td class="paramname"><em>initial_message_from_main</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>fsm init is the first function called by <a class="el" href="../../d0/d09/main_8c.html" title="Gem-graph-client main file.">main.c</a> It initiates the journal and the four lists: 'measures', 'results', 'displayables results' and 'preferences'. </p>
|
|
<p>The items selected in these lists define the current state of the fsm.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-08</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd>src/main/main()</dd>
|
|
<dd>
|
|
src/journal/fsm_journal_init() </dd>
|
|
<dd>
|
|
src/fsm/dispatch/fsm_journal_event() </dd>
|
|
<dd>
|
|
src/fsm/measures/manager/fsm_list_init_measures() </dd>
|
|
<dd>
|
|
src/fsm/results/manager/fsm_list_init_results() </dd>
|
|
<dd>
|
|
src/fsm/preferences/manager/fsm_list_init_displayables() </dd>
|
|
<dd>
|
|
src/fsm/preferences/manager/fsm_list_init_preferences()</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">*initial_message_from_main</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af6738f8ff2fb7cb835d3ac62f1428c68" name="af6738f8ff2fb7cb835d3ac62f1428c68"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af6738f8ff2fb7cb835d3ac62f1428c68">◆ </a></span>fsm_journal_clear()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_journal_clear </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> * </td>
|
|
<td class="paramname"><em>jj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>file_source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>function_source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>string_value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>usefulness ? (systematic ^c) </p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">*jj</td><td></td></tr>
|
|
<tr><td class="paramname">*file_source</td><td></td></tr>
|
|
<tr><td class="paramname">*function_source</td><td></td></tr>
|
|
<tr><td class="paramname">*string_value</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8c67f42f95d48ee2469c9a27d65db3e6" name="a8c67f42f95d48ee2469c9a27d65db3e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8c67f42f95d48ee2469c9a27d65db3e6">◆ </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 </td>
|
|
<td class="paramname"><em>severity</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>file_source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>function_source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>string_value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>It is mandatory for any event to call this function to be published in the journal. </p>
|
|
<p>Before publication, a filter can be applied here (and only here) to select only some events of interest (during debugging, for example).</p>
|
|
<p>If there are too many events, a filter can be applied here to select a few interesting events for publication in the log.</p>
|
|
<p>This filter can operate on any the following five parameters: severity, source, *file_source, *function_source, *string_value. </p><dl class="section see"><dt>See also</dt><dd>below (params)</dd></dl>
|
|
<p>Simple filters (on a single parameter) can be combined using the logical operators 'and' and 'or' and parentheses.</p>
|
|
<p>Use: $ grep -r "fsm_journal_event" to confirm the callergraph calls.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-08</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="../../d3/d0c/journal_8c.html" title="journal / log">src/journal.c</a>/fsm_journal_push_front()</dd>
|
|
<dd>
|
|
src/main/main() </dd>
|
|
<dd>
|
|
src/widget/topbar/modal.c </dd>
|
|
<dd>
|
|
src/widget/topbar/right.c </dd>
|
|
<dd>
|
|
src/widget/topbar/dialog.c </dd>
|
|
<dd>
|
|
src/widget/topbar/left.c </dd>
|
|
<dd>
|
|
src/widget/topbar/dispatch.c * 3 </dd>
|
|
<dd>
|
|
src/widget/one_rule/dispatch.c </dd>
|
|
<dd>
|
|
src/widget/one_rule/algebra/conditions.c * 2 </dd>
|
|
<dd>
|
|
src/widget/measure/dispatch.c </dd>
|
|
<dd>
|
|
src/widget/dispatch.c * 3 </dd>
|
|
<dd>
|
|
src/widget/all_rules/dispatch.c </dd>
|
|
<dd>
|
|
<a class="el" href="../../de/d07/fsm_2preferences_2manager_8c.html" title="fsm preferences manager">src/fsm/preferences/manager.c</a> * 8 </dd>
|
|
<dd>
|
|
<a class="el" href="../../d2/d03/fsm_2measures_2manager_8c.html" title="fsm measures manager">src/fsm/measures/manager.c</a> * 2 </dd>
|
|
<dd>
|
|
<a class="el" href="../../d1/d04/tools__list_8c.html" title="Gem-graph client * Finite State Machine (src/fsm/measure/tool_list.c) *Copyright © 2024 Libre en Comm...">src/fsm/measures/tools_list.c</a> * 4 </dd>
|
|
<dd>
|
|
<a class="el" href="../../d4/d07/fsm_2dispatch_8c.html" title="fsm (Finite State Machine) tasks dispatcher">src/fsm/dispatch.c</a> * 10 </dd>
|
|
<dd>
|
|
<a class="el" href="../../d2/d0e/fsm_2results_2manager_8c.html" title="fsm results manager">src/fsm/results/manager.c</a> </dd>
|
|
<dd>
|
|
src/util/tree.c </dd>
|
|
<dd>
|
|
<a class="el" href="../../d8/d06/signal_8c.html" title="events callbacks">src/signal.c</a> * 38</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">severity</td><td><> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd>enum <a class="el" href="../../dd/d01/fsm_8h.html#ab761a6fdf1ac1e26a44f8f9524aa6da7" title="Conforms to canonical log levels: FATAL, ERROR, WARN, INFO, DEBUG, TRACE.">fsm_enum_journal_severity</a> in <a class="el" href="../../dd/d01/fsm_8h.html" title="fsm (Finite State Machine) management header">include/fsm.h</a> 'severity' is a pre-defined value that must be associated to each event. It ranges from zero to six : CRITICAL <a class="el" href="../../dd/d01/fsm_8h.html#ab761a6fdf1ac1e26a44f8f9524aa6da7a2fd6f336d08340583bd620a7f5694c90" title="a conditions that hinder the execution of a specific operation within an application and is unrecover...">ERROR</a> WARNING <a class="el" href="../../dd/d01/fsm_8h.html#ab761a6fdf1ac1e26a44f8f9524aa6da7a748005382152808a72b1a9177d9dc806" title="(or MESSAGE) a significant event occurs while the system is operating normally">INFO</a> MESSAGE <a class="el" href="../../dd/d01/fsm_8h.html#ab761a6fdf1ac1e26a44f8f9524aa6da7a0593585da9181e972974c1274d8f2b4f" title="a description of system states in sufficient detail to give developers clues as to the cause of an er...">DEBUG</a> <a class="el" href="../../dd/d01/fsm_8h.html#ab761a6fdf1ac1e26a44f8f9524aa6da7a7fa27e82c6c4f69434225ed81e5d151e" title="provides a systematic overview of code execution but comes at a cost in terms of performance">TRACE</a> 0 1 2 3 4 5 6</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">source</td><td><> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd>enum <a class="el" href="../../dd/d01/fsm_8h.html#ae17fff59df266673b42b150568f1804c" title="arbitrary values that can help the logging filter work more efficiently">fsm_enum_journal_source</a> in <a class="el" href="../../dd/d01/fsm_8h.html" title="fsm (Finite State Machine) management header">include/fsm.h</a> 'source' is a pre-defined value that can be associated to each event. It is not mandatory. It can be set to 'NULL'.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">*file_source</td><td><> the name of the file that emits the event. </td></tr>
|
|
<tr><td class="paramname">*function_source</td><td><> the function that emits the event. </td></tr>
|
|
<tr><td class="paramname">*string_value</td><td><> any value that can qualify the event and provides useful information when reading the log. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae6db4255fc3be03e0df09e7eda86b079" name="ae6db4255fc3be03e0df09e7eda86b079"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae6db4255fc3be03e0df09e7eda86b079">◆ </a></span>fsm_journal_init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_journal_init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> * </td>
|
|
<td class="paramname"><em>jj</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>init the journal </p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">*jj</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2bc11a62378ff09ae3cbd8f40fa7fecd" name="a2bc11a62378ff09ae3cbd8f40fa7fecd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2bc11a62378ff09ae3cbd8f40fa7fecd">◆ </a></span>fsm_journal_length()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int fsm_journal_length </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> </td>
|
|
<td class="paramname"><em>jj</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get journal_length </p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">*jj</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>journal length </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9e063d297e80c32e2bac1ec04f24ecc2" name="a9e063d297e80c32e2bac1ec04f24ecc2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9e063d297e80c32e2bac1ec04f24ecc2">◆ </a></span>fsm_journal_pop_back()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long fsm_journal_pop_back </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> * </td>
|
|
<td class="paramname"><em>jj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>file_source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>function_source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>string_value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>remove an event </p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">*jj</td><td></td></tr>
|
|
<tr><td class="paramname">*file_source</td><td></td></tr>
|
|
<tr><td class="paramname">*function_source</td><td></td></tr>
|
|
<tr><td class="paramname">*string_value</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a435d1a5171a7d69662d701234722fee2" name="a435d1a5171a7d69662d701234722fee2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a435d1a5171a7d69662d701234722fee2">◆ </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>The <a class="el" href="../../d4/d07/fsm_2dispatch_8c.html#a435d1a5171a7d69662d701234722fee2" title="The fsm_journal_publication_request() is called only once, by main(), just after closing the app and ...">fsm_journal_publication_request()</a> is called only once, by <a class="el" href="../../d0/d09/main_8c.html#a3c04138a5bfe5d72780bb7e82a18e627">main()</a>, just after closing the app and before ending the program. </p>
|
|
<p>This is to guarantee the chronological order of the events in the journal.</p>
|
|
<p>The log is modified for each event but events can be send asynchronously. This is why the journal is only published once, before the end of "main()", Its chronological order is therefore guaranteed.</p>
|
|
<p><a class="el" href="../../d3/d0c/journal_8c.html" title="journal / log">src/journal.c</a>/fsm_journal_publish() (called here) is the last function of the program to be executed.</p>
|
|
<p>The <a class="el" href="../../d9/d03/structfsm__struct__journal.html" title="required to initialise a double-chained list">fsm_struct_journal</a> (gg_logs) is a static instance in this file. Therefore, all the functions that read or write it are in this file. This is to avoid uncontrolled operations on it.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-08</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd>src/main/main()</dd>
|
|
<dd>
|
|
src/journal/fsm_journal_publish() </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a76c4b511ecf3ddbc9e6d110641be665b" name="a76c4b511ecf3ddbc9e6d110641be665b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a76c4b511ecf3ddbc9e6d110641be665b">◆ </a></span>fsm_journal_publish()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_journal_publish </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> </td>
|
|
<td class="paramname"><em>jj</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>publish all the logs today just print in the console TODO > in a file </p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">*jj</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a00a6887e7c3875580234d3a621589b72" name="a00a6887e7c3875580234d3a621589b72"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a00a6887e7c3875580234d3a621589b72">◆ </a></span>fsm_journal_push_front()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_journal_push_front </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> * </td>
|
|
<td class="paramname"><em>jj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>file_source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>function_source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>string_value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>add an event </p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">*jj</td><td></td></tr>
|
|
<tr><td class="paramname">*file_source</td><td></td></tr>
|
|
<tr><td class="paramname">*function_source</td><td></td></tr>
|
|
<tr><td class="paramname">*string_value</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa414af4170798735875067122c33df8f" name="aa414af4170798735875067122c33df8f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa414af4170798735875067122c33df8f">◆ </a></span>fsm_journal_seek()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_journal_seek </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d9/d03/structfsm__struct__journal.html">fsm_struct_journal</a> </td>
|
|
<td class="paramname"><em>jj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">long </td>
|
|
<td class="paramname"><em>usec</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>file_source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>function_source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>string_value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>seek for an event </p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">*jj</td><td></td></tr>
|
|
<tr><td class="paramname">usec</td><td></td></tr>
|
|
<tr><td class="paramname">*file_source</td><td></td></tr>
|
|
<tr><td class="paramname">*function_source</td><td></td></tr>
|
|
<tr><td class="paramname">*string_value</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8eaa768708ebc21d710a8cc6144af1d3" name="a8eaa768708ebc21d710a8cc6144af1d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8eaa768708ebc21d710a8cc6144af1d3">◆ </a></span>fsm_list_init_displayables()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_list_init_displayables </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section date"><dt>Date</dt><dd></dd></dl>
|
|
<dl class="section author"><dt>Author</dt><dd></dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd></dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5da29952715596bf17643f907bd64daf" name="a5da29952715596bf17643f907bd64daf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5da29952715596bf17643f907bd64daf">◆ </a></span>fsm_list_init_measures()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_list_init_measures </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section since"><dt>Since</dt><dd>2024-09</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd>src/fsm/dispatch/fsm_init() </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa02db2c62f7507eabfcc9a41f0e660b6" name="aa02db2c62f7507eabfcc9a41f0e660b6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa02db2c62f7507eabfcc9a41f0e660b6">◆ </a></span>fsm_list_init_preferences()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_list_init_preferences </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section date"><dt>Date</dt><dd></dd></dl>
|
|
<dl class="section author"><dt>Author</dt><dd></dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd></dd>
|
|
<dd>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9682b83c800a1d48695a58744997d4d8" name="a9682b83c800a1d48695a58744997d4d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9682b83c800a1d48695a58744997d4d8">◆ </a></span>fsm_remove_data()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_remove_data </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d9/d04/structfsm__struct__list__data.html">fsm_struct_list_data</a> </td>
|
|
<td class="paramname"><em>d</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>p_data</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>phantom documentation </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">d</td><td></td></tr>
|
|
<tr><td class="paramname">*p_data</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abb1b857c9ec1ab39d6cb7cdf683a08d1" name="abb1b857c9ec1ab39d6cb7cdf683a08d1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb1b857c9ec1ab39d6cb7cdf683a08d1">◆ </a></span>fsm_reset_all_situations_values()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_reset_all_situations_values </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section date"><dt>Date</dt><dd></dd></dl>
|
|
<dl class="section author"><dt>Author</dt><dd></dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd></dd>
|
|
<dd>
|
|
</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae81ba1733710f5b2db1a5b253d7adaf7" name="ae81ba1733710f5b2db1a5b253d7adaf7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae81ba1733710f5b2db1a5b253d7adaf7">◆ </a></span>fsm_rule_trig_measure()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_rule_trig_measure </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>rule_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>object_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>measure_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section since"><dt>Since</dt><dd>2024-09 </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rule_id</td><td></td></tr>
|
|
<tr><td class="paramname">object_id</td><td></td></tr>
|
|
<tr><td class="paramname">measure_id</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1f8ada2e7bb701277fc6c5a378b93c88" name="a1f8ada2e7bb701277fc6c5a378b93c88"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1f8ada2e7bb701277fc6c5a378b93c88">◆ </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 </td>
|
|
<td class="paramname"><em>choice</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>setter for the static value: 'choice_STATE_RULES_DATA' (in this file) </p>
|
|
<p>see include/fsm enum fsm_enum_exec_edit { EXEC, EDIT }</p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-08</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd>src/signal * 2</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">choice</td><td>< a boolean value which can be "EXEC" or "EDIT" </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a770bcaeb0bd6f81cddcc3cd506468fff" name="a770bcaeb0bd6f81cddcc3cd506468fff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a770bcaeb0bd6f81cddcc3cd506468fff">◆ </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 </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>setter for the static boolean: 'preferences_have_been_modified' </p>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-08</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd>TODO To be used by any function that modifies the current user <a class="el" href="../../d3/d0f/structpreferences.html">preferences</a></dd>
|
|
<dd>
|
|
<a class="el" href="../../d4/d07/fsm_2dispatch_8c.html#a8c67f42f95d48ee2469c9a27d65db3e6" title="It is mandatory for any event to call this function to be published in the journal.">fsm_journal_event()</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value</td><td>= TRUE if preferences_have_been_modified. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1cd2f8cf1891095e1496c76b17aed7f2" name="a1cd2f8cf1891095e1496c76b17aed7f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1cd2f8cf1891095e1496c76b17aed7f2">◆ </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 </td>
|
|
<td class="paramname"><em>choice</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>setter for the static value: 'choice_STATE_RULES_DATA' (in this file) </p>
|
|
<p>see include/fsm enum fsm_enum_state_rules_data { SYNTH, STATE, RULES, DATA } Today (2024-10) the initial page is set to 'SYNTH'. </p><dl class="section see"><dt>See also</dt><dd>line 292 choice_STATE_RULES_DATA = SYNTH; NB This choice can be temporarily modified for debugging purpose: </dd>
|
|
<dd>
|
|
end of the function: <a class="el" href="../../d4/d07/fsm_2dispatch_8c.html" title="fsm (Finite State Machine) tasks dispatcher">fsm/dispatch.c</a> window_design_topbar_left()</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>2024-08</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd>src/signal * 4</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">choice</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a42a491a3a432cf572b3c2ed84a00d927" name="a42a491a3a432cf572b3c2ed84a00d927"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a42a491a3a432cf572b3c2ed84a00d927">◆ </a></span>fsm_set_store_restore_reset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fsm_set_store_restore_reset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>choice</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section date"><dt>Date</dt><dd></dd></dl>
|
|
<dl class="section author"><dt>Author</dt><dd></dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd></dd>
|
|
<dd>
|
|
</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">choice</td><td></td></tr>
|
|
<tr><td class="paramname">value</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|