<title>Syntax</title>
<synopsis>sys = lincos(scs_m [,x0,u0 [,param] ])</synopsis>
</refsynopsisdiv>
- <refsection id="Module_lincos">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_lincos">
<title>Description</title>
<para>
</listitem>
</itemizedlist>
</refsection>
- <refsection id="SeeAlso_lincos">
- <title>See also</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="steadycos">steadycos - Finds an equilibrium state of a general dynamical system described by a xcos diagram (Scilab Function)</link>
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="scicos_simulate">scicos_simulate - Function for running xcos simulation in batch mode (Scilab Function)</link>
- </para>
- </listitem>
- </itemizedlist>
+ <refsection id="SeeAlso_lincos" role="see also">
+ <title>See Also</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="steadycos">steadycos</link>
+ </member>
+ <member>
+ <link linkend="scicos_simulate">scicos_simulate</link>
+ </member>
+ </simplelist>
</refsection>
</refentry>
</refnamediv>
<refsynopsisdiv>
<title>Syntax</title>
- <synopsis>Info=scicos_simulate(scs_m)</synopsis>
- <synopsis>Info=scicos_simulate(scs_m,Info)</synopsis>
- <synopsis>Info=scicos_simulate(scs_m,context)</synopsis>
- <synopsis>Info=scicos_simulate(scs_m,flag)</synopsis>
- <synopsis>Info=scicos_simulate(scs_m ,Info [, context] [,flag])</synopsis>
+ <synopsis>
+ Info=scicos_simulate(scs_m)
+ Info=scicos_simulate(scs_m,Info)
+ Info=scicos_simulate(scs_m,context)
+ Info=scicos_simulate(scs_m,flag)
+ Info=scicos_simulate(scs_m ,Info [, context] [,flag])
+ </synopsis>
</refsynopsisdiv>
<refsection id="Parameters_scicos_simulate">
<title>Arguments</title>
</varlistentry>
</variablelist>
</refsection>
- <refsection id="Module_scicos_simulate">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_scicos_simulate">
<title>Description</title>
<para>
]]></programlisting>
</refsection>
- <refsection id="SeeAlso_scicos_simulate">
+ <refsection id="SeeAlso_scicos_simulate" role="see also">
<title>See also</title>
<simplelist type="inline">
<member>
<title>Syntax</title>
<synopsis>[state,t] = scicosim(state,tcur,tf,sim,str,tol)</synopsis>
</refsynopsisdiv>
- <refsection id="Module_scicosim">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_scicosim">
<title>Description</title>
<para>
</listitem>
</itemizedlist>
</refsection>
- <refsection id="SeeAlso_scicosim">
+ <refsection id="SeeAlso_scicosim" role="see also">
<title>See also</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="scicos_simulate">scicos_simulate - Function for running xcos simulation in batch mode (Scilab Function)</link>
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="xcos">xcos - Block diagram editor and GUI for the hybrid simulator (Scilab Function)</link>
- </para>
- </listitem>
- </itemizedlist>
+ <simplelist type="inline">
+ <member>
+ <link linkend="scicos_simulate">scicos_simulate</link>
+ </member>
+ <member>
+ <link linkend="xcos">xcos</link>
+ </member>
+ </simplelist>
</refsection>
</refentry>
<title>Syntax</title>
<synopsis>[X,U,Y,XP]=steadycos(scs_m,X,U,Y,Indx,Indu,Indy [,Indxp [,param ] ])</synopsis>
</refsynopsisdiv>
- <refsection id="Module_steadycos">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_steadycos">
<title>Description</title>
<para>
</listitem>
</itemizedlist>
</refsection>
- <refsection id="SeeAlso_steadycos">
+ <refsection id="SeeAlso_steadycos" role="see also">
<title>See also</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="lincos">lincos - Constructs by linearization a linear state-space model from a general dynamical system described by a xcos diagram (Scilab Function)</link>
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="scicos_simulate">scicos_simulate - Function for running xcos simulation in batch mode (Scilab Function)</link>
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="xcos">xcos - Block diagram editor and GUI for the hybrid simulator (Scilab Function)</link>
- </para>
- </listitem>
- </itemizedlist>
+ <simplelist type="inline">
+ <member>
+ <link linkend="lincos">lincos></link>
+ </member>
+ <member>
+ <link linkend="scicos_simulate">scicos_simulate</link>
+ </member>
+ <member>
+ <link linkend="xcos">xcos</link>
+ </member>
+ </simplelist>
</refsection>
</refentry>
</varlistentry>
</variablelist>
</refsection>
- <refsection id="Module_xcosValidateBlockSet">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_xcosValidateBlockSet">
<title>Description</title>
This function is used to test if a Block interface function will not
]]></programlisting>
</para>
</refsection>
- <refsection id="SeeAlso_xcosValidateBlockSet">
+ <refsection id="SeeAlso_xcosValidateBlockSet" role="see also">
<title>See also</title>
<simplelist type="inline">
<member>
</varlistentry>
</variablelist>
</refsection>
- <refsection id="Module_xcosValidateCompareBlock">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_xcosValidateCompareBlock">
<title>Description</title>
This function is used to compare two Blocks.
]]></programlisting>
</para>
</refsection>
- <refsection id="SeeAlso_xcosValidateCompareBlock">
+ <refsection id="SeeAlso_xcosValidateCompareBlock" role="see also">
<title>See also</title>
<simplelist type="inline">
<member>
</varlistentry>
</variablelist>
</refsection>
- <refsection id="Module_xcos_simulate">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_xcos_simulate">
<title>Description</title>
This function is used to simulate xcos diagrams in batch
]]></programlisting>
</para>
</refsection>
- <refsection id="SeeAlso_xcos_simulate">
+ <refsection id="SeeAlso_xcos_simulate" role="see also">
<title>See also</title>
<simplelist type="inline">
<member>
<refsection id="Contents_C_macros">
<title>Contents</title>
<itemizedlist>
- <listitem>
- <para>
- <link linkend="C_macros">C_macros - Utilities C macros</link>
- </para>
- </listitem>
- <listitem>
- <itemizedlist>
- <listitem>
- <para>
- <xref linkend="Module_C_macros">Module</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Description_C_macros">Description</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Inputsoutputs_C_macros">Inputs/outputs</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Events_C_macros">Events</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Parameters_C_macros">Parameters</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Statesandwork_C_macros">States and work</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Zerocrossingsurfacesandmodes_C_macros">Zero crossing surfaces and modes</xref>
- </para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </refsection>
- <refsection id="Module_C_macros">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ <xref linkend="Description_C_macros">Description</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Inputsoutputs_C_macros">Inputs/outputs</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Events_C_macros">Events</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Parameters_C_macros">Parameters</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Statesandwork_C_macros">States and work</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Zerocrossingsurfacesandmodes_C_macros">Zero crossing surfaces and modes</xref>
+ </para>
+ </listitem>
+ </itemizedlist>
</refsection>
<refsection id="Description_C_macros">
<title>Description</title>
<refname>C_struct</refname>
<refpurpose>C Block structure of a computational function</refpurpose>
</refnamediv>
- <refsynopsisdiv>
- <title>Description</title>
- </refsynopsisdiv>
<refsection id="Contents_C_struct">
<title>Contents</title>
<itemizedlist>
- <listitem>
- <para>
- <link linkend="C_struct">C_struct - C Block structure of a computational function</link>
- </para>
- </listitem>
- <listitem>
- <itemizedlist>
- <listitem>
- <para>
- <xref linkend="Module_C_struct">Module</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Description_C_struct">Description</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Inputsoutputs_C_struct">Inputs/outputs</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Events_C_struct">Events</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Parameters_C_struct">Parameters</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Statesandwork_C_struct">States and work</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Zerocrossingsurfacesandmodes_C_struct">Zero crossing surfaces and modes</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Miscallaneous_C_struct">Miscallaneous</xref>
- </para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </refsection>
- <refsection id="Module_C_struct">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ <xref linkend="Description_C_struct">Description</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Inputsoutputs_C_struct">Inputs/outputs</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Events_C_struct">Events</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Parameters_C_struct">Parameters</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Statesandwork_C_struct">States and work</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Zerocrossingsurfacesandmodes_C_struct">Zero crossing surfaces and modes</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Miscellaneous_C_struct">Miscellaneous</xref>
+ </para>
+ </listitem>
+ </itemizedlist>
</refsection>
<refsection id="Description_C_struct">
<title>Description</title>
<para>
</para>
</refsection>
- <refsection id="Miscallaneous_C_struct">
- <title>Miscallaneous</title>
+ <refsection id="Miscellaneous_C_struct">
+ <title>Miscellaneous</title>
<itemizedlist>
<listitem>
<para>
<refname>C_utils</refname>
<refpurpose>Utilities C functions</refpurpose>
</refnamediv>
- <refsection id="Contents_C_utils">
- <title>Contents</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="C_utils">C_utils - Utilities C functions</link>
- </para>
- </listitem>
- <listitem>
- <itemizedlist>
- <listitem>
- <para>
- <xref linkend="Module_C_utils">Module</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Description_C_utils">Description</xref>
- </para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </refsection>
- <refsection id="Module_C_utils">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_C_utils">
<title>Description</title>
<para>
<refsection id="Contents_sci_struct">
<title>Contents</title>
<itemizedlist>
- <listitem>
- <para>
- <link linkend="sci_struct">sci_struct - Scicos block structure of a scilab computational function</link>
- </para>
- </listitem>
- <listitem>
- <itemizedlist>
- <listitem>
- <para>
- <xref linkend="Module_sci_struct">Module</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Description_sci_struct">Description</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Inputsoutputs_sci_struct">Inputs/outputs</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Events_sci_struct">Events</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Parameters_sci_struct">Parameters</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="States_sci_struct">States</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Zerocrossingsurfacesandmodes_sci_struct">Zero crossing surfaces and modes</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Miscallaneous_sci_struct">Miscallaneous</xref>
- </para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </refsection>
- <refsection id="Module_sci_struct">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ <xref linkend="Description_sci_struct">Description</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Inputsoutputs_sci_struct">Inputs/outputs</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Events_sci_struct">Events</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Parameters_sci_struct">Parameters</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="States_sci_struct">States</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Zerocrossingsurfacesandmodes_sci_struct">Zero crossing surfaces and modes</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Miscellaneous_sci_struct">Miscellaneous</xref>
+ </para>
+ </listitem>
+ </itemizedlist>
</refsection>
<refsection id="Description_sci_struct">
<title>Description</title>
</para>
</listitem>
</itemizedlist>
- <para>
-
- </para>
</refsection>
<refsection id="Events_sci_struct">
<title>Events</title>
<para>
-
- </para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
- <para>
-
</para>
</refsection>
<refsection id="Parameters_sci_struct">
<title>Arguments</title>
<para>
-
- </para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
- <para>
-
</para>
</refsection>
<refsection id="States_sci_struct">
<title>States</title>
<para>
-
- </para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
- <para>
-
</para>
</refsection>
<refsection id="Zerocrossingsurfacesandmodes_sci_struct">
</para>
</listitem>
</itemizedlist>
- <para>
-
- </para>
</refsection>
- <refsection id="Miscallaneous_sci_struct">
- <title>Miscallaneous</title>
+ <refsection id="Miscellaneous_sci_struct">
+ <title>Miscellaneous</title>
<para>
-
- </para>
<itemizedlist>
<listitem>
<para>
</para>
</listitem>
</itemizedlist>
- <para>
-
</para>
</refsection>
</refentry>
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="curblock">
<refnamediv>
<refname>curblock</refname>
- <refpurpose>Return the current called xcos block during the simulation</refpurpose>
+ <refpurpose>Returns the current called xcos block during the simulation</refpurpose>
</refnamediv>
- <refsection id="Module_curblock">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- <programlisting role="example"><![CDATA[
-blk=curblock()
- ]]></programlisting>
- </refsection>
+ <refsynopsisdiv>
+ <title>Syntax</title>
+ <synopsis>
+ blk = curblock()
+ </synopsis>
+ </refsynopsisdiv>
<refsection id="Parameters_curblock">
<title>Arguments</title>
<itemizedlist>
<refname>getblocklabel</refname>
<refpurpose>Get the label of a scicos block</refpurpose>
</refnamediv>
- <refsection id="Module_getblocklabel">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- <programlisting role="example"><![CDATA[
-[label]=getblocklabel(blk)
- ]]></programlisting>
- </refsection>
+ <refsynopsisdiv>
+ <title>Syntax</title>
+ <synopsis>
+ label = getblocklabel(blk)
+ </synopsis>
+ </refsynopsisdiv>
<refsection id="Parameters_getblocklabel">
<title>Arguments</title>
<itemizedlist>
</refnamediv>
<refsynopsisdiv>
<title>Syntax</title>
- <synopsis>[myvar]=getscicosvars(str) [myvar]=getscicosvars([str1;str2;...])</synopsis>
+ <synopsis>
+ myvar = getscicosvars(str)
+ myvar =getscicosvars([str1;str2;...])
+ </synopsis>
</refsynopsisdiv>
- <refsection id="Module_getscicosvars">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_getscicosvars">
<title>Description</title>
<para>That utility function is used to retrieve working arrays of Scicos
</para>
<para/>
<programlisting role="example">
- [myvar]=getscicosvars(str)
- [myvar]=getscicosvars([str1;str2;...])
+ myvar = getscicosvars(str)
+ myvar = getscicosvars([str1;str2;...])
</programlisting>
</refsection>
<refsection id="Parameters_getscicosvars">
</listitem>
</itemizedlist>
</refsection>
- <refsection id="SeeAlso_getscicosvars">
+ <refsection id="SeeAlso_getscicosvars" role="see also">
<title>See also</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="scicos_debug">DEBUG - Debug block (Scicos
- Block)
- </link>
- </para>
- </listitem>
- </itemizedlist>
+ <simplelist type="inline">
+ <member>
+ <link linkend="scicos_debug">scicos_debug</link>
+ </member>
+ </simplelist>
</refsection>
</refentry>
</refnamediv>
<refsynopsisdiv>
<title>Syntax</title>
- <synopsis>[psim]=phase_simulation()</synopsis>
+ <synopsis>psim = phase_simulation()</synopsis>
</refsynopsisdiv>
- <refsection id="Module_phase_simulation">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
- <refsection id="Description_phase_simulation">
- <title>Description</title>
- <para>
- That function says if the Scicos simulator is realizing the time domain integration.
- </para>
- <para>
- </para>
- <programlisting role="example"><![CDATA[
-[psim]=phase_simulation()
- ]]></programlisting>
- </refsection>
<refsection id="Parameters_phase_simulation">
<title>Arguments</title>
<itemizedlist>
</listitem>
</itemizedlist>
</refsection>
+ <refsection id="Description_phase_simulation">
+ <title>Description</title>
+ <para>
+ That function says if the Scicos simulator is realizing the time domain integration.
+ </para>
+ <para>
+ <programlisting role="example"><![CDATA[
+psim = phase_simulation()
+ ]]></programlisting>
+ </para>
+ </refsection>
</refentry>
</refnamediv>
<refsynopsisdiv>
<title>Syntax</title>
- <synopsis>[xprop] = pointer_xproperty()</synopsis>
+ <synopsis>xprop = pointer_xproperty()</synopsis>
</refsynopsisdiv>
- <refsection id="Module_pointer_xproperty">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
- <refsection id="Description_pointer_xproperty">
- <title>Description</title>
- <para>
- This function returns a vector that informs the type (algebraic or differential) of the continuous state variables of a block.
- </para>
- <para>
- </para>
- <programlisting role="example"><![CDATA[
-[xprop]=pointer_xproperty()
- ]]></programlisting>
- </refsection>
<refsection id="Parameters_pointer_xproperty">
<title>Arguments</title>
<itemizedlist>
<para>
<emphasis role="bold">xprop</emphasis>
</para>
- <para> The value gives the type of the states :</para>
+ <para> The value gives the type of the states :
<itemizedlist>
<listitem>
<para>-1 : an algebraic state.
</para>
</listitem>
</itemizedlist>
+ </para>
</listitem>
</itemizedlist>
</refsection>
- <refsection id="SeeAlso_pointer_xproperty">
+ <refsection id="Description_pointer_xproperty">
+ <title>Description</title>
+ <para>
+ This function returns a vector that informs the type (algebraic or differential) of the continuous state variables of a block.
+ </para>
+ <para>
+ <programlisting role="example"><![CDATA[
+[xprop]=pointer_xproperty()
+ ]]></programlisting>
+ </para>
+ </refsection>
+ <refsection id="SeeAlso_pointer_xproperty" role="see also">
<title>See also</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="set_xproperty">set_xproperty - Set the type of a continuous time state variable (Scilab Function)</link>
- </para>
- </listitem>
- </itemizedlist>
+ <simplelist type="inline">
+ <member>
+ <link linkend="set_xproperty">set_xproperty</link>
+ </member>
+ </simplelist>
</refsection>
</refentry>
<refname>scicos_time</refname>
<refpurpose>Returns the current time during simulation</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_time">
- <title>Module</title>
+ <refsection id="Parameters_scicos_time">
+ <title>Arguments</title>
<itemizedlist>
<listitem>
<para>
- <link linkend="xcos">xcos</link>
+ <emphasis role="bold">t:</emphasis> that is the current simulated time returned in real number.
</para>
</listitem>
</itemizedlist>
t=scicos_time()
]]></programlisting>
</refsection>
- <refsection id="Parameters_scicos_time">
- <title>Arguments</title>
- <itemizedlist>
- <listitem>
- <para>
- <emphasis role="bold">t:</emphasis> that is the current simulated time returned in real number.
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
</refentry>
<title>Syntax</title>
<synopsis>set_blockerror(n)</synopsis>
</refsynopsisdiv>
- <refsection id="Module_set_blockerror">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
- <refsection id="Description_set_blockerror">
- <title>Description</title>
- <para>
- Function to set a specific error during the simulation for the current block. If it is used, then after the execution of the computational function of the block, the simulator will end and will return an error message associated to the number given in argument.
- </para>
- <para>
- </para>
- <programlisting role="example"><![CDATA[
-set_blockerror(n)
- ]]></programlisting>
- </refsection>
<refsection id="Parameters_set_blockerror">
<title>Arguments</title>
<itemizedlist>
</para>
<para>
cannot allocate memory in block
-
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</refsection>
+ <refsection id="Description_set_blockerror">
+ <title>Description</title>
+ <para>
+ Function to set a specific error during the simulation for the current block. If it is
+ used, then after the execution of the computational function of the block, the simulator
+ will end and will return an error message associated to the number given in argument.
+ </para>
+ <para>
+ <programlisting role="example"><![CDATA[
+set_blockerror(n)
+ ]]></programlisting>
+ </para>
+ </refsection>
</refentry>
<title>Syntax</title>
<synopsis>set_xproperty(xprop)</synopsis>
</refsynopsisdiv>
- <refsection id="Module_set_xproperty">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
- <refsection id="Description_set_xproperty">
- <title>Description</title>
- <para>
- This function set a vector to inform the type (algebraic or differential) of the continuous state variables of a block.
- </para>
- <para>
- </para>
- <programlisting role="example"><![CDATA[
-set_xproperty(xprop)
- ]]></programlisting>
- </refsection>
<refsection id="Parameters_set_xproperty">
<title>Arguments</title>
<itemizedlist>
</listitem>
</itemizedlist>
</refsection>
- <refsection id="SeeAlso_set_xproperty">
+ <refsection id="Description_set_xproperty">
+ <title>Description</title>
+ <para>
+ This function set a vector to inform the type (algebraic or differential) of the continuous state variables of a block.
+ </para>
+ <para>
+ <programlisting role="example"><![CDATA[
+set_xproperty(xprop)
+ ]]></programlisting>
+ </para>
+ </refsection>
+ <refsection id="SeeAlso_set_xproperty" role="see also">
<title>See also</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="pointer_xproperty">pointer_xproperty - Get the type of a continuous time state variable (Scilab Function)</link>
- </para>
- </listitem>
- </itemizedlist>
+ <simplelist type="inline">
+ <member>
+ <link linkend="pointer_xproperty">pointer_xproperty</link>
+ </member>
+ </simplelist>
</refsection>
</refentry>
<refname>scicos_block</refname>
<refpurpose>Define a block structure</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_block">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="block_scicos_block">
<title>block</title>
<para>
<refname>scicos_cpr</refname>
<refpurpose>Compiled Scicos structure</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_cpr">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="cpr_scicos_cpr">
<title>cpr</title>
<para>
<refname>scicos_diagram</refname>
<refpurpose>Define a scs_m structure</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_diagram">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="diagram_scicos_diagram">
<title>diagram</title>
<para>
<refname>scicos_graphics</refname>
<refpurpose>Define an Xcos block graphics structure</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_graphics">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsect1 id="graphics_scicos_graphics">
<title>graphics</title>
<para>
<refname>scicos_link</refname>
<refpurpose>Define a link structure</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_link">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsect1 id="link_scicos_link">
<title>link</title>
<para>Basic structure that define a xcos link.</para>
<refname>scicos_model</refname>
<refpurpose>Define a model structure</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_model">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsect1 id="model_scicos_model">
<title>model</title>
<para>
<refname>scicos_params</refname>
<refpurpose>Define a param structure</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_params">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsect1 id="params_scicos_params">
<title>params</title>
<para>Diagram configuration values. Some of the value are graphical information, others directly configure the simulator.</para>
<refname>scicos_sim</refname>
<refpurpose>Define a sim structure</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_sim">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="sim_scicos_sim">
<title>sim</title>
<para>
<refname>scicos_state</refname>
<refpurpose>Define a state structure</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_state">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="state_scicos_state">
<title>state</title>
<para>
<title>Syntax</title>
<synopsis>[outtb]=buildouttb(lnksz,lnktyp)</synopsis>
</refsynopsisdiv>
- <refsection id="Module_buildouttb">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_buildouttb">
<title>Description</title>
<para>
<title>Syntax</title>
<synopsis>[result]=importXcosDiagram(filename)</synopsis>
</refsynopsisdiv>
- <refsection id="Module_importXcosDiagram">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_importXcosDiagram">
<title>Description</title>
<para>Import a Xcos file into Scilab.</para>
<title>Syntax</title>
<synopsis>loadScicos()</synopsis>
</refsynopsisdiv>
- <refsection id="Module_loadScicos">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_loadScicos">
<title>Description</title>
<para>The Xcos simulation need a native shared library. This call force the loading this library</para>
</refsection>
- <refsection id="Parameters_loadScicos">
- <title>Arguments</title>
- <para>None</para>
- </refsection>
<refsection id="Example_loadScicos">
<title>Example</title>
<programlisting role="example">loadScicos();</programlisting>
</refsection>
- <refsection id="SeeAlso_loadScicos">
- <title>See also</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">
- <programlisting>xcos</programlisting> - Hybrid dynamic systems modeler and simulator.
- </link>
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="loadXcosLibs">
- <programlisting>loadXcosLibs</programlisting> - Load the blocks macros libraries.
- </link>
- </para>
- </listitem>
- </itemizedlist>
+ <refsection id="SeeAlso_loadScicos" role="see also">
+ <title>See Also</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="xcos">xcos</link>
+ </member>
+ <member>
+ <link linkend="loadXcosLibs">loadXcosLibs</link>
+ </member>
+ </simplelist>
</refsection>
</refentry>
<title>Syntax</title>
<synopsis>loadXcosLibs()</synopsis>
</refsynopsisdiv>
- <refsection id="Module_loadXcosLibs">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_loadXcosLibs">
<title>Description</title>
<para>Import some useful Xcos macros into Scilab.</para>
typeof(SUM_f)
]]></programlisting>
</refsection>
- <refsection id="SeeAlso_loadXcos">
- <title>See also</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">
- <programlisting>xcos</programlisting> - Hybrid dynamic systems modeler and simulator.
- </link>
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="loadScicos">
- <programlisting>loadScicos</programlisting> - Load the simulation native libraries.
- </link>
- </para>
- </listitem>
- </itemizedlist>
+ <refsection id="SeeAlso_loadXcosLibs">
+ <title>See Also</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="xcos">xcos</link>
+ </member>
+ <member>
+ <link linkend="loadScicos">loadScicos</link>
+ </member>
+ </simplelist>
</refsection>
-
<refsection>
<title>History</title>
<revhistory>
</refnamediv>
<refsynopsisdiv>
<title>Syntax</title>
- <synopsis>scs_m = scicosDiagramToScilab(filename)</synopsis>
- <synopsis>[scs_m1, scs_m2, ...] = scicosDiagramToScilab([filename1, filename2, ...])</synopsis>
- <synopsis/>
- <synopsis>scicosDiagramToScilab(filename, scs_m)</synopsis>
- <synopsis>scicosDiagramToScilab([filename1, filename2, ...], scs_m1, scs_m2)</synopsis>
+ <synopsis>
+ scs_m = scicosDiagramToScilab(filename)
+ [scs_m1, scs_m2, ...] = scicosDiagramToScilab([filename1, filename2, ...])
+
+ scicosDiagramToScilab(filename, scs_m)
+ scicosDiagramToScilab([filename1, filename2, ...], scs_m1, scs_m2)
+ </synopsis>
</refsynopsisdiv>
- <refsection id="Module_scicosDiagramToScilab">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Parameters_scicosDiagramToScilab">
<title>Arguments</title>
<itemizedlist>
level = scicos_debug()
</synopsis>
</refsynopsisdiv>
- <refsection id="Module_scicos_debug">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
- <refsection id="Description_scicos_debug">
- <title>Description</title>
- <para>
- This Scilab function is used to set the debug level of a Scicos simulation.
- </para>
- <para>
- One can used it in the "Calc" mode of the Scicos editor or as an instruction in a Scilab block or in an interfacing function.
- </para>
- </refsection>
- <refsection>
- <title>Examples</title>
- <programlisting role="example"><![CDATA[
-scicos_debug(level)
-level=scicos_debug()
- ]]></programlisting>
- </refsection>
<refsection id="Parameters_scicos_debug">
<title>Arguments</title>
<itemizedlist>
</listitem>
</itemizedlist>
</refsection>
+ <refsection id="Description_scicos_debug">
+ <title>Description</title>
+ <para>
+ This Scilab function is used to set the debug level of a Scicos simulation.
+ </para>
+ <para>
+ One can used it in the "Calc" mode of the Scicos editor or as an instruction in a Scilab block or in an interfacing function.
+ </para>
+ </refsection>
+ <refsection>
+ <title>Examples</title>
+ <programlisting role="example"><![CDATA[
+scicos_debug(level)
+level=scicos_debug()
+ ]]></programlisting>
+ </refsection>
</refentry>
<title>Syntax</title>
<synopsis>vec = var2vec(var)</synopsis>
</refsynopsisdiv>
- <refsection id="Module_var2vec">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Parameters_var2vec">
<title>Arguments</title>
<itemizedlist>
<title>Syntax</title>
<synopsis>var = vec2var(vec)</synopsis>
</refsynopsisdiv>
- <refsection id="Module_vec2var">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Parameters_vec2var">
<title>Arguments</title>
<itemizedlist>
<title>Syntax</title>
<synopsis>xcosAddToolsMenu(label, command)</synopsis>
</refsynopsisdiv>
- <refsection id="Module_xcosAddToolsMenu">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_xcosAddToolsMenu">
<title>Description</title>
<para>Add a menu into Xcos with a scilab command. The scilab command can assume that there is two variable on the current scilab context :</para>
</para>
</refsection>
<refsection id="SeeAlso_xcosAddToolsMenu">
- <title>See also</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="xcosUpdateBlock">xcosUpdateBlock - Update a block instance</link>
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="scicos_block">scicos_block.</link>
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="scicos_diagram">scicos_diagram</link>
- </para>
- </listitem>
- </itemizedlist>
+ <title>See Also</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="xcos">xcos</link>
+ </member>
+ <member>
+ <link linkend="xcosUpdateBlock">xcosUpdateBlock</link>
+ </member>
+ <member>
+ <link linkend="scicos_block">scicos_block</link>
+ </member>
+ <member>
+ <link linkend="scicos_diagram">scicos_diagram</link>
+ </member>
+ </simplelist>
</refsection>
<refsection id="Authors_xcosAddToolsMenu">
<title>Authors</title>
</refnamediv>
<refsynopsisdiv>
<title>Syntax</title>
- <synopsis>scs_m = xcosDiagramToScilab(filename)</synopsis>
- <synopsis>[scs_m1, scs_m2, ...] = xcosDiagramToScilab([filename1, filename2, ...])</synopsis>
- <synopsis/>
- <synopsis>xcosDiagramToScilab(filename, scs_m)</synopsis>
- <synopsis>xcosDiagramToScilab([filename1, filename2, ...], scs_m1, scs_m2)</synopsis>
+ <synopsis>
+ scs_m = xcosDiagramToScilab(filename)
+ [scs_m1, scs_m2, ...] = xcosDiagramToScilab([filename1, filename2, ...])
+
+ xcosDiagramToScilab(filename, scs_m)
+ xcosDiagramToScilab([filename1, filename2, ...], scs_m1, scs_m2)
+ </synopsis>
</refsynopsisdiv>
- <refsection id="Module_xcosDiagramToScilab">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Parameters_xcosDiagramToScilab">
<title>Arguments</title>
<itemizedlist>
</programlisting>
</refsection>
<refsection id="SeeAlso_xcosDiagramToScilab">
- <title role="see also">See also</title>
- <itemizedlist>
- <listitem>
- <link linkend="scicos_diagram">scicos_diagram</link>
- </listitem>
- <listitem>
+ <title role="see also">See Also</title>
+ <simplelist type="inline">
+ <member>
<link linkend="xcos">xcos</link>
- </listitem>
- <listitem>
+ </member>
+ <member>
+ <link linkend="scicos_diagram">scicos_diagram</link>
+ </member>
+ <member>
<link linkend="importXcosDiagram">importXcosDiagram</link>
- </listitem>
- </itemizedlist>
+ </member>
+ </simplelist>
</refsection>
</refentry>
xcosPalGenerateAllIcons(["Palettes" "Recently Used Blocks"]);
]]></programlisting>
</refsection>
- <refsection>
- <title>History</title>
- <revhistory>
- <revision>
- <revnumber>5.4.1</revnumber>
- <revremark>
- Function added.
- </revremark>
- </revision>
- </revhistory>
- </refsection>
<refsection role="see also">
<title>See also</title>
<simplelist type="inline">
</member>
</simplelist>
</refsection>
+ <refsection>
+ <title>History</title>
+ <revhistory>
+ <revision>
+ <revnumber>5.4.1</revnumber>
+ <revremark>
+ Function added.
+ </revremark>
+ </revision>
+ </revhistory>
+ </refsection>
</refentry>
<title>Syntax</title>
<synopsis>xcosUpdateBlock(blk)</synopsis>
</refsynopsisdiv>
- <refsection id="Module_xcosUpdateBlock">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_xcosUpdateBlock">
<title>Description</title>
<para>Update a block on a currently opened diagram.</para>
xcos(scs_m_list)
</synopsis>
</refsynopsisdiv>
- <refsection id="Module_xcos">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Parameters_xcos">
<title>Arguments</title>
<itemizedlist>
<emphasis>Xcos</emphasis> window.
</para>
<itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos_menu_entries">Xcos editor menu entries</link>
- </para>
- </listitem>
- <listitem>
- <itemizedlist>
- <listitem>
- <para>
- <xref linkend="Filemenu_Menu_entries">File menu</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Editmenu_Menu_entries">Edit menu</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Viewmenu_Menu_entries">View menu</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Simulatemenu_Menu_entries">Simulate menu</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Formatmenu_Menu_entries">Format menu</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Toolsmenu_Menu_entries">Tools menu</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Helpmenu_Menu_entries">? menu</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Seealso_Menu_entries">See also</xref>
- </para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ <xref linkend="Filemenu_Menu_entries">File menu</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Editmenu_Menu_entries">Edit menu</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Viewmenu_Menu_entries">View menu</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Simulatemenu_Menu_entries">Simulate menu</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Formatmenu_Menu_entries">Format menu</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Toolsmenu_Menu_entries">Tools menu</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Helpmenu_Menu_entries">? menu</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Seealso_Menu_entries">See also</xref>
+ </para>
+ </listitem>
+ </itemizedlist>
</refsection>
<refsection id="Filemenu_Menu_entries">
<title>File menu</title>
<title>Séquence d'appel</title>
<synopsis>xcosAddToolsMenu(label, command)</synopsis>
</refsynopsisdiv>
- <refsection id="Module_xcosAddToolsMenu">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_xcosAddToolsMenu">
<title>Description</title>
<para>Ajoute un menu à Xcos qui exécute une commande scilab. La commande scilab peut utiliser deux variables définies dans le contexte scilab :</para>
</refsection>
<refsection id="SeeAlso_xcosAddToolsMenu">
<title>Voir aussi</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos - Editeur de schéma-bloc et IHM pour le simulateur hybride</link>
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="scicos_block">scicos_block - Block type.</link>
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="scicos_diagram">scicos_diagram - Diagram type.</link>
- </para>
- </listitem>
- </itemizedlist>
+ <simplelist type="inline">
+ <member>
+ <link linkend="xcos">xcos</link>
+ </member>
+ <member>
+ <link linkend="xcosUpdateBlock">xcosUpdateBlock</link>
+ </member>
+ <member>
+ <link linkend="scicos_block">scicos_block</link>
+ </member>
+ <member>
+ <link linkend="scicos_diagram">scicos_diagram</link>
+ </member>
+ </simplelist>
</refsection>
<refsection id="Authors_xcosAddToolsMenu">
<title>Authors</title>
<title>Séquence d'appel</title>
<synopsis>xcosUpdateBlock(blk)</synopsis>
</refsynopsisdiv>
- <refsection id="Module_xcosUpdateBlock">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_xcosUpdateBlock">
<title>Description</title>
<para>Met à jour un bloc dans un diagram ouvert</para>
<link linkend="DDaskr">DDaskr</link>
</member>
<member>
- <link linkend="Comparaisons">Comparaisons</link>
+ <link linkend="Comparisons">Comparaisons</link>
</member>
<member>
<link linkend="ode">ode</link>
<link linkend="DDaskr">DDaskr</link>
</member>
<member>
- <link linkend="Comparaisons">Comparaisons</link>
+ <link linkend="Comparisons">Comparaisons</link>
</member>
<member>
<link linkend="ode">ode</link>
<link linkend="DDaskr">DDaskr</link>
</member>
<member>
- <link linkend="Comparaisons">Comparaisons</link>
+ <link linkend="Comparisons">Comparaisons</link>
</member>
<member>
<link linkend="ode">ode</link>
<link linkend="DDaskr">DDaskr</link>
</member>
<member>
- <link linkend="Comparaisons">Comparaisons</link>
+ <link linkend="Comparisons">Comparaisons</link>
</member>
<member>
<link linkend="ode_discrete">ode_discrete</link>
<link linkend="DDaskr">DDaskr</link>
</member>
<member>
- <link linkend="Comparaisons">Comparaisons</link>
+ <link linkend="Comparisons">Comparaisons</link>
</member>
<member>
<link linkend="ode_discrete">ode_discrete</link>
<link linkend="DDaskr">DDaskr</link>
</member>
<member>
- <link linkend="Comparaisons">Comparaisons</link>
+ <link linkend="Comparisons">Comparaisons</link>
</member>
<member>
<link linkend="ode">ode</link>
<link linkend="CRANI">Crank-Nicolson 2(3)</link>
</member>
<member>
- <link linkend="Comparaisons">Comparaisons</link>
+ <link linkend="Comparisons">Comparaisons</link>
</member>
<member>
<link linkend="daskr">daskr</link>
<link linkend="DDaskr">DDaskr</link>
</member>
<member>
- <link linkend="Comparaisons">Comparaisons</link>
+ <link linkend="Comparisons">Comparaisons</link>
</member>
<member>
<link linkend="ode">ode</link>
* For more information, see the COPYING file which you should have received
* along with this program.
-->
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="fr_FR" xml:id="Comparaisons">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="fr_FR" xml:id="Comparisons">
<refnamediv>
<refname>Comparaisons</refname>
<refpurpose>
xcos(scs_m_list)
</synopsis>
</refsynopsisdiv>
- <refsection id="Module_xcos">
- <title>Module</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Parameters_xcos">
<title>Paramètres</title>
<itemizedlist>
bloc, une liaison ou dans la fenêtre principale de <emphasis>Xcos</emphasis> window.
</para>
<itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos_menu_entries">Entrées de menu de l'éditeur Xcos</link>
- </para>
- </listitem>
- <listitem>
- <itemizedlist>
- <listitem>
- <para>
- <xref linkend="Filemenu_Menu_entries">Menu Fichier</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Editmenu_Menu_entries">Menu Édition</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Viewmenu_Menu_entries">Menu Affichage</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Simulatemenu_Menu_entries">Menu Simulation</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Formatmenu_Menu_entries">Menu Format</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Toolsmenu_Menu_entries">Menu Outils</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Helpmenu_Menu_entries">Menu ?</xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Seealso_Menu_entries">Voir aussi </xref>
- </para>
- </listitem>
- <listitem>
- <para>
- <xref linkend="Authors_Menu_entries">Auteurs</xref>
- </para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para>
+ <xref linkend="Filemenu_Menu_entries">Menu Fichier</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Editmenu_Menu_entries">Menu Édition</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Viewmenu_Menu_entries">Menu Affichage</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Simulatemenu_Menu_entries">Menu Simulation</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Formatmenu_Menu_entries">Menu Format</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Toolsmenu_Menu_entries">Menu Outils</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Helpmenu_Menu_entries">Menu ?</xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Seealso_Menu_entries">Voir aussi </xref>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Authors_Menu_entries">Auteurs</xref>
+ </para>
+ </listitem>
+ </itemizedlist>
</refsection>
<refsection id="Filemenu_Menu_entries">
<title>Menu Fichier</title>
</refsynopsisdiv>
- <refsection id="Module_lincos">
-
- <title>モジュール</title>
-
- <itemizedlist>
-
- <listitem>
-
- <para>
-
- <link linkend="xcos">xcos</link>
-
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </refsection>
-
<refsection id="Description_lincos">
<title>説明</title>
</refsection>
- <refsection id="SeeAlso_lincos">
+ <refsection id="SeeAlso_lincos" role="see also">
<title>参照</title>
-
- <itemizedlist>
-
- <listitem>
-
- <para>
-
- <link linkend="steadycos">steadycos -
-
- xcosダイアグラムで記述された一般の動的システムの状態変数の定常値を見つけます
-
- (Scilab関数)
-
- </link>
-
- </para>
-
- </listitem>
-
- <listitem>
-
- <para>
-
- <link linkend="scicos_simulate">scicos_simulate -
-
- xcosシミュレーションをバッチモードで実行する関数 (Scilab 関数)
-
- </link>
-
- </para>
-
- </listitem>
-
- </itemizedlist>
+ <simplelist type="inline">
+ <member>
+ <link linkend="steadycos">steadycos</link>
+ </member>
+ <member>
+ <link linkend="scicos_simulate">scicos_simulate</link>
+ </member>
+ </simplelist>
</refsection>
<title>呼び出し手順</title>
- <synopsis>Info=scicos_simulate(scs_m)</synopsis>
-
- <synopsis>Info=scicos_simulate(scs_m,Info)</synopsis>
-
- <synopsis>Info=scicos_simulate(scs_m,context)</synopsis>
-
- <synopsis>Info=scicos_simulate(scs_m,flag)</synopsis>
-
- <synopsis>Info=scicos_simulate(scs_m ,Info [, context] [,flag])</synopsis>
-
+ <synopsis>
+ Info=scicos_simulate(scs_m)
+ Info=scicos_simulate(scs_m,Info)
+ Info=scicos_simulate(scs_m,context)
+ Info=scicos_simulate(scs_m,flag)
+ Info=scicos_simulate(scs_m ,Info [, context] [,flag])
+ </synopsis>
</refsynopsisdiv>
<refsection id="Parameters_scicos_simulate">
</refsection>
- <refsection id="Module_scicos_simulate">
-
- <title>モジュール</title>
-
- <itemizedlist>
-
- <listitem>
-
- <para>
-
- <link linkend="xcos">xcos</link>
-
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </refsection>
-
<refsection id="Description_scicos_simulate">
<title>説明</title>
</refsection>
- <refsection id="SeeAlso_scicos_simulate">
+ <refsection id="SeeAlso_scicos_simulate" role="see also">
<title>参照</title>
<title>呼び出し手順</title>
<synopsis>[state,t] = scicosim(state,tcur,tf,sim,str,tol)</synopsis>
</refsynopsisdiv>
- <refsection id="Module_scicosim">
- <title>モジュール</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_scicosim">
<title>説明</title>
<para>
</listitem>
</itemizedlist>
</refsection>
- <refsection id="SeeAlso_scicosim">
+ <refsection id="SeeAlso_scicosim" role="see also">
<title>参照</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="scicos_simulate">scicos_simulate -
- xcosシミュレーションをバッチモードで実行する関数 (Scilab 関数)
- </link>
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="xcos">xcos -
- ハイブリッドシミュレータ用のブロックダイアグラムエディタおよびGUI (Scilab関数)
- </link>
- </para>
- </listitem>
- </itemizedlist>
+ <simplelist type="inline">
+ <member>
+ <link linkend="scicos_simulate">scicos_simulate</link>
+ </member>
+ <member>
+ <link linkend="xcos">xcos</link>
+ </member>
+ </simplelist>
</refsection>
</refentry>
</refsynopsisdiv>
- <refsection id="Module_steadycos">
-
- <title>モジュール</title>
-
- <itemizedlist>
-
- <listitem>
-
- <para>
-
- <link linkend="xcos">xcos</link>
-
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </refsection>
-
<refsection id="Description_steadycos">
<title>説明</title>
</refsection>
- <refsection id="SeeAlso_steadycos">
+ <refsection id="SeeAlso_steadycos" role="see also">
<title>参照</title>
-
- <itemizedlist>
-
- <listitem>
-
- <para>
-
- <link linkend="lincos">lincos - xcosダイアグラムで記述された一般の動的システムから線形化により線形状態空間モデルを構築する (Scilab 関数)</link>
-
- </para>
-
- </listitem>
-
- <listitem>
-
- <para>
-
- <link linkend="scicos_simulate">scicos_simulate - xcosシミュレーションをバッチモードで実行する関数 (Scilab 関数)</link>
-
- </para>
-
- </listitem>
-
- <listitem>
-
- <para>
-
- <link linkend="xcos">xcos - ブロックダイアグラムエディタおよびハイブリッドシミュレータのGUI (Scilab 関数)</link>
-
- </para>
-
- </listitem>
-
- </itemizedlist>
-
+ <simplelist type="inline">
+ <member>
+ <link linkend="lincos">lincos</link>
+ </member>
+ <member>
+ <link linkend="scicos_simulate">scicos_simulate</link>
+ </member>
+ <member>
+ <link linkend="xcos">xcos</link>
+ </member>
+ </simplelist>
</refsection>
</refentry>
</varlistentry>
</variablelist>
</refsection>
- <refsection id="Module_xcosValidateBlockSet">
- <title>モジュール</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_xcosValidateBlockSet">
<title>説明</title>
この関数は,ブロックインターフェイス関数がxcosシミュレーションプロセスにコールされた
]]></programlisting>
</para>
</refsection>
- <refsection id="SeeAlso_xcosValidateBlockSet">
+ <refsection id="SeeAlso_xcosValidateBlockSet" role="see also">
<title>参照</title>
<simplelist type="inline">
<member>
</varlistentry>
</variablelist>
</refsection>
- <refsection id="Module_xcosValidateCompareBlock">
- <title>モジュール</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_xcosValidateCompareBlock">
<title>説明</title>
この関数は2つのブロックを比較する際に使用されます.
]]></programlisting>
</para>
</refsection>
- <refsection id="SeeAlso_xcosValidateCompareBlock">
+ <refsection id="SeeAlso_xcosValidateCompareBlock" role="see also">
<title>参照</title>
<simplelist type="inline">
<member>
</varlistentry>
</variablelist>
</refsection>
- <refsection id="Module_xcos_simulate">
- <title>モジュール</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="Description_xcos_simulate">
<title>説明</title>
この関数は,xcosダイアグラムをバッチモードでシミュレートする際に
]]></programlisting>
</para>
</refsection>
- <refsection id="SeeAlso_xcos_simulate">
+ <refsection id="SeeAlso_xcos_simulate" role="see also">
<title>参照</title>
<simplelist type="inline">
<member>
<refname>scicos_block</refname>
<refpurpose>ブロック構造を定義</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_block">
- <title>モジュール</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="block_scicos_block">
<title>block</title>
<para>
<refname>scicos_cpr</refname>
<refpurpose>コンパイル済みのScicos構造体</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_cpr">
- <title>モジュール</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="cpr_scicos_cpr">
<title>cpr</title>
<para>
<refname>scicos_diagram</refname>
<refpurpose>scs_m構造体の定義</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_diagram">
- <title>モジュール</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="diagram_scicos_diagram">
<title>diagram</title>
<para>
</refnamediv>
- <refsection id="Module_scicos_graphics">
-
- <title>Module</title>
-
- <itemizedlist>
-
- <listitem>
-
- <para>
-
- <link linkend="xcos">xcos</link>
-
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </refsection>
-
<refsection id="graphics_scicos_graphics">
<title>graphics</title>
<refname>scicos_link</refname>
<refpurpose>link構造体の定義</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_link">
- <title>モジュール</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="link_scicos_link">
<title>link</title>
<para>
</refnamediv>
- <refsection id="Module_scicos_model">
-
- <title>モジュール</title>
-
- <itemizedlist>
-
- <listitem>
-
- <para>
-
- <link linkend="xcos">xcos</link>
-
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </refsection>
-
<refsection id="model_scicos_model">
<title>モデル</title>
<refname>scicos_params</refname>
<refpurpose>param構造体の定義</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_params">
- <title>モジュール</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="params_scicos_params">
<title>params</title>
<para>
<refname>scicos_sim</refname>
<refpurpose>sim構造体の定義</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_sim">
- <title>モジュール</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="sim_scicos_sim">
<title>sim</title>
<para>
<refname>scicos_state</refname>
<refpurpose>state構造体の定義</refpurpose>
</refnamediv>
- <refsection id="Module_scicos_state">
- <title>モジュール</title>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xcos">xcos</link>
- </para>
- </listitem>
- </itemizedlist>
- </refsection>
<refsection id="state_scicos_state">
<title>state</title>
<para>
</refsynopsisdiv>
- <refsection id="Module_xcos">
-
- <title>モジュール</title>
-
- <itemizedlist>
-
- <listitem>
-
- <para>
-
- <link linkend="xcos">xcos</link>
-
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </refsection>
-
<refsection id="Parameters_xcos">
<title>引数</title>
</para>
<itemizedlist>
+ <listitem>
- <listitem>
-
- <para>
-
- <link linkend="xcos_menu_entries">Xcosエディタメニューエントリ</link>
-
- </para>
-
- </listitem>
-
- <listitem>
-
- <itemizedlist>
-
- <listitem>
+ <para>
- <para>
+ <xref linkend="Filemenu_Menu_entries">Fileメニュー</xref>
- <xref linkend="Filemenu_Menu_entries">Fileメニュー</xref>
+ </para>
- </para>
+ </listitem>
- </listitem>
+ <listitem>
- <listitem>
-
- <para>
+ <para>
- <xref linkend="Editmenu_Menu_entries">Editメニュー</xref>
-
- </para>
-
- </listitem>
-
- <listitem>
+ <xref linkend="Editmenu_Menu_entries">Editメニュー</xref>
- <para>
+ </para>
- <xref linkend="Viewmenu_Menu_entries">Viewメニュー</xref>
+ </listitem>
- </para>
+ <listitem>
- </listitem>
+ <para>
- <listitem>
+ <xref linkend="Viewmenu_Menu_entries">Viewメニュー</xref>
- <para>
+ </para>
- <xref linkend="Simulatemenu_Menu_entries">Simulateメニュー</xref>
+ </listitem>
- </para>
+ <listitem>
- </listitem>
+ <para>
- <listitem>
+ <xref linkend="Simulatemenu_Menu_entries">Simulateメニュー</xref>
- <para>
+ </para>
- <xref linkend="Formatmenu_Menu_entries">Formatメニュー</xref>
+ </listitem>
- </para>
+ <listitem>
- </listitem>
+ <para>
- <listitem>
+ <xref linkend="Formatmenu_Menu_entries">Formatメニュー</xref>
- <para>
+ </para>
- <xref linkend="Toolsmenu_Menu_entries">Toolsメニュー</xref>
+ </listitem>
- </para>
+ <listitem>
- </listitem>
+ <para>
- <listitem>
+ <xref linkend="Toolsmenu_Menu_entries">Toolsメニュー</xref>
- <para>
+ </para>
- <xref linkend="Helpmenu_Menu_entries">?メニュー</xref>
+ </listitem>
- </para>
+ <listitem>
- </listitem>
+ <para>
- <listitem>
+ <xref linkend="Helpmenu_Menu_entries">?メニュー</xref>
- <para>
+ </para>
- <xref linkend="Seealso_Menu_entries">参照</xref>
+ </listitem>
- </para>
+ <listitem>
- </listitem>
+ <para>
- </itemizedlist>
+ <xref linkend="Seealso_Menu_entries">参照</xref>
- </listitem>
+ </para>
- </itemizedlist>
+ </listitem>
+ </itemizedlist>
</refsection>
<refsection id="Filemenu_Menu_entries">