source: trunk/documents/UserDoc/DocBookUsersGuides/ForApplicationDeveloper/xml/AllResources/Control/UIcommands/control.txt @ 904

Last change on this file since 904 was 904, checked in by garnier, 16 years ago

ajout de la doc
File size: 4.3 KB
Line 
1/control/manual /control
2Command directory path : /control/
3
4
5Guidance :
6UI control commands.
7
8 Sub-directories :
9 Commands :
10   execute * Execute a macro file.
11   loop * Execute a macro file more than once.
12   foreach * Execute a macro file more than once.
13   suppressAbortion * Suppress the program abortion caused by G4Exception.
14   verbose * Applied command will also be shown on screen.
15   saveHistory * Store command history to a file.
16   stopSavingHistory * Stop saving history file.
17   alias * Set an alias.
18   unalias * Remove an alias.
19   listAlias * List aliases.
20   shell * Execute a (Unix) SHELL command.
21   manual * Display all of sub-directories and commands.
22   createHTML * Generate HTML files for all of sub-directories and commands.
23   maximumStoredHistory * Set maximum number of stored UI commands.
24
25
26Command /control/execute
27Guidance :
28Execute a macro file.
29
30Parameter : fileName
31 Parameter type  : s
32 Omittable       : False
33
34
35
36Command /control/loop
37Guidance :
38Execute a macro file more than once.
39Loop counter can be used as an aliased variable.
40
41Parameter : macroFile
42 Parameter type  : s
43 Omittable       : False
44
45Parameter : counterName
46 Parameter type  : s
47 Omittable       : False
48
49Parameter : initialValue
50 Parameter type  : d
51 Omittable       : False
52
53Parameter : finalValue
54 Parameter type  : d
55 Omittable       : False
56
57Parameter : stepSize
58 Parameter type  : d
59 Omittable       : True
60 Default value   : 1
61
62
63
64Command /control/foreach
65Guidance :
66Execute a macro file more than once.
67Loop counter can be used as an aliased variable.
68Values must be separated by a space.
69
70Parameter : macroFile
71 Parameter type  : s
72 Omittable       : False
73
74Parameter : counterName
75 Parameter type  : s
76 Omittable       : False
77
78Parameter : valueList
79 Parameter type  : s
80 Omittable       : False
81
82
83
84Command /control/suppressAbortion
85Guidance :
86Suppress the program abortion caused by G4Exception.
87Suppression level = 0 : no suppression
88                  = 1 : suppress during EventProc state
89                  = 2 : full suppression, i.e. no abortion by G4Exception
90When abortion is suppressed, you will get error messages issued by G4Exception,
91and there is NO guarantee for the correct result after the G4Exception error message.
92 Range of parameters : level >= 0 && level <= 2
93
94Parameter : level
95 Parameter type  : i
96 Omittable       : True
97 Default value   : 0
98
99
100
101Command /control/verbose
102Guidance :
103Applied command will also be shown on screen.
104This command is useful with MACRO file.
105  0 : silent
106  1 : only the valid commands are shown.
107  2 : comment lines are also shown (default).
108 Range of parameters : switch >= 0 && switch <=2
109
110Parameter : switch
111 Parameter type  : i
112 Omittable       : True
113 Default value   : 2
114
115
116
117Command /control/saveHistory
118Guidance :
119Store command history to a file.
120Defaul file name is G4history.macro.
121
122Parameter : fileName
123 Parameter type  : s
124 Omittable       : True
125 Default value   : G4History.macro
126
127
128
129Command /control/stopSavingHistory
130Guidance :
131Stop saving history file.
132
133
134
135Command /control/alias
136Guidance :
137Set an alias.
138String can be aliased by this command.
139The string may contain one or more spaces,
140the string must be enclosed by double quotes (").
141To use an alias, enclose the alias name with
142parenthis "{" and "}".
143
144Parameter : aliasName
145 Parameter type  : s
146 Omittable       : False
147
148Parameter : aliasValue
149 Parameter type  : s
150 Omittable       : False
151
152
153
154Command /control/unalias
155Guidance :
156Remove an alias.
157
158Parameter : aliasName
159 Parameter type  : s
160 Omittable       : False
161
162
163
164Command /control/listAlias
165Guidance :
166List aliases.
167
168
169
170Command /control/shell
171Guidance :
172Execute a (Unix) SHELL command.
173
174Parameter :
175 Parameter type  : s
176 Omittable       : False
177
178
179
180Command /control/manual
181Guidance :
182Display all of sub-directories and commands.
183Directory path should be given by FULL-PATH.
184
185Parameter : dirPath
186 Parameter type  : s
187 Omittable       : True
188 Default value   : /
189
190
191
192Command /control/createHTML
193Guidance :
194Generate HTML files for all of sub-directories and commands.
195Directory path should be given by FULL-PATH.
196
197Parameter : dirPath
198 Parameter type  : s
199 Omittable       : True
200 Default value   : /
201
202
203
204Command /control/maximumStoredHistory
205Guidance :
206Set maximum number of stored UI commands.
207
208Parameter : max
209 Parameter type  : i
210 Omittable       : True
211 Default value   : 20
212
Note: See TracBrowser for help on using the repository browser.