Product Documentation
Virtuoso ADE SKILL Reference
Product Version IC23.1, November 2023

maeGetCurrentRunMode

maeGetCurrentRunMode(
[ ?session t_sessionName ]
[ ?run t_runName ]
[ ?Abbreviations g_abbreviation ]
)
=> t_runModeName / nil

Description

Returns the name of the run mode set in the given session or the given run.

Arguments

?session t_sessionName

Name of an ADE Assembler session.

If not specified, the currently active session is considered.

?run t_runName

Name of the run from the run plan for which you need to get the run mode.

If not specified, the run mode of the session is returned.

?Abbreviations g_abbreviation

Specifies whether the abbreviated form of the run mode name must be returned.

For example, for the "Single Run, Sweeps, and Corners" run mode, "SRSC" is returned.

Value Returned

t_runModeName

Name of the run mode set in the given session or the given run.

nil

The name of the run mode is not returned.

Examples

Returns the run mode for the current session.

maeGetCurrentRunMode()
=> "Single Run, Sweeps and Corners"

Returns the run mode for a specific run in the current session.

maeGetCurrentRunMode(?run "Run.1")
=> "Monte Carlo"

Return to top
 ⠀
X