MCSInitialState#

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

Bases: IMCSSegment, IRuntimeTypeInfoProvider, IComponentInfo, ICloneable

The Initial State segment.

Overview#

set_element_type

Select an coordinate type.

enable_control_parameter

Enable a control parameter.

disable_control_parameter

Disables a control parameter.

is_control_parameter_enabled

Sees if a control is enabled.

coord_system_name

Get or set the coordinate system.

orbit_epoch

Get or set the orbit epoch. Uses DateFormat Dimension.

spacecraft_parameters

Get the spacecraft parameters.

fuel_tank

Get the fuel tank parameters.

element_type

Get the coordinate type.

element

Get the elements of the selected coordinate type.

control_parameters_available

Return whether or not the control parameters can be set.

user_variables

Interface used to modify user variables for the initial state segment.

Import detail#

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

Property detail#

property MCSInitialState.coord_system_name: str#

Get or set the coordinate system.

property MCSInitialState.orbit_epoch: Any#

Get or set the orbit epoch. Uses DateFormat Dimension.

property MCSInitialState.spacecraft_parameters: SpacecraftParameters#

Get the spacecraft parameters.

property MCSInitialState.fuel_tank: FuelTank#

Get the fuel tank parameters.

property MCSInitialState.element_type: ElementSetType#

Get the coordinate type.

property MCSInitialState.element: IElement#

Get the elements of the selected coordinate type.

property MCSInitialState.control_parameters_available: bool#

Return whether or not the control parameters can be set.

property MCSInitialState.user_variables: UserVariableCollection#

Interface used to modify user variables for the initial state segment.

Method detail#

MCSInitialState.set_element_type(self, element_type: ElementSetType) None#

Select an coordinate type.

Parameters:

element_type : ElementSetType

Returns:

None

MCSInitialState.enable_control_parameter(self, param: ControlInitState) None#

Enable a control parameter.

Parameters:

param : ControlInitState

Returns:

None

MCSInitialState.disable_control_parameter(self, param: ControlInitState) None#

Disables a control parameter.

Parameters:

param : ControlInitState

Returns:

None

MCSInitialState.is_control_parameter_enabled(self, param: ControlInitState) bool#

Sees if a control is enabled.

Parameters:

param : ControlInitState

Returns:

bool