maeGetRunPlan

maeGetRunPlan(
[ ?session t_sessionName ]
[ ?historyName t_historyName ]
[ ?enabled t_enabled ]
)
=> l_runPlanNames / nil

Description

Returns a list of all the runs available in the run plan for the given session or history.

This function is applicable only for ADE Assembler.

Arguments

?session t_sessionName
	Name of an ADE Assembler session. If not specified, the currently active session is used.
?historyName t_historyName
	Name of this history for which you want to get the names of child histories corresponding to each run in the run plan. Default value: ""
?enabled t_enabled
	Enabled or disabled status according to which you want to get a list of runs. Default value: "" This argument cannot be used with ?historyName.

Value Returned

l_runPlanNames	List of the names of run plans
nil	The list of run plan names is not returned.

Examples

Returns the names of runs for the current session.

maeGetRunPlan() 
=> ("Run.0" "Run.1")

Returns the names of runs for the given session.

sess= maeOpenSetup("solutions" "ampTest" "maestro")
=> "session0"
maeGetRunPlan(?session sess1)
=> ("Run.0" "Run.1" "Run.2")
Returns the names of runs for the given run plan history.

maeGetRunPlan(?historyName "Plan.0") 
=> ("Plan.0.Run.0" "Plan.0.Run.1")

Return to top