MCSPropagate#

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

Bases: IMCSSegment, IComponentInfo, ICloneable, IRuntimeTypeInfoProvider

The Propagate segment.

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

`propagator_name`	Get or set the propagator.
`stopping_conditions`	Get the list of stopping conditions defined for the segment.
`min_propagation_time`	Get or set the minimum time that must elapse from the beginning of the segment until Astrogator will begin checking stopping conditions for satisfaction. Uses Time Dimension.
`max_propagation_time`	Get or set the maximum propagation time, after which the segment will end regardless of whether the stopping conditions have been satisfied. Uses Time Dimension.
`enable_max_propagation_time`	If true, the maximum propagation time is enforced.
`enable_warning_message`	If true, Astrogator will issue a warning message if propagation is stopped by the Maximum Propagation Time parameter.
`control_parameters_available`	Return whether or not the control parameters can be set.
`override_max_propagation_time`	Override Maximum Propagation Time - if there is a duration or epoch stopping condition that occurs after the maximum propagation time, ignore the maximum propagation time.
`should_stop_for_initially_surpassed_epoch_stopping_conditions`	Stop immediately if propagation begins beyond an active epoch stopping condition.
`should_reinitialize_stm_at_start_of_segment_propagation`	If this segment is propagating the state transition matrix, reset it to the identity matrix at the start of the segment.

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

property MCSPropagate.stopping_conditions: StoppingConditionCollection#: Get the list of stopping conditions defined for the segment.

property MCSPropagate.min_propagation_time: float#: Get or set the minimum time that must elapse from the beginning of the segment until Astrogator will begin checking stopping conditions for satisfaction. Uses Time Dimension.

property MCSPropagate.max_propagation_time: float#: Get or set the maximum propagation time, after which the segment will end regardless of whether the stopping conditions have been satisfied. Uses Time Dimension.

property MCSPropagate.enable_max_propagation_time: bool#: If true, the maximum propagation time is enforced.

property MCSPropagate.enable_warning_message: bool#: If true, Astrogator will issue a warning message if propagation is stopped by the Maximum Propagation Time parameter.

property MCSPropagate.control_parameters_available: bool#: Return whether or not the control parameters can be set.

property MCSPropagate.override_max_propagation_time: bool#: Override Maximum Propagation Time - if there is a duration or epoch stopping condition that occurs after the maximum propagation time, ignore the maximum propagation time.

property MCSPropagate.should_stop_for_initially_surpassed_epoch_stopping_conditions: bool#: Stop immediately if propagation begins beyond an active epoch stopping condition.

property MCSPropagate.should_reinitialize_stm_at_start_of_segment_propagation: bool#: If this segment is propagating the state transition matrix, reset it to the identity matrix at the start of the segment.

MCSPropagate.enable_control_parameter(self, param: ControlAdvanced) → None#

Enable or disables the specified control parameter.

MCSPropagate.disable_control_parameter(self, param: ControlAdvanced) → None#

Disables the specified control parameter.

MCSPropagate.is_control_parameter_enabled(self, param: ControlAdvanced) → bool#

Sees if the specified control is enabled.