source: trunk/documents/UserDoc/UsersGuides/ForApplicationDeveloper/html/Control/UIcommands/_control_.html @ 1287

Last change on this file since 1287 was 1208, checked in by garnier, 15 years ago

CVS update
File size: 4.7 KB
Line 
1<html><head><title>Commands in /control/</title></head>
2<body bgcolor="#ffffff"><h2>/control/</h2><p>
3UI control commands.<br>
4<p><hr><p>
5<h2>Sub-directories : </h2><dl>
6<p><br><p><dt><a href="_control_matScan_.html">/control/matScan/</a>
7<p><dd>Material scanner commands.
8</dl><p><hr><p>
9<h2>Commands : </h2><dl>
10<p><br><p><dt><b>execute [<i>fileName</i>]</b>
11<p><dd>
12Execute a macro file.<br>
13<p><dd>Available at all Geant4 states.
14<p><dd>Parameters<table border=1>
15<tr><td>fileName
16<td>type s
17<td><td></table>
18<p><br><p><dt><b>loop [<i>macroFile</i>] [<i>counterName</i>] [<i>initialValue</i>] [<i>finalValue</i>] [<i>stepSize</i>]</b>
19<p><dd>
20Execute a macro file more than once.<br>
21Loop counter can be used as an aliased variable.<br>
22<p><dd>Available at all Geant4 states.
23<p><dd>Parameters<table border=1>
24<tr><td>macroFile
25<td>type s
26<td><td><tr><td>counterName
27<td>type s
28<td><td><tr><td>initialValue
29<td>type d
30<td><td><tr><td>finalValue
31<td>type d
32<td><td><tr><td>stepSize
33<td>type d
34<td>Omittable : default value = 1
35<td></table>
36<p><br><p><dt><b>foreach [<i>macroFile</i>] [<i>counterName</i>] [<i>valueList</i>]</b>
37<p><dd>
38Execute a macro file more than once.<br>
39Loop counter can be used as an aliased variable.<br>
40Values must be separated by a space.<br>
41<p><dd>Available at all Geant4 states.
42<p><dd>Parameters<table border=1>
43<tr><td>macroFile
44<td>type s
45<td><td><tr><td>counterName
46<td>type s
47<td><td><tr><td>valueList
48<td>type s
49<td><td></table>
50<p><br><p><dt><b>suppressAbortion [<i>level</i>]</b>
51<p><dd>
52Suppress the program abortion caused by G4Exception.<br>
53Suppression level = 0 : no suppression<br>
54                  = 1 : suppress during EventProc state<br>
55                  = 2 : full suppression, i.e. no abortion by G4Exception<br>
56When abortion is suppressed, you will get error messages issued by G4Exception,<br>
57and there is NO guarantee for the correct result after the G4Exception error message.<br>
58<p><dd>Range : level &gt;= 0 &amp;&amp; level &lt;= 2
59<p><dd>Available at all Geant4 states.
60<p><dd>Parameters<table border=1>
61<tr><td>level
62<td>type i
63<td>Omittable : default value = 0
64<td></table>
65<p><br><p><dt><b>verbose [<i>switch</i>]</b>
66<p><dd>
67Applied command will also be shown on screen.<br>
68This command is useful with MACRO file.<br>
69  0 : silent<br>
70  1 : only the valid commands are shown.<br>
71  2 : comment lines are also shown (default).<br>
72<p><dd>Range : switch &gt;= 0 &amp;&amp; switch &lt;=2
73<p><dd>Available at all Geant4 states.
74<p><dd>Parameters<table border=1>
75<tr><td>switch
76<td>type i
77<td>Omittable : default value = 2
78<td></table>
79<p><br><p><dt><b>saveHistory [<i>fileName</i>]</b>
80<p><dd>
81Store command history to a file.<br>
82Defaul file name is G4history.macro.<br>
83<p><dd>Available at all Geant4 states.
84<p><dd>Parameters<table border=1>
85<tr><td>fileName
86<td>type s
87<td>Omittable : default value = G4History.macro
88<td></table>
89<p><br><p><dt><b>stopSavingHistory</b>
90<p><dd>
91Stop saving history file.<br>
92<p><dd>Available at all Geant4 states.
93<p><br><p><dt><b>alias [<i>aliasName</i>] [<i>aliasValue</i>]</b>
94<p><dd>
95Set an alias.<br>
96String can be aliased by this command.<br>
97The string may contain one or more spaces,<br>
98the string must be enclosed by double quotes (").<br>
99To use an alias, enclose the alias name with<br>
100parenthis "{" and "}".<br>
101<p><dd>Available at all Geant4 states.
102<p><dd>Parameters<table border=1>
103<tr><td>aliasName
104<td>type s
105<td><td><tr><td>aliasValue
106<td>type s
107<td><td></table>
108<p><br><p><dt><b>unalias [<i>aliasName</i>]</b>
109<p><dd>
110Remove an alias.<br>
111<p><dd>Available at all Geant4 states.
112<p><dd>Parameters<table border=1>
113<tr><td>aliasName
114<td>type s
115<td><td></table>
116<p><br><p><dt><b>listAlias</b>
117<p><dd>
118List aliases.<br>
119<p><dd>Available at all Geant4 states.
120<p><br><p><dt><b>shell [<i></i>]</b>
121<p><dd>
122Execute a (Unix) SHELL command.<br>
123<p><dd>Available at all Geant4 states.
124<p><dd>Parameters<table border=1>
125<tr><td>
126<td>type s
127<td><td></table>
128<p><br><p><dt><b>manual [<i>dirPath</i>]</b>
129<p><dd>
130Display all of sub-directories and commands.<br>
131Directory path should be given by FULL-PATH.<br>
132<p><dd>Available at all Geant4 states.
133<p><dd>Parameters<table border=1>
134<tr><td>dirPath
135<td>type s
136<td>Omittable : default value = /
137<td></table>
138<p><br><p><dt><b>createHTML [<i>dirPath</i>]</b>
139<p><dd>
140Generate HTML files for all of sub-directories and commands.<br>
141Directory path should be given by FULL-PATH.<br>
142<p><dd>Available at all Geant4 states.
143<p><dd>Parameters<table border=1>
144<tr><td>dirPath
145<td>type s
146<td>Omittable : default value = /
147<td></table>
148<p><br><p><dt><b>maximumStoredHistory [<i>max</i>]</b>
149<p><dd>
150Set maximum number of stored UI commands.<br>
151<p><dd>Available at all Geant4 states.
152<p><dd>Parameters<table border=1>
153<tr><td>max
154<td>type i
155<td>Omittable : default value = 20
156<td></table>
157</dl></body></html>
Note: See TracBrowser for help on using the repository browser.