gem-graph-client/doc/docbook/d4/d01/identity_8c.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/main_window/one_rule/algebra/identity.c File Reference</title>
<indexterm><primary>src/widget/main_window/one_rule/algebra/identity.c</primary></indexterm>
<para>

<para>Non algebraic identity of a rule. </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>Hosts a list of character strings that can be combined to provide a &quot;human readable&quot; rule identifier. </para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>Non algebraic identity of a rule. </para>

<para>This file is part of Gem-graph. It hosts the functions needed to identify a rule by name. </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>Hosts a list of character strings that can be combined to provide a &quot;human readable&quot; rule identifier. </para>
</para>

<para>This list can also contain non-mandatory elements.</para>

<para>Each rule can have a specific &quot;human readable&quot; 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.</para>

<para>On the contrary, for the automaton, the identity of each rule is given exclusively by its set of conditions.</para>

<para>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</para>

<para>|- - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - - &gt;</para>

<para>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.).</para>

<para>&lt; - - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - -|</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 (for each item ?)</para>

<para>src/widget/one_rule/algebra/dispatch/gtk_box_append()</para>
</formalpara>
<formalpara><title>Returns</title>

<para>rule identity </para>
</formalpara>
</para>
</section>
</section>
</section>