SearchPluginResult#

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

Equality constraints for a plugin search profile.

Overview#

result_name

Get the name of the equality constraint.

current_value

Get the current value of the result variable.

parent_segment_name

Get the parent segment of the result variable.

plugin_identifier

Get the plugin identifier.

plugin_config

Get the properties of the selected plugin.

dimension

Get the dimension of the values.

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.

values

List of values of this dependent variable at each iteration, including nominal run. Dimension depends on context.

Import detail#

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

Property detail#

property SearchPluginResult.result_name: str#

Get the name of the equality constraint.

property SearchPluginResult.current_value: Any#

Get the current value of the result variable.

property SearchPluginResult.parent_segment_name: str#

Get the parent segment of the result variable.

property SearchPluginResult.plugin_identifier: str#

Get the plugin identifier.

property SearchPluginResult.plugin_config: PluginProperties#

Get the properties of the selected plugin.

property SearchPluginResult.dimension: str#

Get the dimension of the values.

property SearchPluginResult.use_custom_display_unit: bool#

If true, allows display of values in another unit.

property SearchPluginResult.custom_display_unit: str#

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

property SearchPluginResult.values: list#

List of values of this dependent variable at each iteration, including nominal run. Dimension depends on context.