VelmaSimRunner Quick Reference
Commands
These are the commands that aVelmaSimRunner accepts:
| Command | KeyName? | Value? | Description |
|---|---|---|---|
| add | <key> | <value> | Adds the specified value to the specified <key>'s default value. |
| add | config_item | <config_name> | Adds a new item to the configuration list. The <config_name> must be the name of a VELMA simulation configuration .xml file. VelmaSimRunner will look for this .xml file in the directory specified for the config_location key. |
| delete | config_item | <index#> | Removes the item at the specified (zero-based) integer <index#> from the configuration list. |
| exit | Exits the VelmaSimRunner interpreter. | ||
| list | Lists all current defaults key-value settings and configuration list items. | ||
| load | <confg_file_name> | loads and evaluates a sequence of commands from file <confg_file_name>. | |
| reset | Resets all defaults to original values and removes all items from configuration list. | ||
| run | Runs the current configuration list's items, in order of their indices. | ||
| set | <key> | <value> | Sets the specified value as the specified key's default value. Replaces specified <key>'s current default value with specified <value>. |
| set | <key> | Removes <key>'s current value. (This is how to clear/reset a default <key>'s value.) |
DEFAULTS Keys
The following key names can be assigned values that serve as defaults when VelmaSimRunner constructs simulation command lines to run.
| Key Name | Description |
|---|---|
| vm_name | The name of the virtual machine ("vm") to run (usually java). |
| vm_args | Zero or more arguments to pass to the vm at runtime. |
| vm_classpath | The classpath (including the "-cp" or "--classpath" argument itself) for when vm_name is "java". (e.g. -cp C:\Users\me\VelmaUtils\bin;C:\Users\me\VelmaSimulator\bin) |
| tool_name | The VELMA simulator or utility tool to run (e.g. VelmaSimulatorCmdLine or VelmaParallelCmdLine). |
| tool_before_args | Any command line arguments that should appear after vm_name and its args, but before tool_name on the command line to run. |
| config_location | The (fully-qualified) path to the directory where config_item is located. |
| config_item | Used exclusively with the add command to add a VELMA simulation configuration .xml file to list of configs to run. |
| tool_after_args | Any command line arguments that should appear after tool_name on the command line to run. |
| results_prefix | An optional prefix string that will be pre-pended to the simulation results for configs that are run. |