StateCalcOrbitStateValue

class ansys.stk.core.stkobjects.astrogator.StateCalcOrbitStateValue

Bases: IComponentInfo, ICloneable

OrbitStateValue Calc objects.

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

calculation_object_name	Get or set the calculation object.
input_coord_system_name	Get or set the coordinate system of the input state.
x	Get or set the x position component. Uses Distance Dimension.
y	Get or set the y position component. Uses Distance Dimension.
z	Get or set the z position component. Uses Distance Dimension.
vx	Get or set the x velocity component. Uses Rate Dimension.
vy	Get or set the y velocity component. Uses Rate Dimension.
vz	Get or set the z velocity component. Uses Rate Dimension.
control_parameters_available	Return whether or not the control parameters can be set.

Import detail

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

Property detail

property StateCalcOrbitStateValue.calculation_object_name: str

Get or set the calculation object.

property StateCalcOrbitStateValue.input_coord_system_name: str

Get or set the coordinate system of the input state.

property StateCalcOrbitStateValue.x: Any

Get or set the x position component. Uses Distance Dimension.

property StateCalcOrbitStateValue.y: Any

Get or set the y position component. Uses Distance Dimension.

property StateCalcOrbitStateValue.z: Any

Get or set the z position component. Uses Distance Dimension.

property StateCalcOrbitStateValue.vx: Any

Get or set the x velocity component. Uses Rate Dimension.

property StateCalcOrbitStateValue.vy: Any

Get or set the y velocity component. Uses Rate Dimension.

property StateCalcOrbitStateValue.vz: Any

Get or set the z velocity component. Uses Rate Dimension.

property StateCalcOrbitStateValue.control_parameters_available: bool

Return whether or not the control parameters can be set.

Method detail

StateCalcOrbitStateValue.enable_control_parameter(self, param: ControlOrbitStateValue) → None

Enable the specified control parameter.

Parameters:

param : ControlOrbitStateValue

Returns:

None

StateCalcOrbitStateValue.disable_control_parameter(self, param: ControlOrbitStateValue) → None

Disables the specified control parameter.

Parameters:

param : ControlOrbitStateValue

Returns:

None

StateCalcOrbitStateValue.is_control_parameter_enabled(self, param: ControlOrbitStateValue) → bool

Sees if the specified control is enabled.

Parameters:

param : ControlOrbitStateValue

Returns:

bool