GridSearchControl#

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

Control parameters for Grid Search profile.

Overview#

enable

If true, the variable is being used.

name

Get the name of the parameter.

parent_name

Get the name of the segment to which the parameter belongs.

current_value

Get the value of the independent variable after the last targeter run.

lower_bound

Dimension depends on context.

upper_bound

Dimension depends on context.

use_custom_display_unit

If true, allows display of values in another unit.

custom_display_unit

Get or set the unit in which the value will be displayed in the GUI.

step

Specify the step size to use when evaluating the grid search. Dimension depends on context.

Import detail#

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

Property detail#

property GridSearchControl.enable: bool#

If true, the variable is being used.

property GridSearchControl.name: str#

Get the name of the parameter.

property GridSearchControl.parent_name: str#

Get the name of the segment to which the parameter belongs.

property GridSearchControl.current_value: Any#

Get the value of the independent variable after the last targeter run.

property GridSearchControl.lower_bound: Any#

Dimension depends on context.

property GridSearchControl.upper_bound: Any#

Dimension depends on context.

property GridSearchControl.use_custom_display_unit: bool#

If true, allows display of values in another unit.

property GridSearchControl.custom_display_unit: str#

Get or set the unit in which the value will be displayed in the GUI.

property GridSearchControl.step: Any#

Specify the step size to use when evaluating the grid search. Dimension depends on context.