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