← Back to branch summary

~ubuntu-branches/ubuntu/karmic/scilab/karmic

« back to all changes in this revision

Viewing changes to man/scicos/getscicosvars.man

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2002-03-21 16:57:43 UTC
  • Revision ID: james.westby@ubuntu.com-20020321165743-e9mv12c1tb1plztg
Tags: upstream-2.6
Import upstream version 2.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/scicos/getscicosvars.man
 
1
.TH getscicosvars 5 "Janvier 1996" "Scilab Group" "Scicos function"
 
2
.so ../sci.an
 
3
.SH NAME
 
4
getscicosvars - get Scicos data structure while running
 
5
.SH CALLING SEQUENCE
 
6
v=getscicosvars(name)
 
7
.SH PARAMETERS
 
8
.TP
 
9
name
 
10
: a character string, the name of the required structure
 
11
.TP
 
12
v 
 
13
: vector of the structure value
 
14
.SH DESCRIPTION
 
15
This function may be used in a Scilab block to get value of some
 
16
particular global data while running. It allows to write diagram
 
17
monitoring blocks. 
 
18
.LP
 
19
for example  the instruction  \fVdisp(getscicosvars('x'))\fR  displays 
 
20
the entire continuous state of the diagram.
 
21
.nf
 
22
x=getscicosvars('x');
 
23
xptr=getscicosvars('xptr');
 
24
disp(x(xptr(k):xptr(k+1)-1))
 
25
.fi
 
26
displays the continuous state of the \fVk\fR block
 
27
 
 
28
.IG
 
29
.nf
 
30
|=========================================================|
 
31
| name     |  data structure definition                   |
 
32
|=========================================================|
 
33
|'x'       | continuous state                             |
 
34
|'xptr'    | continuous state splitting vector            |
 
35
|'z'       | discrete state                               |
 
36
|'zptr'    | discrete  state splitting vector             |
 
37
|'rpar'    | real parameters vector                       |
 
38
|'rpptr'   | rpar  splitting vector                       |
 
39
|'ipar'    | integer parameters vector                    |
 
40
|'ipptr'   | ipar  splitting vector                       |
 
41
|'outtb'   | vector of all input/outputs values           |
 
42
|'inpptr'  | inplnk splitting vector                      |
 
43
|'outptr'  | outlnk splitting vector                      |
 
44
|'inplnk'  | vector of input port values address in lnkptr |
 
45
|'outlnk'  | vector of output port values address in lnpkpr|
 
46
|'lnkptr'  | outtb splitting vector                       |
 
47
|=========================================================|
 
48
.fi
 
49
.FI
 
50
.LP
 
51
\" This is for LaTeX 
 
52
.LA \begin{tabular}{|r|l|} \hline
 
53
.LA name& data structure definition \\  \hline
 
54
.LA  'x' &    continuous state \\  \hline
 
55
.LA  'xptr' &    continuous state splitting vector\\  \hline
 
56
.LA  'z' &    discrete state \\  \hline
 
57
.LA  'zptr' &    discrete  state splitting vector\\  \hline
 
58
.LA  'rpar' &  real parameters vector \\  \hline
 
59
.LA  'rpptr' &    rpar  splitting vector\\  \hline
 
60
.LA  'ipar' &     integer parameters vector \\ \hline
 
61
.LA  'ipptr' &    ipar  splitting vector\\  \hline
 
62
.LA  'outtb' &    vector of all input/outputs values \\ \hline
 
63
.LA  'inpptr' &   inplnk splitting vector \\ \hline
 
64
.LA  'outptr' &   outlnk splitting vector  \\ \hline
 
65
.LA  'inplnk' &   vector of input port values address in lnkptr \\ \hline
 
66
.LA  'outlnk' &   vector of output port values address in lnpkpr \\ \hline
 
67
.LA  'lnkptr' &   outtb splitting vector \\ \hline
 
68
.LA \end{tabular}
 
69
.LP
 
70
See \fVscicos_cpr\fR for more detail on these data structures.
 
71
.LP
 
72
For C or fortran computational function the C procedure
 
73
\fVC2F(getscicosvars)\fR may used. See
 
74
\fVroutines/scicos/import.c\fR file for more details.
 
75
.SH SEE ALSO
 
76
setscicosvars,  scicosim, curblock, scicos_cpr, getblocklabel