BisectionResult#

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

Result parameters for Bisection 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_value

Get or set the value that you want to achieve.

tolerance

Get or set the profile will stop when it achieves a value within this range of the Desired Value.

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 BisectionResult

Property detail#

property BisectionResult.enable: bool#

If true, the variable is being used.

property BisectionResult.name: str#

Get the name of the parameter.

property BisectionResult.parent_name: str#

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

property BisectionResult.current_value: Any#

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

property BisectionResult.desired_value: Any#

Get or set the value that you want to achieve.

property BisectionResult.tolerance: Any#

Get or set the profile will stop when it achieves a value within this range of the Desired Value.

property BisectionResult.use_custom_display_unit: bool#

If true, allows display of values in another unit.

property BisectionResult.custom_display_unit: str#

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