File: getvalue.man

package info (click to toggle)
scilab 2.6-4
  • links: PTS
  • area: non-free
  • in suites: woody
  • size: 54,632 kB
  • ctags: 40,267
  • sloc: ansic: 267,851; fortran: 166,549; sh: 10,005; makefile: 4,119; tcl: 1,070; cpp: 233; csh: 143; asm: 135; perl: 130; java: 39
file content (80 lines) | stat: -rw-r--r-- 1,750 bytes parent folder | download | duplicates (2)
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
.TH getvalue 1 "November 1993" "Scilab Group" "Scilab Function"
.so ../sci.an
.SH NAME
getvalue - xwindow dialog for data acquisition 
.SH CALLING SEQUENCE
.nf
[ok,x1,..,x14]=getvalue(desc,labels,typ,ini)
.fi
.SH PARAMETERS
.TP
desc    
: column vector of strings, dialog general comment 
.TP
labels  
: n column vector of strings, \fVlabels(i)\fR is the label of 
the ith required value
.TP
typ     
: \fVlist(typ1,dim1,..,typn,dimn)\fR
.RS
.TP
typi 
: defines the type of the ith value, may have the following values:
.RS
.TP
"mat"
: for constant matrix
.TP
"col"
: for constant column vector
.TP
"row"
: for constant row vector
.TP
"vec"
: for  constant vector
.TP
"str"
: for string
.TP
"lis"
: for list
.RE
.TP
dimi 
: defines the size of the ith value
it must be a integer or a 2-vector of integer,
-1 stands for undefined dimension
.RE
.TP
ini     
: n column vector of strings, \fVini(i)\fR gives the suggested
response for the ith required value
.TP
ok      
: boolean ,%t if ok button pressed, %f if cancel button pressed
.TP
xi      
: contains the ith value if ok=%t. If left hand side as one more
\fVxi\fR than required values the last  \fVxi\fR contains the vector
of answered strings.
.SH DESCRIPTION
This function encapsulate \fVx_mdialog\fR function with error checking,
evaluation of numerical response, ...
.SH REMARKS
All valid expressions can be used as answers; for matrices 
and vectors \fVgetvalues\fR automatically adds [ ] around the given answer
before numeric evaluation.
.SH EXAMPLE
.nf
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"])
.fi
.SH SEE ALSO
x_mdialog, x_matrix, x_dialog
.SH AUTHOR
S. Steer