← Back to branch summary

~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/scicos/setscicosvars.man

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
http://bugs.debian.org/255869
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/scicos/setscicosvars.man
1
 
.TH setscicosvars 5 "Janvier 1996" "Scilab Group" "Scicos function"
2
 
.so ../sci.an
3
 
.SH NAME
4
 
setscicosvars - set Scicos data structure while running
5
 
.SH CALLING SEQUENCE
6
 
setscicosvars(name,v)
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 new structure value
14
 
.SH DESCRIPTION
15
 
This function may be used in a Scilab block to set value of some
16
 
particular global data while running. It allows to write diagram
17
 
supervisor blocks.
18
 
.LP
19
 
for example  the instructions  
20
 
.nf
21
 
x=getscicosvars('x');
22
 
xptr=getscicosvars('xptr');
23
 
x(xptr(k):xptr(k+1)-1)=xk
24
 
setscicosvars('x',x)
25
 
.fi
26
 
Changes the continuous state of the \fVk\fR block to \fVxk\fR.
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(setscicosvars)\fR may used. See
74
 
\fVroutines/scicos/import.c\fR file for more details.
75
 
.LP
76
 
Warning: The use of this function requires a deep knowledge on how
77
 
scicosim works, it must be used very carefully. Unpredicted parameters,
78
 
state, link values changes  may produce erroneous simulations.
79
 
.SH SEE ALSO
80
 
getscicosvars,  scicosim,  curblock, scicos_cpr, getblocklabel