Add or format some examples in Xcos
[scilab.git] / scilab / modules / xcos / help / en_US / programming_scicos_blocks / utilities_functions / pointer_xproperty.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="pointer_xproperty">
25     <refnamediv>
26         <refname>pointer_xproperty</refname>
27         <refpurpose>Get the type of a continuous time state variable</refpurpose>
28     </refnamediv>
29     <refsynopsisdiv>
30         <title>Calling Sequence</title>
31         <synopsis>[xprop] = pointer_xproperty()</synopsis>
32     </refsynopsisdiv>
33     <refsection id="Module_pointer_xproperty">
34         <title>Module</title>
35         <itemizedlist>
36             <listitem>
37                 <para>
38                     <link linkend="xcos">xcos</link>
39                 </para>
40             </listitem>
41         </itemizedlist>
42     </refsection>
43     <refsection id="Description_pointer_xproperty">
44         <title>Description</title>
45         <para>
46             This function returns a vector that informs the type (algebraic or differential) of the continuous state variables of a block.  
47         </para>
48         <para>
49         </para>
50         <programlisting role="example"><![CDATA[ 
51 [xprop]=pointer_xproperty()
52  ]]></programlisting>
53     </refsection>
54     <refsection id="Parameters_pointer_xproperty">
55         <title>Arguments</title>
56         <itemizedlist>
57             <listitem>
58                 <para>
59                     <emphasis role="bold">xprop</emphasis>
60                 </para>
61                 <para> The value gives the type of the states :</para>
62                 <itemizedlist>
63                     <listitem>
64                         <para>-1 : an algebraic state.
65                         </para>
66                     </listitem>
67                     <listitem>
68                         <para>1  : a differential state.
69                             
70                         </para>
71                     </listitem>
72                 </itemizedlist>
73             </listitem>
74         </itemizedlist>
75     </refsection>
76     <refsection id="SeeAlso_pointer_xproperty">
77         <title>See Also</title>
78         <itemizedlist>
79             <listitem>
80                 <para>
81                     <link linkend="set_xproperty">set_xproperty - Set the type of a continuous time state variable (Scilab Function)</link>
82                 </para>
83             </listitem>
84         </itemizedlist>
85     </refsection>
86 </refentry>