ProfileGridSearch#

class ansys.stk.core.stkobjects.astrogator.ProfileGridSearch#

Bases: IProfile, IRuntimeTypeInfoProvider

The Grid Search profile.

Overview#

controls

Get the list of control parameters defined for the profile.

enable_display_status

If true, a page will appear during the targeting run to report the status of the targeting effort in terms of proximity to the desired value for each dependent variable in the profile.

log_file

Name of the log file for this profile.

results

Get the list of results defined for the profile.

scripting_tool

Return the Scripting tool for the sequence.

should_generate_graph

If true, a plot is automatically generate the selected result value versus the control value for the grid search when the profile runs.

targeter_graphs

Graphs.

Import detail#

from ansys.stk.core.stkobjects.astrogator import ProfileGridSearch

Property detail#

property ProfileGridSearch.controls: GridSearchControlCollection#

Get the list of control parameters defined for the profile.

property ProfileGridSearch.enable_display_status: bool#

If true, a page will appear during the targeting run to report the status of the targeting effort in terms of proximity to the desired value for each dependent variable in the profile.

property ProfileGridSearch.log_file: str#

Name of the log file for this profile.

property ProfileGridSearch.results: GridSearchResultCollection#

Get the list of results defined for the profile.

property ProfileGridSearch.scripting_tool: ScriptingTool#

Return the Scripting tool for the sequence.

property ProfileGridSearch.should_generate_graph: bool#

If true, a plot is automatically generate the selected result value versus the control value for the grid search when the profile runs.

property ProfileGridSearch.targeter_graphs: TargeterGraphCollection#

Graphs.