MCSTargetSequence

class ansys.stk.core.stkobjects.astrogator.MCSTargetSequence

Bases: IMCSSegment, IRuntimeTypeInfoProvider, IComponentInfo, ICloneable

The Target Sequence segment.

Overview

Methods

apply_profiles	Apply Changes - applies the current values of search profiles’ controls and the changes specified by the segment configuration profiles to the segments within the target sequence.
reset_profiles	Reset - resets the controls of the search profiles to the segments’ values.
apply_profile	Apply Changes - applies the current values of specified profile to the segments within the target sequence.
reset_profile	Reset - resets the current values of specified profile.
apply_profile_by_name	Apply Changes - applies the current values of specified profile to the segments within the target sequence.
reset_profile_by_name	Reset - resets the current values of specified profile.

Properties

action	Whether to run the sequence nominally or using profiles.
when_profiles_finish	When Profiles Converge - the action to be carried out if targeting has converged.
continue_on_failure	Continue if profiles don’t converge - if true, the target sequence continues if a profile fails to converge; otherwise, the MCS will stop upon the failure of a search profile.
segments	Return the segments contained within the target sequence.
profiles	Return the profiles used within the target sequence.
reset_inner_targeters	If true, inner target sequences will have their profiles reset before each run.

Import detail

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

Property detail

property MCSTargetSequence.action: TargetSequenceAction

Whether to run the sequence nominally or using profiles.

property MCSTargetSequence.when_profiles_finish: ProfilesFinish

When Profiles Converge - the action to be carried out if targeting has converged.

property MCSTargetSequence.continue_on_failure: bool

Continue if profiles don’t converge - if true, the target sequence continues if a profile fails to converge; otherwise, the MCS will stop upon the failure of a search profile.

property MCSTargetSequence.segments: MCSSegmentCollection

Return the segments contained within the target sequence.

property MCSTargetSequence.profiles: ProfileCollection

Return the profiles used within the target sequence.

property MCSTargetSequence.reset_inner_targeters: bool

If true, inner target sequences will have their profiles reset before each run.

Method detail

MCSTargetSequence.apply_profiles(self) → None

Apply Changes - applies the current values of search profiles’ controls and the changes specified by the segment configuration profiles to the segments within the target sequence.

Returns:

None

MCSTargetSequence.reset_profiles(self) → None

Reset - resets the controls of the search profiles to the segments’ values.

Returns:

None

MCSTargetSequence.apply_profile(self, profile: IProfile) → None

Apply Changes - applies the current values of specified profile to the segments within the target sequence.

Parameters:

profile : IProfile

Returns:

None

MCSTargetSequence.reset_profile(self, profile: IProfile) → None

Reset - resets the current values of specified profile.

Parameters:

profile : IProfile

Returns:

None

MCSTargetSequence.apply_profile_by_name(self, profile: str) → None

Apply Changes - applies the current values of specified profile to the segments within the target sequence.

Parameters:

profile : str

Returns:

None

MCSTargetSequence.reset_profile_by_name(self, profile: str) → None

Reset - resets the current values of specified profile.

Parameters:

profile : str

Returns:

None