axlSetRunOptionValue

axlSetRunOptionValue( 
x_runOptionHandle 
t_runOptionValue
) 
=> t / nil 

Description

Sets a value for the given run option.

Arguments

x_runOptionHandle
	Handle to the run option for which you need to set a value. To find the valid names of run options for a run mode, use the axlGetRunOptions function.
t_runOptionValue
	Value of the given run option.

Value Returned

t	A value was set for the given run option.
nil	The command was unsuccessful.

Examples

The following example code displays and changes the value for a Monte Carlo run option:

session = axlGetWindowSession()
x_mainSDB = axlGetMainSetupDB(session)
axlGetRunOptions( x_mainSDB "Monte Carlo Sampling")

=> (1452 

    ("dutsummary" "ignoreflag" "mcmethod" "mcnumpoints" "mcnumbins"
    "mcStopEarly" "mcStopMethod" "samplingmode" "saveprocess" "savemismatch"
    "mcreferencepoint" "donominal" "saveallplots" "montecarloseed"
    "mcstartingrunnumber" "mcYieldTarget" "mcYieldAlphaLimit"
    )
) 

x_runOption = axlGetRunOption(x_mainSDB "Monte Carlo Sampling" "mcnumpoints")
axlGetRunOptionValue(x_runOption) 
=> "200"
;; changing the value of mcnumpoints to 400

axlSetRunOptionValue(x_runOption "400") 
=> t

;; setting a value for the savemismatch option for Monte Carlo
(axlSetRunOptionValue (axlPutRunOption (axlGetActiveSetup (axlGetMainSetupDB ( axlGetWindowSession ))) "Monte Carlo Sampling" "savemismatch") "1")

Related Topics

axlGetRunOptions

Return to top