Xcos documentation: improve the rendering for data structures
[scilab.git] / scilab / modules / xcos / help / en_US / scilab_data_structures / scicos_state.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scicos
4  * 
5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  * 
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  * 
22  * See the file ./license.txt
23  -->
24 <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="scicos_state">
25     <refnamediv>
26         <refname>scicos_state</refname>
27         <refpurpose>Define a state structure</refpurpose>
28     </refnamediv>
29     <refsection id="Module_scicos_state">
30         <title>Module</title>
31         <itemizedlist>
32             <listitem>
33                 <para>
34                     <link linkend="xcos">xcos</link>
35                 </para>
36             </listitem>
37         </itemizedlist>
38     </refsection>
39     <refsection id="state_scicos_state">
40         <title>state</title>
41         <para>
42             States of the model, that is, everything than
43             can evolve during the simulation.
44         </para>
45         <para>
46             Type : scilab tlist of type <code>"xcs"</code> with fields :
47             <link linkend="scicos_cpr_state_x">x</link>, 
48             <link linkend="scicos_cpr_state_z">z</link>, 
49             <link linkend="scicos_cpr_state_oz">oz</link>, 
50             <link linkend="scicos_cpr_state_iz">iz</link>, 
51             <link linkend="scicos_cpr_state_tevts">tevts</link>, 
52             <link linkend="scicos_cpr_state_evtspt">evtspt</link>, 
53             <link linkend="scicos_cpr_state_pointi">pointi</link> and 
54             <link linkend="scicos_cpr_state_outtb">outtb</link>.
55         </para>
56         <refsect2 id="scicos_cpr_state_x">
57             <title>x</title>
58             <para> The continuous-time state register, which is obtained by concatenating the continuous-time states of all the blocks.</para>
59             <para> 
60                 Size : total of all the size of continuous-time state registers.
61             </para>
62             <para>
63                 Type : column vector of real numbers.
64             </para>
65         </refsect2>
66         <refsect2 id="scicos_cpr_state_z">
67             <title>z</title>
68             <para> The discrete-time state register, which is obtained by concatenating the discrete-time states of all the blocks.</para>
69             <para> 
70                 Size : total of all the size of discrete-time state registers.
71             </para>
72             <para>
73                 Type : column vector of real number.
74             </para>
75         </refsect2>
76         <refsect2 id="scicos_cpr_state_oz">
77             <title>oz</title>
78             <para> The list of the object discrete-time state, which is obtained by concatenating the object discrete-time states of all the blocks.</para>
79             <para> 
80                 Size : total of all the size of object state.
81             </para>
82             <para>
83                 Type : list of scilab object.
84             </para>
85         </refsect2>
86         <refsect2 id="scicos_cpr_state_iz">
87             <title>iz</title>
88             <para> Vector of size equal to the number of blocks.</para>
89             <para> That vector is used to store pointers of the working state register (work). If a block needs to allocate memory at initialization (flag 4), the associated pointer is saved here.</para>
90             <para> 
91                 Size : number of blocks.
92             </para>
93             <para>
94                 Type : column vector of real numbers.
95             </para>
96         </refsect2>
97         <refsect2 id="scicos_cpr_state_tevts">
98             <title>tevts</title>
99             <para> Vector of size equal to the number of activation sources. It contains the scheduled times for programmed activations in evtspt.</para>
100             <para> 
101                 Size : number of activation sources.
102             </para>
103             <para>
104                 Type : column vector of integers.
105             </para>
106         </refsect2>
107         <refsect2 id="scicos_cpr_state_evtspt">
108             <title>evtspt</title>
109             <para> Vector of size equal to the number of activation sources. It is an event scheduler.</para>
110             <para> 
111                 Size : number of activation sources.
112             </para>
113             <para>
114                 Type : column vector of integers.
115             </para>
116         </refsect2>
117         <refsect2 id="scicos_cpr_state_pointi">
118             <title>pointi</title>
119             <para> The number of the next programmed event.</para>
120             <para> 
121                 Size : 1.
122             </para>
123             <para>
124                 Type : integer.
125             </para>
126         </refsect2>
127         <refsect2 id="scicos_cpr_state_outtb">
128             <title>outtb</title>
129             <para> Scilab list containing all output registers of blocks. Each element of that list contains typed matrix-based data.</para>
130             <para> 
131                 Size : number of regular output ports.
132             </para>
133             <para>
134                 Type : list of scilab matrix.
135             </para>
136         </refsect2>
137     </refsection>
138 </refentry>