← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/scicos/curblock.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/curblock.man
 
1
.TH curblock  "Janvier 1997" "Scilab Group" "Scicos function"
 
2
.so ../sci.an
 
3
.SH NAME
 
4
curblock - get current block index in a Scicos simulation function
 
5
.SH CALLING SEQUENCE
 
6
.nf
 
7
k=curblock()
 
8
.fi
 
9
.SH PARAMETERS
 
10
.TP 5
 
11
k
 
12
: integer, index of the block corresponding to the Scilab simulation
 
13
function where this function is called.
 
14
.SH DESCRIPTION
 
15
During simulation it may be interesting to get the index of the current
 
16
block to trace execution, to get its label, to animate the block icon
 
17
according to simulation...
 
18
.LP
 
19
For block with a computational function written in Scilab, Scilab
 
20
primitive function \fVcurblock()\fR  allows to get the index of the
 
21
current block in the compiled data structure.
 
22
.LP
 
23
To obtain path to the block in the Scicos main structure user may uses
 
24
the \fVcorinv\fR table (see scicos_cpr).
 
25
.LP 
 
26
For block with a computational function written in C user may uses the
 
27
C function  \fVk=C2F(getcurblock)()\fR. Where \fVC2F\fR is the C
 
28
compilation macro defined in \fV<SCIDIR>/routines/machine.h\fR
 
29
.LP
 
30
For block with a computational function written in Fortran user may uses the
 
31
integer  function  \fVk=getcurblock()\fR.
 
32
.SH SEE ALSO
 
33
getblocklabel, getscicosvars, setscicosvars, scicos_cpr, scicos_main
 
34