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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
<?xml version="1.0" encoding="UTF-8"?>
<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" version="5.0-subset Scilab" xml:lang="en" xml:id="getvalue">
<info>
<pubdate>$LastChangedDate$</pubdate>
</info>
<refnamediv>
<refname>getvalue</refname>
<refpurpose> xwindow dialog for data acquisition</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>[ok,x1,..,x14]=getvalue(desc,labels,typ,ini)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term>desc</term>
<listitem>
<para>column vector of strings, dialog general comment</para>
</listitem>
</varlistentry>
<varlistentry>
<term>labels</term>
<listitem>
<para>n column vector of strings, <literal>labels(i)</literal> is the label of the ith required value</para>
</listitem>
</varlistentry>
<varlistentry>
<term>typ</term>
<listitem>
<para> <literal>list(typ_1,dim_1,..,typ_n,dim_n)</literal></para>
<variablelist>
<varlistentry>
<term>typ_i</term>
<listitem>
<para>defines the type of the ith value, may have the following values:</para>
<variablelist>
<varlistentry>
<term>"mat" </term>
<listitem>
<para>for constant matrix</para>
</listitem>
</varlistentry>
<varlistentry>
<term>"col" </term>
<listitem>
<para>for constant column vector</para>
</listitem>
</varlistentry>
<varlistentry>
<term>"row" </term>
<listitem>
<para>for constant row vector</para>
</listitem>
</varlistentry>
<varlistentry>
<term>"vec" </term>
<listitem>
<para>for constant vector</para>
</listitem>
</varlistentry>
<varlistentry>
<term>"str" </term>
<listitem>
<para>for string</para>
</listitem>
</varlistentry>
<varlistentry>
<term>"lis" </term>
<listitem>
<para>for list</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>dim_i</term>
<listitem>
<para>defines the size of the ith value it must be a integer or a 2-vector of integer, -1 stands for undefined dimension</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>ini</term>
<listitem>
<para>n column vector of strings, <literal>ini(i)</literal> gives the suggested response for the ith required value</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ok</term>
<listitem>
<para>boolean ,%t if ok button pressed, %f if cancel button pressed</para>
</listitem>
</varlistentry>
<varlistentry>
<term>xi</term>
<listitem>
<para>contains the ith value if ok=%t. If left hand side has one more <literal>xi</literal> than required values the last <literal>xi</literal> contains the vector of answered strings.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
This function encapsulate <literal>x_mdialog</literal> function with error checking,
evaluation of numerical response, ...</para>
</refsection>
<refsection>
<title>Remarks</title>
<para>
All valid expressions can be used as answers; for matrices and vectors <literal>getvalues</literal> automatically adds [ ] around the given answer before numeric evaluation.</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
labels=["magnitude";"frequency";"phase "];
[ok,mag,freq,ph]=getvalue("define sine signal",labels,...
list("vec",1,"vec",1,"vec",1),["0.85";"10^2";"%pi/3"])
]]></programlisting>
</refsection>
<refsection>
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="x_mdialog">x_mdialog</link>
</member>
<member>
<link linkend="x_matrix">x_matrix</link>
</member>
<member>
<link linkend="x_dialog">x_dialog</link>
</member>
</simplelist>
</refsection>
<refsection>
<title>Authors</title>
<para>S. Steer ; ; </para>
</refsection>
</refentry>
|
