GridSearchResult#

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

Result 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.

desired_operation

Get or set the Desired Operation/Objective of grid search.

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.

Import detail#

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

Property detail#

property GridSearchResult.enable: bool#

If true, the variable is being used.

property GridSearchResult.name: str#

Get the name of the parameter.

property GridSearchResult.parent_name: str#

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

property GridSearchResult.current_value: Any#

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

property GridSearchResult.desired_operation: GridSearchDesiredOperation#

Get or set the Desired Operation/Objective of grid search.

property GridSearchResult.use_custom_display_unit: bool#

If true, allows display of values in another unit.

property GridSearchResult.custom_display_unit: str#

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