gem-graph-client/doc/html/d4/d01/identity_8c.html

142 lines
7.6 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/widget/main_window/one_rule/algebra/identity.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_c570470bf3e4213fb57699dd2e921b84.html">widget</a></li><li class="navelem"><a class="el" href="../../dir_4378cb27ffdfc18b738d6615673a7a16.html">main_window</a></li><li class="navelem"><a class="el" href="../../dir_8667849977c2734846655dc647f12661.html">one_rule</a></li><li class="navelem"><a class="el" href="../../dir_68a51ecf4137935c7484c3f9c0526c00.html">algebra</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">identity.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Non algebraic identity of a rule.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="../../dd/d01/fsm_8h.html">../../../../../include/fsm.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../df/d05/widget_8h.html">../../../../../include/widget.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d8/d09/signal_8h.html">../../../../../include/signal.h</a>&quot;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</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:afcfab13d3504a69ec5f4ae6ad6974e29" id="r_afcfab13d3504a69ec5f4ae6ad6974e29"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d01/identity_8c.html#afcfab13d3504a69ec5f4ae6ad6974e29">widget_get_selected_rule_identity_btt</a> ()</td></tr>
<tr class="memdesc:afcfab13d3504a69ec5f4ae6ad6974e29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hosts a list of character strings that can be combined to provide a "human readable" rule identifier. <br /></td></tr>
<tr class="separator:afcfab13d3504a69ec5f4ae6ad6974e29"><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>Non algebraic identity of a rule. </p>
<p>This file is part of Gem-graph. It hosts the functions needed to identify a rule by name. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="afcfab13d3504a69ec5f4ae6ad6974e29" name="afcfab13d3504a69ec5f4ae6ad6974e29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcfab13d3504a69ec5f4ae6ad6974e29">&#9670;&#160;</a></span>widget_get_selected_rule_identity_btt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * widget_get_selected_rule_identity_btt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Hosts a list of character strings that can be combined to provide a "human readable" rule identifier. </p>
<p>This list can also contain non-mandatory elements.</p>
<p>Each rule can have a specific "human readable" name chosen by its designer. This name can be used to identify the rule. It is desirable for a unique name to be accepted and shared by as many users as possible.</p>
<p>On the contrary, for the automaton, the identity of each rule is given exclusively by its set of conditions.</p>
<p>Today, this function provides only an arbitrary presentation with no link to the XML model and no verification of compliance with the meta-rules. (see below) TODO</p>
<p>|- - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - - &gt;</p>
<p>No item of the list should be repeated. No element describing the function of the rule can contradict another. All the elements required for identification by name must be present. Uniqueness is required (This name must be usable as a key). Non-mandatory elements can be added (comments, etc.).</p>
<p>&lt; - - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - -|</p>
<dl class="section since"><dt>Since</dt><dd>2024-08</dd></dl>
<dl class="section see"><dt>See also</dt><dd>src/widget/one_rule/algebra/utilities/widget_set_item_text() </dd>
<dd>
src/fsm/dispatch/fsm_journal_event() &lt; TODO (for each item ?)</dd>
<dd>
src/widget/one_rule/algebra/dispatch/gtk_box_append()</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>rule identity </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>