axlGetCurrentRunMode

axlGetCurrentRunMode( 
x_hsdb 
) 
=> t_mode / nil 

Description

Returns the current simulation run mode of a given session.

Argument

x_hsdb

Setup database handle.

Value Returned

t_mode	The current simulation run mode, which could be one of the following values: Single Run, Sweeps and Corners Monte Carlo Sampling Global Optimization Local Optimization Improve Yield Sensitivity Analysis
nil	The command could not be run.

Examples

The following example returns the run mode set in the current session:

sdb = axlGetMainSetupDB(axlGetWindowSession()) 
runMode = axlGetCurrentRunMode(sdb)
=> "Single Run, Sweeps and Corners"

The following example finds the run mode of the given history name:

(defun CCRaxlGetRunModeFromHistoryName (sdbh histName) 
(let (checkPoint)
checkPoint = (axlGetHistoryCheckpoint (axlGetHistoryEntry sdbh histName))
(axlGetCurrentRunMode checkPoint)
)
)

histName = "MonteCarlo.0"
sess = axlGetWindowSession()
sdbh = (axlGetMainSetupDB sess)
runMode = (CCRaxlGetRunModeFromHistoryName sdbh histName) (printf "Run mode for history %s = \"%s\"\n" histName runMode)
=> Run mode for history Interactive.0 = Single Run, Sweeps, and Corners

Related Topics

Specifying the Run Mode

Return to top