ExecutionMode
An ExecutionMode represents the various ways of executing a model. Two modes, named LOAD and RUN, are defined for all preojects, but others can be specified as part of the model. The name of an execution mode may optionally passed to
ScenarioProperties#execute to specify how the execution is to take place.
Method summary
| name | description |
|---|---|
| getClearsInputData | Whether use of this execution mode will cause input data to be cleared. The LOAD execution mode has this property set. |
| getDescription | Descriptive text about the execution mode (may be blank) |
| getName | Name of the execution mode |
| getNumberOfThreads | Reeturns either a number representing a positive integer (denoting the number of threads this execution mode is limited to), or undefined (denoting no limit at all). This representation means that the result of this method can be used in a conditional expression to test if there is a thread limit; and further, if there is no limit, use of it in an arithmetic expression will treat it as if it were NaN. |
constructor
Constructor
Creates an Execution mode. The constructor should not be invoked directly, instances can be obtained via Project#getExecutionModes.
Parameters:
params
| Name | Type | Description |
|---|---|---|
| data | Payload data for execution mode |
details
Methods
- getClearsInputData ( ) → {boolean}
-
Whether use of this execution mode will cause input data to be cleared. The LOAD execution mode has this property set.
detailsReturns:returns table
Back to TopType Description typeboolean - getDescription ( ) → {string}
-
Descriptive text about the execution mode (may be blank)
detailsReturns:returns table
Back to TopType Description typestring - getName ( ) → {string}
-
Name of the execution mode
detailsReturns:returns table
Back to TopType Description typestring - getNumberOfThreads ( ) → {number|undefined}
-
Reeturns either a number representing a positive integer (denoting the number of threads this execution mode is limited to), or undefined (denoting no limit at all). This representation means that the result of this method can be used in a conditional expression to test if there is a thread limit; and further, if there is no limit, use of it in an arithmetic expression will treat it as if it were NaN.
detailsReturns:returns table
Back to TopType Description typenumber | undefined
method
method
method
method