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

« back to all changes in this revision

Viewing changes to man/scicos/scicos_menus.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:
 
1
.TH scicos_menus  5 "Janvier 1996" "Scilab Group" "Scicos GUI"
 
2
.so ../sci.an
 
3
.SH NAME
 
4
scicos_menus - Scicos menus description
 
5
.SH DESCRIPTION
 
6
Here is a list of operations available in Scicos:
 
7
.TP 5
 
8
Main menus
 
9
 
10
.RS
 
11
.TP 10
 
12
 
 
13
.TP
 
14
Edit
 
15
: Opens the diagram/palette edition menu.
 
16
.TP
 
17
Simulate
 
18
: Opens the compilation/execution menu.
 
19
.TP
 
20
Diagram
 
21
: Opens the diagram/file management menu.
 
22
.TP
 
23
Block
 
24
: Opens the block management menu.
 
25
.TP
 
26
Misc
 
27
: Opens miscellaneous menu items.
 
28
.RE
 
29
.TP
 
30
Diagram/palette edition menu.
 
31
: This menu allows to edit diagram and palettes
 
32
.RS
 
33
.TP 10
 
34
Palettes
 
35
: opens up a selection dialog where user may select a desired
 
36
palette among all defined palettes.
 
37
.TP
 
38
Context
 
39
: opens up a dialog where user may enter and modify Scilab
 
40
instructions to be executed  when diagram is
 
41
loaded (\fVEdit../Load\fR menu) or evaluated (\fVSimulate../Eval\fR
 
42
menu) (of course instructions are also evaluated when dialog
 
43
returns).These instructions may be used to define Scilab variables
 
44
whose names are used in the block parameters definition expressions.
 
45
.TP
 
46
Move 
 
47
: To move a block in main Scicos window, select first the Move
 
48
menu item, then click on the selected block, drag the mouse to the
 
49
desired block position and click again to fix the position.
 
50
.TP
 
51
Copy : 
 
52
To copy a block in main Scicos window, select first the Copy menu item,
 
53
then click left on the to-be-copied block (in Scicos window or in a
 
54
palette) , and finally click where you want the copy to be placed in
 
55
Scicos window. This menu item remains active until user choose an other one
 
56
.TP
 
57
Copy Region:
 
58
To copy a region in main Scicos window, select first the Copy
 
59
menu item, then click right on a corner of the desired region (in Scicos
 
60
window or in a palette) , drag to select the desired region, click to
 
61
fix the selected region and finally click where you want the copy to
 
62
be placed in Scicos window. If source diagram is a big region,
 
63
selection may take a while.
 
64
.TP
 
65
Replace :
 
66
To replace a block in the active editor Scicos window
 
67
select first the Replace menu item, then
 
68
select the replacement block (in
 
69
Scicos window or in a palette) ,  and
 
70
finally click on the to-be-replaced block. It is not possible to
 
71
replace a connected block with another block with different port
 
72
locations.
 
73
 
 
74
.TP
 
75
Align 
 
76
: To obtain nice diagrams, you can align ports of different blocks,
 
77
vertically and horizontally.  select first the Align menu item, then on
 
78
the first port and finally on the second port.  The block
 
79
corresponding to the second port is moved. Connected blocks cannot
 
80
be aligned.
 
81
.TP
 
82
AddNew
 
83
:To add a newly
 
84
defined block to the current palette or diagram select first this menu item, a
 
85
dialog box will pop up asking for the name of the GUI function
 
86
associated with the block. If this function is not already loaded it
 
87
is searched in the current directory. The user may then click at the
 
88
desired position of the block in the palette or diagram .
 
89
.TP
 
90
Link 
 
91
: This menu item is defined only in diagram edition mode.  To connect an
 
92
output port to an input port, select first the Link menu item, then on
 
93
the intermediate points, if necessary, and finally on the input port.
 
94
Scicos tries to draw horizontal and vertical lines to form links.
 
95
 
 
96
To split a link, select first the Link menu item, then on the link
 
97
where the split should be placed, and finally on an input port.  Only
 
98
one link can go from and to a port.  Link color can be changed
 
99
directly by clicking on the link.
 
100
 
 
101
This menu item remains active until user choose an other one
 
102
.TP
 
103
Delete 
 
104
: To delete a block or a link, select first the Delete menu item, then
 
105
click left on the selected object.  If you delete a block all links
 
106
connected to it are deleted as well.
 
107
This menu item remains active until user choose an other one.
 
108
 
 
109
.TP 
 
110
Delete Region
 
111
:To delete a region in main Scicos window select first the Delete Region
 
