UserVariableUpdate

class ansys.stk.core.stkobjects.astrogator.UserVariableUpdate

User Variable Update.

Overview

Methods

enable_control_parameter	Enable or disables the specified control parameter.
disable_control_parameter	Disables the specified control parameter.
is_control_parameter_enabled	Sees if the specified control is enabled.

Properties

unit_dimension	Get the dimension of the user variable.
variable_name	Get the name of the user variable.
variable_value	Update value of the user variable.
variable_action	Action to be performed using the value.
control_parameters_available	Return whether or not the control parameters can be set.

Import detail

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

Property detail

property UserVariableUpdate.unit_dimension: str

Get the dimension of the user variable.

property UserVariableUpdate.variable_name: str

Get the name of the user variable.

property UserVariableUpdate.variable_value: Any

Update value of the user variable.

property UserVariableUpdate.variable_action: UpdateAction

Action to be performed using the value.

property UserVariableUpdate.control_parameters_available: bool

Return whether or not the control parameters can be set.

Method detail

UserVariableUpdate.enable_control_parameter(self) → None

Enable or disables the specified control parameter.

Returns:

None

UserVariableUpdate.disable_control_parameter(self) → None

Disables the specified control parameter.

Returns:

None

UserVariableUpdate.is_control_parameter_enabled(self) → bool

Sees if the specified control is enabled.

Returns:

bool