MCSFollow

class ansys.stk.core.stkobjects.astrogator.MCSFollow

Bases: IMCSSegment, IRuntimeTypeInfoProvider, IComponentInfo, ICloneable

The Follow segment.

Overview

Methods

enable_control_parameter	Enable the specified control parameter.
disable_control_parameter	Disables the specified control parameter.
is_control_parameter_enabled	Sees if the specified control is enabled.

Properties

leader	Get the leader object.
x_offset	Get or set the distance that the spacecraft will be offset from the leader’s body frame along the X axis. Uses Distance Dimension.
y_offset	Get or set the distance that the spacecraft will be offset from the leader’s body frame along the Y axis. Uses Distance Dimension.
z_offset	Get or set the distance that the spacecraft will be offset from the leader’s body frame along the Z axis. Uses Distance Dimension.
separation_conditions	If separation conditions are specified, the list of separation conditions.
spacecraft_parameters	Get the spacecraft’s physical properties.
fuel_tank	Get the spacecraft’s fuel tank properties.
joining_type	Get or set the joining type.
separation_type	Get or set the separation type.
spacecraft_and_fuel_tank_type	Get or set the spacecraft snd fuel tank configuration type.
joining_conditions	If joining conditions are specified, the list of joining conditions.
control_parameters_available	Return whether or not the control parameters can be set.
user_variables	Interface used to modify user variables for the follow segment.

Import detail

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

Property detail

property MCSFollow.leader: ILinkToObject

Get the leader object.

property MCSFollow.x_offset: float

Get or set the distance that the spacecraft will be offset from the leader’s body frame along the X axis. Uses Distance Dimension.

property MCSFollow.y_offset: float

Get or set the distance that the spacecraft will be offset from the leader’s body frame along the Y axis. Uses Distance Dimension.

property MCSFollow.z_offset: float

Get or set the distance that the spacecraft will be offset from the leader’s body frame along the Z axis. Uses Distance Dimension.

property MCSFollow.separation_conditions: StoppingConditionCollection

If separation conditions are specified, the list of separation conditions.

property MCSFollow.spacecraft_parameters: SpacecraftParameters

Get the spacecraft’s physical properties.

property MCSFollow.fuel_tank: FuelTank

Get the spacecraft’s fuel tank properties.

property MCSFollow.joining_type: FollowJoin

Get or set the joining type.

property MCSFollow.separation_type: FollowSeparation

Get or set the separation type.

property MCSFollow.spacecraft_and_fuel_tank_type: FollowSpacecraftAndFuelTank

Get or set the spacecraft snd fuel tank configuration type.

property MCSFollow.joining_conditions: StoppingConditionCollection

If joining conditions are specified, the list of joining conditions.

property MCSFollow.control_parameters_available: bool

Return whether or not the control parameters can be set.

property MCSFollow.user_variables: UserVariableCollection

Interface used to modify user variables for the follow segment.

Method detail

MCSFollow.enable_control_parameter(self, param: ControlFollow) → None

Enable the specified control parameter.

Parameters:

param : ControlFollow

Returns:

None

MCSFollow.disable_control_parameter(self, param: ControlFollow) → None

Disables the specified control parameter.

Parameters:

param : ControlFollow

Returns:

None

MCSFollow.is_control_parameter_enabled(self, param: ControlFollow) → bool

Sees if the specified control is enabled.

Parameters:

param : ControlFollow

Returns:

bool