maeSaveSetupStateForOptimization
maeSaveSetupStateForOptimization(
[ ?session t_sessionName ]
[ ?run t_runName ]
[ ?setupState t_setupState ]
[ ?pointID x_pointID ]
[ ?historyName t_historyName ]
)
=> t / nil
Description
Saves the setup state for optimization from the best design point of a run or the given history. You can use this saved state as the starting point for an optimization run in a run plan.
Arguments
|
?session t_sessionName
|
|
|
Name of the session.
If not specified, the current session is used.
|
|
?run t_runName
|
Name of run from which the best point is to be saved in the setup state. If you do not specify a run, the function looks for the ?historyName argument. If both are not specified, the function returns an error.
The default value is "".
|
|
?setupState t_setupState
|
|
|
Name of setup state to be saved. If you do not specify any value, ADE Assembler saves the setup state with the name of the given run, the current history, or the given point ID.
The default value is "".
|
|
?pointID x_pointID
|
|
|
ID of the point from which the setup details are to be saved in the setup state. If you do not specify any point ID, ADE Assembler saves the setup state by using the details from the best point of the given history or the given run.
The default value is null.
|
|
?historyName t_historyName
|
|
|
Name of the history from which the setup state for the best point is to be used. If you do not specify any history, the tool uses the details from the current history.
The default value is "".
|
Value Returned
|
t
|
The setup state is saved.
|
|
nil
|
The setup state is not saved.
|
Example
Saves a setup state named newState for point 7 in history Plan.0 of the run named Run_opt1:
maeSaveSetupStateForOptimization(?session maeGetDefaultSession() ?run "Run_opt1" ?setupState "newState" ?pointID 7 ?historyName "Plan.0")
=> t
Return to top
