BisectionControl#

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

Control parameters for Bisection 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.

initial_value

Get the nominal value of the element selected as a parameter. Dimension depends on context.

current_value

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

bound_search_step

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.

Import detail#

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

Property detail#

property BisectionControl.enable: bool#

If true, the variable is being used.

property BisectionControl.name: str#

Get the name of the parameter.

property BisectionControl.parent_name: str#

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

property BisectionControl.initial_value: Any#

Get the nominal value of the element selected as a parameter. Dimension depends on context.

property BisectionControl.current_value: Any#

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

property BisectionControl.bound_search_step: Any#

Dimension depends on context.

property BisectionControl.use_custom_display_unit: bool#

If true, allows display of values in another unit.

property BisectionControl.custom_display_unit: str#

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