gem-graph-client/doc/docbook/d4/d01/identity_8c.xml

65 lines
3.4 KiB
XML

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_identity_8c" xml:lang="en-US">
<title>src/widget/one_rule/algebra/identity.c File Reference</title>
<indexterm><primary>src/widget/one_rule/algebra/identity.c</primary></indexterm>
<para>
<para>Gem-graph-client algebra rules identity. </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../../include/signal.h&quot;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para>void * <link linkend="_identity_8c_1afcfab13d3504a69ec5f4ae6ad6974e29">widget_get_selected_rule_identity_btt</link> ()</para>
<para>Builds the rule identity items list. </para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>Gem-graph-client algebra rules identity. </para>
<para>This file is part of Gem-graph. It organizes functions needed to describe a rule identity. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_identity_8c_1afcfab13d3504a69ec5f4ae6ad6974e29"/><section>
<title>widget_get_selected_rule_identity_btt()</title>
<indexterm><primary>widget_get_selected_rule_identity_btt</primary><secondary>identity.c</secondary></indexterm>
<indexterm><primary>identity.c</primary><secondary>widget_get_selected_rule_identity_btt</secondary></indexterm>
<para><computeroutput>void * widget_get_selected_rule_identity_btt ( )</computeroutput></para><para>
<para>Builds the rule identity items list. </para>
</para>
<para>TODO // today, an arbitrary mock-up without any link to the XML model</para>
<para>This list contains all the items required to identify the rule. No item should be repeated. No item may contradict another. Completeness is required. Non-mandatory elements can be added (comments, etc.).</para>
<para>The identity of each rule produced here is an arbitrary text used by each user to recognise each rule by name and distinguish it from others (it is desirable for the same rule identity to be shared by as many users as possible).</para>
<para>For the automaton, the identity of each rule is given exclusively by its set of conditions. Two rules cannot share the same set of conditions. If several rules apply to the same set of conditions in the same local space, then they must each have an additional condition determining their probability of execution in the event of a conflict. If two rules share the same set of conditions, they must both be evaluated. If all the conditions of one rule are included in the conditions of another rule, then the other rule must be evaluated first.</para>
<para><formalpara><title>Since</title>
<para>2024-08</para>
</formalpara>
<formalpara><title>See also</title>
<para>src/widget/one_rule/algebra/utilities/widget_set_item_text() </para>
<para>src/fsm/dispatch/fsm_journal_event() &lt; TODO (or not ?)</para>
<para>src/widget/one_rule/algebra/dispatch/gtk_box_append() &lt; TODO check items</para>
</formalpara>
<formalpara><title>Returns</title>
<para>rule identity </para>
</formalpara>
</para>
</section>
</section>
</section>