MCSLaunch

class ansys.stk.core.stkobjects.astrogator.MCSLaunch

Bases: IMCSSegment, IRuntimeTypeInfoProvider, IComponentInfo, ICloneable

The Launch segment.

Overview

Methods

disable_control_parameter	Disables the specified control parameter.
enable_control_parameter	Enable the specified control parameter.
is_control_parameter_enabled	Sees if the specified control is enabled.
set_burnout_type	Set the burnout type.
set_display_system_type	Set the display system type.

Properties

ascent_type	Get or set the order of the spline used to generate the motion along the ellipse.
burnout	Get the burnout point definition.
burnout_type	Get the burnout type.
burnout_velocity	Get the burnout velocity definition.
central_body_name	Get or set the central body.
control_parameters_available	Return whether or not the control parameters can be set.
display_system	Get the current Display System.
display_system_type	Get the launch coordinate type.
epoch	Get or set the date and time of the launch. Uses DateFormat Dimension.
fuel_tank	Get the spacecraft’s fuel tank properties.
initial_acceleration	Get or set the initial acceleration, for the Quartic Motion Ascent Type. Uses Acceleration Dimension.
pre_launch_time	Get or set the amount of time before the spacecraft’s launch that it will be created in the scenario. The vehicle will remain at the launch position until beginning of the launch epoch. Uses Time Dimension.
set_mission_elapsed_time_epoch	If true, the Mission Elapsed Time epoch will be set to the launch epoch.
spacecraft_parameters	Satellite Properties - the spacecraft’s physical properties.
step_size	Get or set the time interval between calculated ephemeris output points. Uses Time Dimension.
time_of_flight	Get or set the time of flight (the time from launch to burnout). Uses Time Dimension.
use_previous_segment_state	If true, the previous segment state is used to define the launch location parameters.
user_variables	Interface used to modify user variables for the launch segment.

Import detail

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

Property detail

property MCSLaunch.ascent_type: AscentType

Get or set the order of the spline used to generate the motion along the ellipse.

property MCSLaunch.burnout: IBurnout

Get the burnout point definition.

property MCSLaunch.burnout_type: BurnoutType

Get the burnout type.

property MCSLaunch.burnout_velocity: BurnoutVelocity

Get the burnout velocity definition.

property MCSLaunch.central_body_name: str

Get or set the central body.

property MCSLaunch.control_parameters_available: bool

Return whether or not the control parameters can be set.

property MCSLaunch.display_system: IDisplaySystem

Get the current Display System.

property MCSLaunch.display_system_type: LaunchDisplaySystem

Get the launch coordinate type.

property MCSLaunch.epoch: Any

Get or set the date and time of the launch. Uses DateFormat Dimension.

property MCSLaunch.fuel_tank: FuelTank

Get the spacecraft’s fuel tank properties.

property MCSLaunch.initial_acceleration: float

Get or set the initial acceleration, for the Quartic Motion Ascent Type. Uses Acceleration Dimension.

property MCSLaunch.pre_launch_time: float

Get or set the amount of time before the spacecraft’s launch that it will be created in the scenario. The vehicle will remain at the launch position until beginning of the launch epoch. Uses Time Dimension.

property MCSLaunch.set_mission_elapsed_time_epoch: bool

If true, the Mission Elapsed Time epoch will be set to the launch epoch.

property MCSLaunch.spacecraft_parameters: SpacecraftParameters

Satellite Properties - the spacecraft’s physical properties.

property MCSLaunch.step_size: float

Get or set the time interval between calculated ephemeris output points. Uses Time Dimension.

property MCSLaunch.time_of_flight: float

Get or set the time of flight (the time from launch to burnout). Uses Time Dimension.

property MCSLaunch.use_previous_segment_state: bool

If true, the previous segment state is used to define the launch location parameters.

property MCSLaunch.user_variables: UserVariableCollection

Interface used to modify user variables for the launch segment.

Method detail

MCSLaunch.disable_control_parameter(self, param: ControlLaunch) → None

Disables the specified control parameter.

Parameters:

param : ControlLaunch

Returns:

None

MCSLaunch.enable_control_parameter(self, param: ControlLaunch) → None

Enable the specified control parameter.

Parameters:

param : ControlLaunch

Returns:

None

MCSLaunch.is_control_parameter_enabled(self, param: ControlLaunch) → bool

Sees if the specified control is enabled.

Parameters:

param : ControlLaunch

Returns:

bool

MCSLaunch.set_burnout_type(self, burnout_type: BurnoutType) → None

Set the burnout type.

Parameters:

burnout_type : BurnoutType

Returns:

None

MCSLaunch.set_display_system_type(self, display_system_type: LaunchDisplaySystem) → None

Set the display system type.

Parameters:

display_system_type : LaunchDisplaySystem

Returns:

None