summaryrefslogtreecommitdiffstats
path: root/scilab/modules/xcos/help/en_US/xcos.xml
blob: 3582e95fcc527b1d3dfa74f92361ea369df11486 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 * 
 * See the file ./license.txt
 -->
<refentry version="5.0-subset Scilab" xml:id="xcos"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:ns4="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:db="http://docbook.org/ns/docbook">
  <refnamediv>
    <refname>xcos</refname>

    <refpurpose>Block diagram editor and GUI for the hybrid
    simulator</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>Calling Sequence</title>

    <synopsis>xcos(filename)
xcos(scs_m_list)</synopsis>
  </refsynopsisdiv>

  <refsection id="Module_scicos">
    <title>Module</title>

    <itemizedlist>
      <listitem>
        <para><link linkend="xcos">xcos</link></para>
      </listitem>
    </itemizedlist>
  </refsection>

  <refsection id="Description_scicos">
    <title>Description</title>

    <para>Xcos is a visual editor for constructing models of hybrid dynamical
    systems.</para>

    <para>Invoking Xcos with no argument opens up an empty Xcos window. Models
    can then be assembled, loaded, saved, compiled, simulated, using GUI of
    Xcos. Xcos serves as an interface to the various block diagram compilers
    and the hybrid simulator scicosim.</para>

    <programlisting role="example"> 
xcos('mydiagram.xcos')
 </programlisting>
  </refsection>

  <refsection id="Parameters_scicos">
    <title>Parameters</title>

    <itemizedlist>
      <listitem>
        <para><emphasis role="bold">filename : </emphasis> a character string
        containing the path of the diagram file (.cos, .cosf or .xcos
        extension). If no input argument is used, an empty diagram is opened
        (default name Untitled).</para>
      </listitem>

      <listitem>
        <para><emphasis role="bold">scs_m_list : </emphasis>a Xcos diagram
        structure after edition.</para>
      </listitem>
    </itemizedlist>
  </refsection>

  <refsection id="Example_scicos">
    <title>Example</title>

    <programlisting role="example"> 
// Open a new diagram 
xcos();
xcos

// Load a diagram  
xcos SCI/scicos/demos/bounce.cosf; 

// Load a structure 
load('mondiagr.cos'); 
xcos(scs_m);
 </programlisting>
  </refsection>

  <refsection id="SeeAlso_scicos">
    <title>See Also</title>

    <itemizedlist>
      <listitem>
        <para><link linkend="scicosim">scicosim - Scicos (batch) simulation
        function (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_menu_entries">Menu entries</link></para>
      </listitem>
    </itemizedlist>
  </refsection>
</refentry>