maeGetRelxTestEnabled

maeGetRelxTestEnabled(
t_relxSetupName
[ ?testType t_testType ]
[ ?run t_runName ]
[ ?session t_session ]
)
=> t / nil

Description

Returns the current status of a reliability stage in the specified reliability setup.

Arguments

t_relxSetupName	Name of the reliability setup.
?testType t_testType
	Stage of the reliability setup. Valid values: fresh, stress, aged. Default value: fresh
?run t_runName	Name of the run in a run plan. If you do not specify this argument, the status of the reliability stage is retrieved from the reliability setup saved in the active setup. This argument is useful only when the setup has a run plan.
?session t_session
	Name of the ADE Explorer or ADE Assembler session. Default: The current session.

Value Returned

t	The reliability stage is enabled in the reliability setup.
nil	The reliability stage is disabled in the reliability setup.

Examples

The following example indicates that the reliability stage fresh is enabled in the reliability setup relA saved in the active setup of the current maestro session.

maeGetRelxTestEnabled("relA")

=> t

The following example indicates that the reliability stage stress is disabled in the reliability setup relA saved in the active setup of the current maestro session.

maeGetRelxTestEnabled("relB" ?testType "stress")

=> nil

The following example indicates that the reliability stage fresh is disabled in the reliability setup relA saved in Run.0 in the current maestro session.

maeGetRelxTestEnabled("relA" ?testType "fresh" ?run "Run.0")

=> nil

The following example indicates that the reliability stage stress is enabled in the reliability setup relA saved in Run.0 in the current maestro session.

maeGetRelxTestEnabled("relA" ?testType "stress" ?run "Run.0")

=> t

Return to top