MCSHold#

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

Bases: IMCSSegment, IRuntimeTypeInfoProvider, IComponentInfo, ICloneable

The Hold 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

`step_size`	Get or set the time interval between calculated ephemeris output points. Uses Time Dimension.
`hold_frame_name`	Hold Frame - the reference frame of the Hold segment.
`enable_hold_attitude`	Enable Hold Altitude - if true, the spacecraft’s attitude is fixed within the hold frame.
`stopping_conditions`	Get the stopping conditions defined for the segment.
`min_propagation_time`	Minimum Propagation Time - 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`	Maximum Propagation Time - 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`	Enable Maximum Propagation Time - if true, the maximum propagation time will be 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.

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

property MCSHold.step_size: float#: Get or set the time interval between calculated ephemeris output points. Uses Time Dimension.

property MCSHold.hold_frame_name: str#: Hold Frame - the reference frame of the Hold segment.

property MCSHold.enable_hold_attitude: bool#: Enable Hold Altitude - if true, the spacecraft’s attitude is fixed within the hold frame.

property MCSHold.stopping_conditions: StoppingConditionCollection#: Get the stopping conditions defined for the segment.

property MCSHold.min_propagation_time: float#: Minimum Propagation Time - 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 MCSHold.max_propagation_time: float#: Maximum Propagation Time - the maximum propagation time, after which the segment will end regardless of whether the stopping conditions have been satisfied. Uses Time Dimension.

property MCSHold.enable_max_propagation_time: bool#: Enable Maximum Propagation Time - if true, the maximum propagation time will be enforced.

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

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

property MCSHold.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 MCSHold.should_stop_for_initially_surpassed_epoch_stopping_conditions: bool#: Stop immediately if propagation begins beyond an active epoch stopping condition.

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

Enable or disables the specified control parameter.

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

Disables the specified control parameter.

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

Sees if the specified control is enabled.