StoppingCondition

class ansys.stk.core.stkobjects.astrogator.StoppingCondition

Bases: IComponentInfo, ICloneable, IStoppingConditionComponent, IRuntimeTypeInfoProvider

A stopping condition.

Overview

Methods

copy_user_calculation_object_to_clipboard	Copy the user-defined stopping condition calc object to the clipboard.
paste_user_calculation_object_from_clipboard	Replace the user-defined stopping condition calc object with the calc object in the clipboard.

Properties

trip	Get or set the desired value - the value at which the condition will be satisfied. Dimension depends on context.
tolerance	Get or set the desired tolerance for achieving the stopping condition. Dimension depends on context.
repeat_count	Get or set the number of times the condition must be satisfied before the propagation ends or moves on to the designated automatic sequence. Dimensionless.
inherited	Condition Inherited by Automatic Sequences - if true, the stopping condition will be applied to any automatic sequences activated within the same segment.
max_trip_times	Get or set the maximum number of times that the stopping condition will be applied - and any resulting automatic sequences executed. Dimensionless.
coord_system	Get or set the coordinate system. The default coordinate system of a stopping condition is Earth Inertial.
sequence	Get or set the automatic sequence to trigger if the highlighted stopping condition is satisfied.
constraints	Further conditions that must be met in order for the stopping condition to be deemed satisfied.
user_calculation_object_name	User Calc Object - a User Calculation Object for the highlighted stopping condition. For user-defined stopping conditions, use this field to specify what kind of value you want to stop on.
user_calculation_object	A User Calculation Object for the highlighted stopping condition. For user-defined stopping conditions, use this field to specify what kind of value you want to stop on.
central_body_name	Get or set the central body. The default central body of a stopping condition is the Earth.
criterion	Specify the direction from which the stopping condition value must be achieved.
before_conditions	A ‘before’ stopping condition is used to define a stopping condition that depends on two events. Astrogator will ignore a stopping condition until its ‘before’ conditions are met. Astrogator then interpolates backwards to the normal stopping condition.
dimension	Get the dimension of the stopping condition.
reference_point	Get or set the reference point used for calculation.
user_calculation_object_link_embed_control	Get the link / embed controller for managing the user calc. object.

Import detail

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

Property detail

property StoppingCondition.trip: Any

Get or set the desired value - the value at which the condition will be satisfied. Dimension depends on context.

property StoppingCondition.tolerance: float

Get or set the desired tolerance for achieving the stopping condition. Dimension depends on context.

property StoppingCondition.repeat_count: float

Get or set the number of times the condition must be satisfied before the propagation ends or moves on to the designated automatic sequence. Dimensionless.

property StoppingCondition.inherited: bool

Condition Inherited by Automatic Sequences - if true, the stopping condition will be applied to any automatic sequences activated within the same segment.

property StoppingCondition.max_trip_times: float

Get or set the maximum number of times that the stopping condition will be applied - and any resulting automatic sequences executed. Dimensionless.

property StoppingCondition.coord_system: str

Get or set the coordinate system. The default coordinate system of a stopping condition is Earth Inertial.

property StoppingCondition.sequence: str

Get or set the automatic sequence to trigger if the highlighted stopping condition is satisfied.

property StoppingCondition.constraints: ConstraintCollection

Further conditions that must be met in order for the stopping condition to be deemed satisfied.

property StoppingCondition.user_calculation_object_name: str

User Calc Object - a User Calculation Object for the highlighted stopping condition. For user-defined stopping conditions, use this field to specify what kind of value you want to stop on.

property StoppingCondition.user_calculation_object: IComponentInfo

A User Calculation Object for the highlighted stopping condition. For user-defined stopping conditions, use this field to specify what kind of value you want to stop on.

property StoppingCondition.central_body_name: str

Get or set the central body. The default central body of a stopping condition is the Earth.

property StoppingCondition.criterion: Criterion

Specify the direction from which the stopping condition value must be achieved.

property StoppingCondition.before_conditions: StoppingConditionCollection

A ‘before’ stopping condition is used to define a stopping condition that depends on two events. Astrogator will ignore a stopping condition until its ‘before’ conditions are met. Astrogator then interpolates backwards to the normal stopping condition.

property StoppingCondition.dimension: str

Get the dimension of the stopping condition.

property StoppingCondition.reference_point: str

Get or set the reference point used for calculation.

property StoppingCondition.user_calculation_object_link_embed_control: IComponentLinkEmbedControl

Get the link / embed controller for managing the user calc. object.

Method detail

StoppingCondition.copy_user_calculation_object_to_clipboard(self) → None

Copy the user-defined stopping condition calc object to the clipboard.

Returns:

None

StoppingCondition.paste_user_calculation_object_from_clipboard(self) → None

Replace the user-defined stopping condition calc object with the calc object in the clipboard.

Returns:

None