112
menu item, then click right on a corner of the desired region (in Scicos
 
113
window or in a palette), drag to select de desired region, click to
 
114
fix the selected region. If source diagram is a big region,
 
115
selection may take a while.
 
116
 
 
117
.TP
 
118
Flip 
 
119
: To reverse the positions of the (regular) inputs and outputs of a
 
120
block placed on its sides, click on the Flip menu item first and then on
 
121
the selected block. This does not affect the order, nor the position
 
122
of the input and output event ports which are numbered from left to
 
123
right. A connected block cannot be flipped.
 
124
.TP
 
125
Undo 
 
126
: Click on the Undo menu item to undo the last edit operation. 
 
127
.RE
 
128
.TP 
 
129
Simulation menu
 
130
 
131
.RS
 
132
.TP 10
 
133
Setup
 
134
: In the main Scicos window, clicking on the Setup menu item invokes a
 
135
dialog box that allows you to change integration parameters: absolute
 
136
and relative error tolerances for the ode solver, the time tolerance
 
137
(the smallest time interval for which the ode solver is used to update
 
138
continuous states), and the maximum time increase realized by a single
 
139
call to the ode solver.
 
140
 
 
141
.TP
 
142
Compile
 
143
: This menu item need never be used since compilation is performed
 
144
automatically, if necessary, before the beginning of every simulation
 
145
(\fVRun\fR menu item).
 
146
  
 
147
Normally, a new compilation is not needed if only system parameters
 
148
and internal states are modified.  In some cases however
 
149
modifications are not correctly updated and a manual compilation may
 
150
be needed before a Restart or a Continue. Click on this menu item to
 
151
compile the block diagram.  Please report if you encounter such a
 
152
case.
 
153
.TP
 
154
Eval
 
155
: blocks dialogs answers can be defined using  Scilab
 
156
expressions. These expressions  are
 
157
evaluated immediately and they are also stored as character
 
158
strings. Click on the Eval menu item to have them re-evaluated according
 
159
to the new values of underlying Scilab variables defined by context
 
160
for example.
 
161
.TP
 
162
Run
 
163
: To start the simulation.  If the system has already been simulated,
 
164
a dialog box appears where you can choose to Continue, Restart or End
 
165
the simulation. You may interrupt the simulation by clicking on the
 
166
"stop" button, change any of the block parameters and continue or
 
167
restart the simulation with the new values.
 
168
.RE
 
169
.TP 
 
170
Diagram menu
 
171
 
172
.RS  
 
173
.TP 10
 
174
Replot
 
175
: Scicos window stores the complete history of the editing
 
176
session. Click on the Replot menu item to erase the history and replot
 
177
the diagram or palette. Replot diagram before printing or exporting
 
178
Scicos diagrams.
 
179
.TP
 
180
New
 
181
: Clicking on the New menu item creates an empty diagram in the
 
182
main Scicos window. If the previous content of the   
 
183
window is not saved, it will be lost.
 
184
.TP 
 
185
Purge
 
186
: Suppress deleted blocks out of Scicos data structure. This menu
 
187
changes block indexing and implies compilation of the diagram before
 
188
compilation.
 
189
.TP 
 
190
Rename
 
191
: Click on this menu item to change the diagram or palette's name. A
 
192
dialog window will pop up.
 
193
.TP 
 
194
Make block
 
195
: Click on this menu item to save the Super Block as a new Scicos
 
196
block. A Scilab function is generated and saved in
 
197
<window_name>.sci file in the desired directory. <window_name> is the name
 
198
of the Super Block appearing on top of the window.  A dialog allows
 
199
choosing the directory. This block may be added  to a
 
200
palette using \fVEdit/AddNew\fR menu item.
 
201
.TP
 
202
Save
 
203
: Saves the block diagram in the current binary file selected by a previous
 
204
call to \fVSaveAs\fR or \fVLoad\fR menu item. If no current binary file,
 
205
diagram is saved in the current directory as \fV<window_name>.cos\fR.
 
206
.TP
 
207
Save As
 
208
: Saves the block diagram in a binary file. A file selection dialog
 
209
will pop up.
 
210
.TP
 
211
FSave 
 
212
: Save the diagram in a formatted ascii file. A dialog box
 
213
allows choosing the file name which must have a .cosf extension.
 
214
   
 
215
Formatted save is slower than regular save but has the advantage that
 
