UserVariable

class ansys.stk.core.stkobjects.astrogator.UserVariable

User Variable.

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	Set the name of the user variable.
variable_value	Get or set the initial value of the user variable.
control_parameters_available	Return whether or not the control parameters can be set.

Import detail

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

Property detail

property UserVariable.unit_dimension: str

Get the dimension of the user variable.

property UserVariable.variable_name: str

Set the name of the user variable.

property UserVariable.variable_value: Any

Get or set the initial value of the user variable.

property UserVariable.control_parameters_available: bool

Return whether or not the control parameters can be set.

Method detail

UserVariable.enable_control_parameter(self) → None

Enable or disables the specified control parameter.

Returns:

None

UserVariable.disable_control_parameter(self) → None

Disables the specified control parameter.

Returns:

None

UserVariable.is_control_parameter_enabled(self) → bool

Sees if the specified control is enabled.

Returns:

bool