AsTriggerCondition#

class ansys.stk.core.stkobjects.astrogator.AsTriggerCondition#

Bases: IComponentInfo, ICloneable

Constraint.

Overview#

Methods

`copy_calculation_object_to_clipboard`	Copy calculation object to clipboard.
`paste_calculation_object_from_clipboard`	Replace calculation object with instance in clipboard.

Properties

`criteria`	Get or set the criteria to be applied to the desired value.
`calculation_object`	Get or set the calculation object to perform calculation to evaluate condition.
`calculation_object_name`	Get or set the name of the calculation object to perform calculation to evaluate condition.
`value`	Get or set the value to satisfy the condition. Dimension depends on CalcObject.
`tolerance`	How closely the test parameter must approximate the desired value for the constraint. Dimension depends on CalcObject.
`use_absolute_value`	Whether or not to take the absolute value of the calculation.

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

property AsTriggerCondition.criteria: Criteria#: Get or set the criteria to be applied to the desired value.

property AsTriggerCondition.calculation_object: IComponentInfo#: Get or set the calculation object to perform calculation to evaluate condition.

property AsTriggerCondition.calculation_object_name: str#: Get or set the name of the calculation object to perform calculation to evaluate condition.

property AsTriggerCondition.value: Any#: Get or set the value to satisfy the condition. Dimension depends on CalcObject.

property AsTriggerCondition.tolerance: Any#: How closely the test parameter must approximate the desired value for the constraint. Dimension depends on CalcObject.

property AsTriggerCondition.use_absolute_value: bool#: Whether or not to take the absolute value of the calculation.

AsTriggerCondition.copy_calculation_object_to_clipboard(self) → None#

Copy calculation object to clipboard.

AsTriggerCondition.paste_calculation_object_from_clipboard(self) → None#

Replace calculation object with instance in clipboard.