LightingStoppingCondition#

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

Bases: IComponentInfo, ICloneable, IStoppingConditionComponent, IRuntimeTypeInfoProvider

The Lighting stopping condition.

Overview#

Methods

`add_eclipsing_body`	Add an eclipsing body.
`remove_eclipsing_body`	Remove an eclipsing body.

Properties

`max_trip_times`	Rhe maximum number of times that the stopping condition will be applied - and any resulting automatic sequences executed. Dimensionless.
`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.
`constraints`	Further conditions that must be met in order for the stopping condition to be deemed satisfied.
`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.
`inherited`	Condition Inherited by Automatic Sequences - if true, the stopping condition will be applied to any automatic sequences activated within the same segment.
`sequence`	Get or set the automatic sequence to trigger if the highlighted stopping condition is satisfied.
`condition`	Specify the direction from which the stopping condition value must be achieved.
`eclipsing_bodies_list_source`	Eclipsing Bodies List Source.
`eclipsing_bodies`	Return a list of user selected eclipsing bodies.
`available_eclipsing_bodies`	Return a list of available eclipsing bodies.

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

property LightingStoppingCondition.max_trip_times: float#: Rhe maximum number of times that the stopping condition will be applied - and any resulting automatic sequences executed. Dimensionless.

property LightingStoppingCondition.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 LightingStoppingCondition.constraints: ConstraintCollection#: Further conditions that must be met in order for the stopping condition to be deemed satisfied.

property LightingStoppingCondition.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 LightingStoppingCondition.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 LightingStoppingCondition.sequence: str#: Get or set the automatic sequence to trigger if the highlighted stopping condition is satisfied.

property LightingStoppingCondition.condition: LightingCondition#: Specify the direction from which the stopping condition value must be achieved.

property LightingStoppingCondition.eclipsing_bodies_list_source: EclipsingBodiesSource#: Eclipsing Bodies List Source.

property LightingStoppingCondition.eclipsing_bodies: list#: Return a list of user selected eclipsing bodies.

property LightingStoppingCondition.available_eclipsing_bodies: list#: Return a list of available eclipsing bodies.

LightingStoppingCondition.add_eclipsing_body(self, eclipsing_body: str) → None#

Add an eclipsing body.

LightingStoppingCondition.remove_eclipsing_body(self, eclipsing_body: str) → None#

Remove an eclipsing body.