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

maeEnableGlobalVar

maeEnableGlobalVar(
[ ?run t_run ]
[ ?enable g_enable ]
[ ?session t_session ]
[ ?varList l_varList ]
[ ?all g_all ]
)
=> t / nil

Description

Enables or disables the global variables for the specified run in the run plan or in the active setup of ADE Assembler.

Arguments

?run t_run

Name of the run for which the global variables are to be enabled or disabled. By default, this argument is set to "" and the status of global variables is changed in the active setup of ADE Assembler.

?enable g_enable

A Boolean value that specifies the status to be set for the Global Variables check box or the given list of variables.

  • t: Selects the Global Variables check box or the given list of variables. This is the default.
  • nil: Deselects the Global Variables check box or the given list of variables.

?session t_session

Name of the session. If not specified, the current session is used.

?varList l_varList

A list of the names of variables to be enabled or disabled in the Design Variables or Global Variables section. This argument selects or deselects the check box corresponding to the variables mentioned in the list.

By default, this argument is set to nil. If not specified, the function selects or deselects the Global Variables check box for the run or in the Data View assistant depending on the value of ?run.

?all g_all

A Boolean value that specifies whether all the variables added to the setup for a run are to be enabled or disabled. This argument works only if the Global Variables check box is already enabled for the run.

  • t: Enables all the variables added to the setup.
  • nil: Disables all the variables added to the setup.

Value Returned

t

The status of the specified variables is changed.

nil

The status of the variables is not changed.

Examples

Selects the Global Variables check box for the run Run.0:

maeEnableGlobalVar(?run "Run.0") 
=> t

Enables the cload variable in the setup for the run Run.0 if the Global Variables check box is already selected:

maeEnableGlobalVar(?run "Run.0"  ?varList '("cload")) 
=> t

Enables all the variables in the setup for the run Run.0 if the Global Variables check box is already selected:

maeEnableGlobalVar(?run "Run.0"  ?all t) 
=> t

Disables cload in the setup for the run Run.0:

maeEnableGlobalVar(?run "Run.0"  ?varList '("cload") ?enable nil)
=> t

Related Topics

Modifying a Run in the Run Plan


Return to top
 ⠀
X