axlGetRunOption
axlGetRunOption(
x_hsdb
t_mode
t_runoptName
)
=> x_runOption / nil
Description
Returns a handle to the named run option (t_runoptName) in the setup database for the specified run mode (t_mode).
Arguments
|
x_hsdb
|
Setup database handle.
|
|
t_mode
|
Run mode. Valid values are:
-
Sampling -
Global Optimization -
Local Optimization -
Monte Carlo Sampling
|
|
t_runoptName
|
Run option name. Valid Values depend on t_mode as follows:
For Sampling:
-
points: Number of sampling points.
For Global Optimization:
-
tillsatisfied: Optimization stops when all goals are met. -
timelimit: Optimization stops when the program reaches the time limit (in minutes). -
numpoints: Optimization stops when the program reaches the number of points.
|
|
|
-
ptswithnoimprovement: Optimization stops when there is no improvement for the number of points.
For Local Optimization:
-
effort: Optimization effort -
tillsatisfied: Optimization stops when all goals are met. -
timelimit: Optimization stops when the program reaches the time limit (in minutes). -
numpoints: Optimization stops when the program reaches the number of points. -
ptswithnoimprovement: Optimization stops when there is no improvement for the number of points.
For Monte Carlo Sampling:
-
mcmethod: Monte Carlo Sampling method. -
mcnumpoints: Number of Monte Carlo sampling points.
Typically, this number should be at least the number of statistical variables.
|
Value Returned
|
x_runOption
|
Handle to the named run option.
|
|
nil
|
The command could not be run.
|
Examples
Returns a handle to the named run option (t_runoptName) in the setup database for the Monte Carlo Sampling run mode
x_mainSDB=axlGetMainSetupDB(axlGetWindowSession())
runopth = axlGetRunOption(x_mainSDB "Monte Carlo Sampling" "savemismatch")
=> 3862
axlGetRunOptionValue(runopth)
=>"0"
Related Topics
axlGetRunOptionName
axlSetRunOptionName
Return to top