axlSetRunDistributeOptions

axlSetRunDistributeOptions( 
x_hsdb 
[ ?RunIn t_runIn ]
[ ?DivideJobs t_divideJobs ]
[ ?JobLimit n_jobLimit ]
) 
=> t / nil 

Description

Sets the specified run option settings for the given setup database. These settings are also visible in the Run Options form.

Arguments

x_hsdb	Handle to the setup database.
?RunIn t_runIn	Describes how multiple simulations need to run. Valid values: Parallel, Serial.
?DivideJobs t_divideJobs
	Specifies how the ICRPs can be divided among the simulation runs. Valid values: Specify, Equally.
?JobLimit n_jobLimit
	Specifies the maximum number of jobs that can run when ?DivideJobs is set to Specify. Note: This value is not considered when ?DivideJobs is set to Equally.

Value Returned

t	Run option settings are set for the given setup database.
nil	The command was unsuccessful.

Examples

The following example sets run options to run ICRPs in parallel with a maximum of three jobs per run:

sdb = axlGetMainSetupDB(axlGetWindowSession()) 
axlSetRunDistributeOptions(sdb ?RunIn 'Parallel ?DivideJobs 'Specify ?JobLimit 3)
=> t

Related Topics

axlGetRunDistributeOptions

Return to top