216
the generated file is system independent (usefull for exchanging data
 
217
on different computers.
 
218
     
 
219
.TP
 
220
Load : 
 
221
Loads an ascii or binary file containing a saved block diagram.
 
222
A file selection dialog will pop up.
 
223
.TP
 
224
Save as Palette
 
225
: select the Save as Palette menu item to save the block diagram
 
226
as a palette in a binary file. A dialog box allows choosing 
 
227
the file which must have a .cos extension. The palette
 
228
takes the name of the file (without the extension).
 
229
 
 
230
\fV.scilab\fR user file is updated.
 
231
.TP
 
232
FSave as Palette
 
233
: select the FSave as Palette menu item to save the block diagram
 
234
as a palette in an ascii formatted file. A dialog box allows choosing 
 
235
the file which must have a .cosf extension. The palette
 
236
takes the name of the file (without the extension).
 
237
.TP
 
238
Load as Palette
 
239
:select the Load menu item to load an ascii or binary file
 
240
containing a saved block diagram as a palette.
 
241
A dialog box allows user choosing the file.
 
242
.TP 
 
243
Exit
 
244
: Click on the Exit menu item to close current diagram. 
 
245
If current diagram is not a Super block Exit menu item 
 
246
leave Scicos and return to Scilab session. Save your diagram
 
247
or palette before leaving.
 
248
.RE 
 
249
.TP
 
250
Object menu
 
251
 
252
.RS
 
253
.TP 10 
 
254
Set 
 
255
:To change the parameters of a regular block or link, to open a
 
256
super block, select first this menu item, click next on the desired
 
257
object.  A dialog or edition window appear that allows you to modify
 
258
object
 
259
.TP
 
260
Resize
 
261
 
262
To change the size of a block , select first this menu item,
 
263
click next on the desired block. A dialog appears that allows 
 
264
you to change the width and/or height of the block shape.
 
265
.TP
 
266
Icon 
 
267
: To change the icon of a block drawn by \fVstandard_draw\fR,
 
268
select first this menu item, click next on the desired block. A dialog
 
269
appears that allows you to enter Scilab instructions used to draw the
 
270
icon. These instructions may refer to \fVorig\fR and \fVsz\fR
 
271
variables and more generaly to the block data structure named \fVo\fR
 
272
in this context (see \fVscicos_block\fR).
 
273
If Icon description selects colors for drawing, it is necessary to get
 
274
it through \fVscs_color\fR function to have \fVColor\fR
 
275
menu item work properly. 
 
276
.TP
 
277
Color
 
278
: To change the background  of a block drawn by \fVstandard_draw\fR,
 
279
or color of a link select first this menu item, click next on the selected
 
280
object. A color palette appears where user may select the block
 
281
background color.
 
282
.TP
 
283
Label
 
284
: To change or define the blocks label, select first this menu item, click next
 
285
on the desired block. A dialog appears that allows you to enter 
 
286
the desired label. Labels may be used within blocks computational
 
287
functions as an identification (see \fVgetlabel\fR function).
 
288
.RE
 
289
.TP
 
290
Miscellaneous menu
 
291
 
292
.RS
 
293
.TP 10 
 
294
Window
 
295
: Clicking on the 
 
296
Window menu item invokes a dialog box that allows you to change 
 
297
the editor window dimensions.
 
298
.TP
 
299
Shift
 
300
:To shift the diagram to left, right, up or down,
 
301
select this menu item, then click on the point you want 
 
302
to appear in the middle of the graphics window. 
 
303
.TP
 
304
Zoom in
 
305
: When you select this menu item the diagram is zoomed in 
 
306
      by a factor of 10%
 
307
.TP
 
308
Zoom out
 
309
: When you select this menu item the diagram is zoomed out
 
310
      by a factor of 10%
 
311
.TP
 
312
Options
 
313
: Select this menu item to set display options.
 
314
.TP
 
315
Help
 
316
: To get help on an object or menu menu items, select first Help
 
317
menu item and then on the selected object or menu item.
 
318
.TP
 
319
Calc:
 
320
: When you click on this menu item you switch Scilab to 
 
321
the pause mode (see the help on pause).
 
322
In the Scilab main window and you may enter Scilab instructions
 
323
to compute whatever you want.
 
324
to go back to Scicos you need to enter ""return"" or
 
325
"[...]=return(...)" Scilab instruction.
 
326
'
 
327
If you use "[...]=return(...)" Scilab instruction take care
 
328
not to modify Scicos variables such as "scs_m","scs_gc",
 
329
"menus","datam",...
 
330
'
 
331
If you have modified Scicos graphic window you may restore it 
 
332
using the Scicos "Replot" menu.
 
333
 
 
334
.RE
 
335
.SH SEE ALSO
 
336
scicos
 
337