SearchPluginControl#

class ansys.stk.core.stkobjects.astrogator.SearchPluginControl#: Control parameters for a plugin search profile.

Overview#

Properties

`control_name`	Get the name of the control parameter.
`current_value`	Get the current value of the control parameter.
`parent_segment_name`	Get the parent segment of the control parameter.
`initial_value`	Get the initial value of the control parameter. Dimension depends on context.
`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 independent variable at each iteration, including nominal run. Dimension depends on context.

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

property SearchPluginControl.control_name: str#: Get the name of the control parameter.

property SearchPluginControl.current_value: Any#: Get the current value of the control parameter.

property SearchPluginControl.parent_segment_name: str#: Get the parent segment of the control parameter.

property SearchPluginControl.initial_value: Any#: Get the initial value of the control parameter. Dimension depends on context.

property SearchPluginControl.plugin_identifier: str#: Get the plugin identifier.

property SearchPluginControl.plugin_config: PluginProperties#: Get the properties of the selected plugin.

property SearchPluginControl.dimension: str#: Get the dimension of the values.

property SearchPluginControl.use_custom_display_unit: bool#: If true, allows display of values in another unit.

property SearchPluginControl.custom_display_unit: str#: Get or set the unit in which the value will be displayed in the GUI.

property SearchPluginControl.values: list#: List of values of this independent variable at each iteration, including nominal run. Dimension depends on context.