MCSOptions#

class ansys.stk.core.stkobjects.astrogator.MCSOptions#: The MCS Options.

Overview#

Properties

`clear_additional_b_plane_points`	If true, Astrogator will clear all additional B-Plane points from any previous run - in all graphics windows - before the current run.
`clear_draw_while_calculating_graphics_before_each_run`	If true, Astrogator will automatically clear all target iteration graphics of the previous run - in all graphics windows - before the current run draws new calculations.
`draw_trajectory_in_2d`	If true, Astrogator will draw the trajectory in the 2D Graphics windows as the ephemeris is calculated during the current run.
`draw_trajectory_in_3d`	If true, Astrogator will draw the trajectory in the 3D Graphics windows as the ephemeris is calculated during the current run.
`enable_logging`	If true, target sequences can be set to produce ‘run history’ log files for differential corrector profiles. By default, a target sequence does not produce a log file.
`enable_segment_controls`	If true, Astrogator will automatically add independent variables to differential correctors.
`enable_segment_results`	If true, Astrogator will automatically add dependent variables to differential correctors.
`enable_trajectory_segment_colors`	If true, trajectory segments are displayed in the 2D Graphics window in the colors selected for the respective segments; otherwise the color of the trajectory is defined by the 2D Graphics Attributes page.
`generate_ephemeris`	If true, Astrogator will generate ephemeris.
`graphics_update_rate`	Get or set the rate (between 0 and 1) at which to update graphics. Dimensionless.
`min_ephem_step`	Get or set the minimum step size for saving ephemeris. Uses Time Dimension.
`promote_controls`	If true, a target sequence will be able to affect controls and results within a nested target sequence in addition to its own.
`propagate_on_apply`	If true, Astrogator will propagate trajectories whenever you click OK or Apply on the Orbit page. If you want to close the Properties Browser for the satellite without running the MCS, make certain this option is disabled.
`save_numbers_in_raw_format`	If true, Astrogator will store satellite information in binary format - to preserve the maximum amount of precision.
`smart_run_mode`	Control whether the run will attempt to only run changed segments.
`stopping_condition_time_tolerance`	Get or set the time tolerance, which will be applied with respect to desired trip values throughout the MCS. If this value is set to zero, time tolerance will not be applied.
`update_animation_time_for_all_objects`	If true, all other objects will be animated so that they appear at the proper position for the time being computed as the trajectory is calculated.
`use_nominal_settings`	If true, components or segments that are modified by a target sequence will be restored to their nominal values as soon as the target sequence completes its run.
`user_variables`	Interface used to add/remove user variables.

Import detail#

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

Property detail#

property MCSOptions.clear_additional_b_plane_points: bool#: If true, Astrogator will clear all additional B-Plane points from any previous run - in all graphics windows - before the current run.

property MCSOptions.clear_draw_while_calculating_graphics_before_each_run: bool#: If true, Astrogator will automatically clear all target iteration graphics of the previous run - in all graphics windows - before the current run draws new calculations.

property MCSOptions.draw_trajectory_in_2d: bool#: If true, Astrogator will draw the trajectory in the 2D Graphics windows as the ephemeris is calculated during the current run.

property MCSOptions.draw_trajectory_in_3d: bool#: If true, Astrogator will draw the trajectory in the 3D Graphics windows as the ephemeris is calculated during the current run.

property MCSOptions.enable_logging: bool#: If true, target sequences can be set to produce ‘run history’ log files for differential corrector profiles. By default, a target sequence does not produce a log file.

property MCSOptions.enable_segment_controls: bool#: If true, Astrogator will automatically add independent variables to differential correctors.

property MCSOptions.enable_segment_results: bool#: If true, Astrogator will automatically add dependent variables to differential correctors.

property MCSOptions.enable_trajectory_segment_colors: bool#: If true, trajectory segments are displayed in the 2D Graphics window in the colors selected for the respective segments; otherwise the color of the trajectory is defined by the 2D Graphics Attributes page.

property MCSOptions.generate_ephemeris: bool#: If true, Astrogator will generate ephemeris.

property MCSOptions.graphics_update_rate: float#: Get or set the rate (between 0 and 1) at which to update graphics. Dimensionless.

property MCSOptions.min_ephem_step: float#: Get or set the minimum step size for saving ephemeris. Uses Time Dimension.

property MCSOptions.promote_controls: bool#: If true, a target sequence will be able to affect controls and results within a nested target sequence in addition to its own.

property MCSOptions.propagate_on_apply: bool#: If true, Astrogator will propagate trajectories whenever you click OK or Apply on the Orbit page. If you want to close the Properties Browser for the satellite without running the MCS, make certain this option is disabled.

property MCSOptions.save_numbers_in_raw_format: bool#: If true, Astrogator will store satellite information in binary format - to preserve the maximum amount of precision.

property MCSOptions.smart_run_mode: SmartRunMode#: Control whether the run will attempt to only run changed segments.

property MCSOptions.stopping_condition_time_tolerance: float#: Get or set the time tolerance, which will be applied with respect to desired trip values throughout the MCS. If this value is set to zero, time tolerance will not be applied.

property MCSOptions.update_animation_time_for_all_objects: bool#: If true, all other objects will be animated so that they appear at the proper position for the time being computed as the trajectory is calculated.

property MCSOptions.use_nominal_settings: bool#: If true, components or segments that are modified by a target sequence will be restored to their nominal values as soon as the target sequence completes its run.

property MCSOptions.user_variables: UserVariableDefinitionCollection#: Interface used to add/remove user variables.