gem-graph-client/doc/html/d2/d03/fsm_2measures_2manager_8c.html

218 lines
11 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: src/fsm/measures/manager.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="../../logo icon mini.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><li class="navelem"><a class="el" href="../../dir_1c8669d4863c86346088af7b13e9b473.html">measures</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">manager.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>fsm measures manager
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdbool.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &quot;<a class="el" href="../../dd/d01/fsm_8h.html">../../../include/fsm.h</a>&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:a6c711a88f128da33895ebd6cdf96ed66" id="r_a6c711a88f128da33895ebd6cdf96ed66"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d03/fsm_2measures_2manager_8c.html#a6c711a88f128da33895ebd6cdf96ed66">fsm_add_measure</a> (char *measure_name)</td></tr>
<tr class="separator:a6c711a88f128da33895ebd6cdf96ed66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5da29952715596bf17643f907bd64daf" id="r_a5da29952715596bf17643f907bd64daf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d03/fsm_2measures_2manager_8c.html#a5da29952715596bf17643f907bd64daf">fsm_list_init_measures</a> ()</td></tr>
<tr class="separator:a5da29952715596bf17643f907bd64daf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae81ba1733710f5b2db1a5b253d7adaf7" id="r_ae81ba1733710f5b2db1a5b253d7adaf7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d03/fsm_2measures_2manager_8c.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">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>fsm measures manager </p>
<p>This file is part of Gem-graph. It inits the three lists used for measurements and results management: tools, data and displayables (disp) and provides access.</p>
<p>F R O M M E A S U R E M E N T S T O P R E S E N T A T I O N S How should the sequence from measurements to results presentation be organized ?</p>
<p>(1) create/edit some mesurement tools and/or activate existing ones (2) apply a mesurement tool to a situation to create a new data list data list = x, f(x), g(x),... these data are collected by the server and send to the client and possibly carry out any operations on these results (3) display (plot) the results and adjust the appearance of the tables </p><hr />
<p> As a consequence, three lists at least must be created and maintained :</p>
<p>(1) a mesurement tools list (see : fsm/measure/tool_list.c) which should mention if the tool is 'active' or 'inactive NB each rule ou rules-tree edition may change some items of that list</p>
<p>(2) a data flows list (see : fsm/measure/flow_list.c) (it could either be named : fsm/measure/data_list.c) on which some operations could be performed : ex : filter, concat, inverse, scale, correlate, etc. NB each data flow should be available in a 'displayable form'</p>
<p>(3) a displayed data list (see : fsm/measure/disp_list.c) NB some data may be displayed simultaneously in different pages ex : SYNTH &amp; RESULTS</p>
<p>NB these three lists should be stored in the XML model and restored at the beginning of a new session </p><hr />
<p> (4) a journal (a pile) stores chronologically the fsm events during a session run (rules exec, mainly) in a journal (.log) one by session </p><hr />
<p> When a rule is adequately tagged, it triggers a measure : fsm_rule_trig_measure (rule_id, object_id, measure_id) {...} The measurement is then taken and the result stored. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a6c711a88f128da33895ebd6cdf96ed66" name="a6c711a88f128da33895ebd6cdf96ed66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c711a88f128da33895ebd6cdf96ed66">&#9670;&#160;</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 *&#160;</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="a5da29952715596bf17643f907bd64daf" name="a5da29952715596bf17643f907bd64daf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5da29952715596bf17643f907bd64daf">&#9670;&#160;</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="ae81ba1733710f5b2db1a5b253d7adaf7" name="ae81ba1733710f5b2db1a5b253d7adaf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae81ba1733710f5b2db1a5b253d7adaf7">&#9670;&#160;</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&#160;</td>
<td class="paramname"><em>rule_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>object_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>measure_id</em>&#160;</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>
</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>