MCSDriver#

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

Bases: IPropagator

Basic properties of an Astrogator satellite.

Overview#

Methods

`append_run`	Append the existing ephemeris with another individual segment mode run.
`append_run_from_state`	Append the existing ephemeris with another individual segment mode run, starting at a specified state. Ephemeris is cleared from time based on clear direction.
`append_run_from_time`	Append the existing ephemeris with another individual segment mode run, starting at a specified time. Ephemeris is cleared from time based on clear direction.
`apply_all_profile_changes`	Apply all active profile changes in all target sequences.
`begin_run`	Begins an individual segment mode run.
`clear_draw_while_calculating_graphics`	Clear the draw while calculating graphics.
`end_run`	End an individual segment mode run.
`reset_all_profiles`	Reset all active profiles in all target sequences.
`run_mcs`	Run the current MCS and returns an error code.
`set_all_profile_modes`	Set the mode for all profiles in all target sequences to the value held by the SetAllProfileModesTo property.
`set_all_sequence_actions`	Set the action for all target sequences to the value held by the SetAllTargetSequenceActionsTo property.

Properties

`auto_sequence`	Get the Automatic Sequences.
`calculation_graphs`	Get the calculation graphs.
`flight_dynamics_record_creator`	Get the flight dynamics record creator.
`main_sequence`	Get the Mission Control Sequence.
`options`	Get the Mission Control Sequence options.
`set_all_profile_modes_to`	The mode setting that will be applied to all profiles in all target sequences in the MCS when the SetAllProfileModes method is invoked.
`set_all_target_sequence_actions_to`	The action setting that will be applied to all target sequences in the MCS when the SetAllSequenceActions method is invoked.

Examples#

Set satellite propagator to Astrogator and clear segments

# Satellite satellite: Satellite object
satellite.set_propagator_type(PropagatorType.ASTROGATOR)
driver = satellite.propagator
# Clear all segments from the MCS
driver.main_sequence.remove_all()

Run the Astrogator® mission control sequence (MCS)

# MCSDriver driver: MCS driver interface
driver.run_mcs()

Import detail#

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

Property detail#

property MCSDriver.auto_sequence: AutomaticSequenceCollection#: Get the Automatic Sequences.

property MCSDriver.calculation_graphs: CalculationGraphCollection#: Get the calculation graphs.

property MCSDriver.flight_dynamics_record_creator: FlightDynamicsRecordCreator#: Get the flight dynamics record creator.

property MCSDriver.main_sequence: MCSSegmentCollection#: Get the Mission Control Sequence.

property MCSDriver.options: MCSOptions#: Get the Mission Control Sequence options.

property MCSDriver.set_all_profile_modes_to: ProfileMode#: The mode setting that will be applied to all profiles in all target sequences in the MCS when the SetAllProfileModes method is invoked.

property MCSDriver.set_all_target_sequence_actions_to: TargetSequenceAction#: The action setting that will be applied to all target sequences in the MCS when the SetAllSequenceActions method is invoked.

Method detail#

MCSDriver.append_run(self) → None#

Append the existing ephemeris with another individual segment mode run.

Returns:: None

MCSDriver.append_run_from_state(self, append_state: State, clear_ephemeris_direction: ClearEphemerisDirection) → None#

Append the existing ephemeris with another individual segment mode run, starting at a specified state. Ephemeris is cleared from time based on clear direction.

Parameters:

append_state : State

clear_ephemeris_direction : ClearEphemerisDirection

Returns:

None

MCSDriver.append_run_from_time(self, epoch: Any, clear_ephemeris_direction: ClearEphemerisDirection) → None#

Append the existing ephemeris with another individual segment mode run, starting at a specified time. Ephemeris is cleared from time based on clear direction.

Parameters:

epoch : Any

clear_ephemeris_direction : ClearEphemerisDirection

Returns:

None

MCSDriver.apply_all_profile_changes(self) → None#

Apply all active profile changes in all target sequences.

Returns:: None

MCSDriver.begin_run(self) → None#

Begins an individual segment mode run.

Returns:: None

MCSDriver.clear_draw_while_calculating_graphics(self) → None#

Clear the draw while calculating graphics.

Returns:: None

MCSDriver.end_run(self) → None#

End an individual segment mode run.

Returns:: None

MCSDriver.reset_all_profiles(self) → None#

Reset all active profiles in all target sequences.

Returns:: None

MCSDriver.run_mcs(self) → RunCode#

Run the current MCS and returns an error code.

Returns:: RunCode

MCSDriver.set_all_profile_modes(self) → None#

Set the mode for all profiles in all target sequences to the value held by the SetAllProfileModesTo property.

Returns:: None

MCSDriver.set_all_sequence_actions(self) → None#

Set the action for all target sequences to the value held by the SetAllTargetSequenceActionsTo property.

Returns:: None