gem-graph-client/doc/docbook/dc/d0b/disp__list_8c.xml

156 lines
6.5 KiB
XML
Raw Normal View History

<?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="_disp__list_8c" xml:lang="en-US">
<title>src/fsm/measures/disp_list.c File Reference</title>
<indexterm><primary>src/fsm/measures/disp_list.c</primary></indexterm>
<para>
2024-10-25 17:32:30 +02:00
<para>A list of displayable results (whether currently displayed or not). </para>
</para>
2024-10-25 22:12:02 +02:00
<programlisting linenumbering="unnumbered">#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?>#include &quot;../../../include/fsm.h&quot;<?linebreak?></programlisting>Include dependency graph for disp_list.c:<para>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata width="50%" align="center" valign="middle" scalefit="0" fileref="../../d8/d0a/disp__list_8c__incl.svg"></imagedata>
2024-10-25 22:12:02 +02:00
</imageobject>
</mediaobject>
</informalfigure>
</para>
<simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para>void <link linkend="_disp__list_8c_1a9b206b4ea4932270d24f6b672301aa2b">fsm_disp_add_chart</link> (<link linkend="_structfsm__struct__list__disp">fsm_struct_list_disp</link> d, int *p_chart)</para>
</listitem>
<listitem><para>int <link linkend="_disp__list_8c_1a37c1543ff68aa2a3c8dcfdc109bfb346">fsm_disp_get_chart</link> (<link linkend="_structfsm__struct__list__disp">fsm_struct_list_disp</link> d, int from, int to)</para>
</listitem>
<listitem><para>void <link linkend="_disp__list_8c_1a7df73ea7df9b1576679925a3f7ad7591">fsm_disp_remove_chart</link> (<link linkend="_structfsm__struct__list__disp">fsm_struct_list_disp</link> d, int *p_chart)</para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
2024-10-25 17:32:30 +02:00
<para>A list of displayable results (whether currently displayed or not). </para>
2024-10-25 17:32:30 +02:00
<para>This file is part of Gem-graph. The operations that can be performed on the results include: select, copy, erase, filter, concat, inverse, scale, correlate, etc.</para>
<para>The format of the results must be compatible with the formats recognised by the usual presentation software.</para>
<para>&quot;graph&quot;, &quot;chart&quot;, &quot;plot&quot; and &quot;diagram&quot; are ambiguous terms, used interchangeably.</para>
<para>NB some data may be displayed simultaneously in different pages ex : pages &apos;synth&apos; &amp; &apos;results&apos;</para>
<para><formalpara><title>See also</title>
<para>: fsm/measure/manage.c </para>
</formalpara>
</para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_disp__list_8c_1a9b206b4ea4932270d24f6b672301aa2b"/><section>
<title>fsm_disp_add_chart()</title>
<indexterm><primary>fsm_disp_add_chart</primary><secondary>disp_list.c</secondary></indexterm>
<indexterm><primary>disp_list.c</primary><secondary>fsm_disp_add_chart</secondary></indexterm>
<para><computeroutput>void fsm_disp_add_chart (<link linkend="_structfsm__struct__list__disp">fsm_struct_list_disp</link> d, int * p_chart)</computeroutput></para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>d</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>*p_chart</entry><entry>
<para></para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
<anchor xml:id="_disp__list_8c_1a37c1543ff68aa2a3c8dcfdc109bfb346"/><section>
<title>fsm_disp_get_chart()</title>
<indexterm><primary>fsm_disp_get_chart</primary><secondary>disp_list.c</secondary></indexterm>
<indexterm><primary>disp_list.c</primary><secondary>fsm_disp_get_chart</secondary></indexterm>
<para><computeroutput>int fsm_disp_get_chart (<link linkend="_structfsm__struct__list__disp">fsm_struct_list_disp</link> d, int from, int to)</computeroutput></para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>d</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>from</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>to</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>value </para>
</formalpara>
</para>
</section>
<anchor xml:id="_disp__list_8c_1a7df73ea7df9b1576679925a3f7ad7591"/><section>
<title>fsm_disp_remove_chart()</title>
<indexterm><primary>fsm_disp_remove_chart</primary><secondary>disp_list.c</secondary></indexterm>
<indexterm><primary>disp_list.c</primary><secondary>fsm_disp_remove_chart</secondary></indexterm>
<para><computeroutput>void fsm_disp_remove_chart (<link linkend="_structfsm__struct__list__disp">fsm_struct_list_disp</link> d, int * p_chart)</computeroutput></para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>d</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>*p_chart</entry><entry>
<para></para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
</section>
</section>