AccessStoppingCondition#

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

Bases: IComponentInfo, ICloneable, IStoppingConditionComponent, IRuntimeTypeInfoProvider

The Access stopping condition.

Overview#

Methods

set_base_selection

BaseSelection.

Properties

`time_convergence`	Get or set the time tolerance that is used by the access algorithms to determine the start times and stop times of access intervals. Uses Time dimension.
`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.
`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.
`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.
`aberration_type`	Get or set the model of aberration to be used in access computations.
`base_selection_type`	Get the base object for the access calculation.
`base_selection`	Return the base selection object.
`clock_host`	Time values are reported with a clock colocated with the clock host object.
`signal_sense`	Get or set the direction of the signal.
`target_object`	Get the target object for the access calculation.
`time_delay_convergence_tolerance`	Get or set the tolerance used when iterating to determine the light time delay. The iteration stops when the improvement in the value is less than this tolerance. Uses Time Dimension.
`use_light_time_delay`	Whether to consider light time delay in access computations.

Import detail#

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

Property detail#

property AccessStoppingCondition.time_convergence: float#: Get or set the time tolerance that is used by the access algorithms to determine the start times and stop times of access intervals. Uses Time dimension.

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

property AccessStoppingCondition.constraints: ConstraintCollection#: Further conditions that must be met in order for the stopping condition to be deemed satisfied.

property AccessStoppingCondition.criterion: AccessCriterion#: Specify the direction from which the stopping condition value must be achieved.

property AccessStoppingCondition.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 AccessStoppingCondition.aberration_type: AberrationType#: Get or set the model of aberration to be used in access computations.

property AccessStoppingCondition.base_selection_type: BaseSelection#: Get the base object for the access calculation.

property AccessStoppingCondition.base_selection: ILinkToObject#: Return the base selection object.

property AccessStoppingCondition.clock_host: IvClockHost#: Time values are reported with a clock colocated with the clock host object.

property AccessStoppingCondition.signal_sense: IvTimeSense#: Get or set the direction of the signal.

property AccessStoppingCondition.target_object: ILinkToObject#: Get the target object for the access calculation.

property AccessStoppingCondition.time_delay_convergence_tolerance: float#: Get or set the tolerance used when iterating to determine the light time delay. The iteration stops when the improvement in the value is less than this tolerance. Uses Time Dimension.

property AccessStoppingCondition.use_light_time_delay: bool#: Whether to consider light time delay in access computations.

Method detail#

AccessStoppingCondition.set_base_selection(self, selection: BaseSelection) → None#

BaseSelection.

Parameters:: selection : BaseSelection
Returns:: None