StoppingConditionElement

class ansys.stk.core.stkobjects.astrogator.StoppingConditionElement

Bases: IComponentInfo, IRuntimeTypeInfoProvider

A stopping condition.

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

active	If true, the stopping condition is active.
control_parameters_available	Return whether or not the control parameters can be set.
properties	Get the properties available to the stopping condition.

Import detail

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

Property detail

property StoppingConditionElement.active: bool

If true, the stopping condition is active.

property StoppingConditionElement.control_parameters_available: bool

Return whether or not the control parameters can be set.

property StoppingConditionElement.properties: IStoppingConditionComponent

Get the properties available to the stopping condition.

Method detail

StoppingConditionElement.enable_control_parameter(self, param: ControlStoppingCondition) → None

Enable or disables the specified control parameter.

Parameters:

param : ControlStoppingCondition

Returns:

None

StoppingConditionElement.disable_control_parameter(self, param: ControlStoppingCondition) → None

Disables the specified control parameter.

Parameters:

param : ControlStoppingCondition

Returns:

None

StoppingConditionElement.is_control_parameter_enabled(self, param: ControlStoppingCondition) → bool

Sees if the specified control is enabled.

Parameters:

param : ControlStoppingCondition

Returns:

bool