Add or format some examples in Xcos
[scilab.git] / scilab / modules / xcos / help / en_US / programming_scicos_blocks / utilities_functions / scicos_time.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_time">
25     <refnamediv>
26         <refname>scicos_time</refname>
27         <refpurpose>Returns the current time during simulation</refpurpose>
28     </refnamediv>
29     <refsection id="Module_scicos_time">
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>
40         <title>Examples</title>
41         <programlisting role="example"><![CDATA[ 
42 t=scicos_time()
43  ]]></programlisting>
44     </refsection>
45     <refsection id="Parameters_scicos_time">
46         <title>Arguments</title>
47         <itemizedlist>
48             <listitem>
49                 <para>
50                     <emphasis role="bold">t:</emphasis> that is the current simulated time returned in real number.
51                 </para>
52             </listitem>
53         </itemizedlist>
54     </refsection>
55 </refentry>