maeEnableParameter
maeEnableParameter(
[ ?run t_run ]
[ ?enable g_enable ]
[ ?session t_session ]
[ ?varList l_varList ]
[ ?all g_all ]
)
=> t / nil
Description
Enables or disables all of the given parameters for the given run in the run plan or in the active setup of ADE Assembler.
Arguments
|
?run t_run
|
Name of the run for which the parameters are to be enabled or disabled. By default, this argument is set to "" and the status of parameters is changed in the active setup of ADE Assembler.
|
|
?enable g_enable
|
A Boolean value that specifies the status to be set for the Parameters check box or the given list of parameters.
-
t: Selects the Parameters check box or the given list of parameters. This is the default. -
nil: Deselects the Parameters check box or the given list of parameters.
|
|
?session t_session
|
Name of the session. If not specified, the current session is used.
|
|
?varList l_varList
|
A list of the names of parameters to be enabled or disabled. This argument selects or deselects the check box corresponding to the parameters mentioned in the list.
By default, this argument is set to nil. If not specified, the function selects or deselects the Parameters 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 parameters added to the setup for a run are to be enabled or disabled. This argument works only if the Parameters check box is already enabled for the run.
-
t: Enables all the parameters added to the setup. -
nil: Disables all the parameters added to the setup. This is the default.
|
Value Returned
|
t
|
The status of the specified parameters is changed.
|
|
nil
|
The status of the variables is not changed.
|
Examples
Selects the Parameters check box for the run Run.0:
maeEnableParameter(?run "Run.0")
=> t
Enables the bertlink/osc13/schematic/C2/c parameter in the setup for the run Run.0 if the Parameters check box is already selected:
maeEnableParameter(?run "Run.0" ?varList '("bertlink/osc13/schematic/C2/c"))
=> t
Enables all the parameters in the setup for the run Run.0 if the Parameters check box is already selected:
maeEnableParameter(?run "Run.0" ?all t)
=> t
Disables the bertlink/osc13/schematic/C2/c parameter in the setup for the run Run.0:
maeEnableParameter(?run "Run.0" ?varList '("bertlink/osc13/schematic/C2/c") ?enable nil)
=> t
Related Topics
Modifying a Run in the Run Plan
Return to top