MCSUpdate

class ansys.stk.core.stkobjects.astrogator.MCSUpdate

Bases: IMCSSegment, IRuntimeTypeInfoProvider, IComponentInfo, ICloneable

The Update segment.

Overview

Methods

set_action_and_value	Set an action and the new value.
get_action	Get the action type for a parameter.
get_value	Get the value type for a parameter.
set_action	Set the update action type.
set_value	Set the update value.
disable_control_parameter	Disables the specified control parameter.
enable_control_parameter	Enable the specified control parameter.
is_control_parameter_enabled	Sees if the specified control is enabled.

Properties

control_parameters_available	Return whether or not the control parameters can be set.
user_variables	Interface used to modify user variables for the update segment.

Import detail

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

Property detail

property MCSUpdate.control_parameters_available: bool

Return whether or not the control parameters can be set.

property MCSUpdate.user_variables: UserVariableUpdateCollection

Interface used to modify user variables for the update segment.

Method detail

MCSUpdate.set_action_and_value(self, parameter_type: UpdateParam, action_type: UpdateAction, value: float) → None

Set an action and the new value.

Parameters:

parameter_type : UpdateParam

action_type : UpdateAction

value : float

Returns:

None

MCSUpdate.get_action(self, parameter_type: UpdateParam) → UpdateAction

Get the action type for a parameter.

Parameters:

parameter_type : UpdateParam

Returns:

UpdateAction

MCSUpdate.get_value(self, parameter_type: UpdateParam) → float

Get the value type for a parameter.

Parameters:

parameter_type : UpdateParam

Returns:

float

MCSUpdate.set_action(self, parameter_name: UpdateParam, action_type: UpdateAction) → None

Set the update action type.

Parameters:

parameter_name : UpdateParam

action_type : UpdateAction

Returns:

None

MCSUpdate.set_value(self, parameter_name: UpdateParam, value: float) → None

Set the update value.

Parameters:

parameter_name : UpdateParam

value : float

Returns:

None

MCSUpdate.disable_control_parameter(self, param: ControlUpdate) → None

Disables the specified control parameter.

Parameters:

param : ControlUpdate

Returns:

None

MCSUpdate.enable_control_parameter(self, param: ControlUpdate) → None

Enable the specified control parameter.

Parameters:

param : ControlUpdate

Returns:

None

MCSUpdate.is_control_parameter_enabled(self, param: ControlUpdate) → bool

Sees if the specified control is enabled.

Parameters:

param : ControlUpdate

Returns:

bool