system.secsgem.startSimEventRun
This function is used in Python Scripting.
Description
Starts a configured simulator event run in the Gateway. Note, that this function only works with the simulators that come included with the SECS/GEM module.
The function will throw an exception if the specified Event Run cannot be started.
Client Permission Restrictions
Permission Type: SECS/GEM Management
Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when called in the Gateway scope.
Syntax
system.secsgem.startSimEventRun(simulatorName, eventRunName)
Parameters
| Type | Parameter | Description |
|---|---|---|
| String | simulatorName | The simulator that holds the configured event run. Will throw an exception if the specified simulator can't be found. |
| String | eventRunName | The event run to start. Will throw an exception if the specified simulator can't be found. |
Returns
None
Scope
Gateway, Designer, Client
Code Examples
Code Snippet
# This examples requires that the Gateway has a simulator named "simulator1", and
# an Event Run in that same simulator named "myEventRun".
mySimulator = "simulator1"
eventRun = "myEventRun"
system.secsgem.startSimEventRun(mySimulator, eventRun)