gem-graph-client/doc/rtfm/man3/identity.c.3

73 lines
2.3 KiB
Groff
Raw Normal View History

2024-10-20 01:05:12 +02:00
.TH "src/widget/main_window/one_rule/algebra/identity.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
2024-10-20 01:05:12 +02:00
src/widget/main_window/one_rule/algebra/identity.c \- Non algebraic identity of a rule\&.
.SH SYNOPSIS
.br
.PP
2024-10-20 01:05:12 +02:00
\fC#include '\&.\&./\&.\&./\&.\&./\&.\&./\&.\&./include/fsm\&.h'\fP
.br
2024-10-20 01:05:12 +02:00
\fC#include '\&.\&./\&.\&./\&.\&./\&.\&./\&.\&./include/widget\&.h'\fP
.br
2024-10-20 01:05:12 +02:00
\fC#include '\&.\&./\&.\&./\&.\&./\&.\&./\&.\&./include/signal\&.h'\fP
.br
\fC#include <stdio\&.h>\fP
.br
\fC#include <stdlib\&.h>\fP
.br
.SS "Functions"
.in +1c
.ti -1c
.RI "void * \fBwidget_get_selected_rule_identity_btt\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP
Non algebraic identity of a rule\&.
This file is part of Gem-graph\&. It hosts the functions needed to identify a rule by name\&.
.SH "Function Documentation"
.PP
.SS "void * widget_get_selected_rule_identity_btt ()"
Hosts a list of character strings that can be combined to provide a 'human readable' rule identifier\&. This list can also contain non-mandatory elements\&.
.PP
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\&.
.PP
On the contrary, for the automaton, the identity of each rule is given exclusively by its set of conditions\&.
.PP
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
.PP
|- - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - - >
.PP
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\&.)\&.
.PP
< - - - - - - - - - - - - - - meta-rules - - - - - - - - - - - - - - -|
.PP
\fBSince\fP
.RS 4
2024-08
.RE
.PP
\fBSee also\fP
.RS 4
src/widget/one_rule/algebra/utilities/widget_set_item_text()
.PP
src/fsm/dispatch/fsm_journal_event() < TODO (for each item ?)
.PP
src/widget/one_rule/algebra/dispatch/gtk_box_append()
.RE
.PP
\fBReturns\fP
.RS 4
rule identity
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Gem-graph from the source code\&.