State

class ansys.stk.core.stkobjects.astrogator.State

Bases: IRuntimeTypeInfoProvider

The orbit state.

Overview

Methods

set_element_type	Set the element type.
get_in_frame_name	Get the orbit state in the specified frame.

Properties

element_type	Get the element type.
element	Return the currently selected element type.
epoch	Get or set the epoch of the Orbit State. Uses DateFormat Dimension.
coord_system_name	Get the coordinate system.
dry_mass	Get or set the mass of the spacecraft exclusive of propellant. Uses Mass Dimension.
fuel_mass	Get or set the mass of the spacecraft propellant. Uses Mass Dimension.
drag_area	Get or set the cross-sectional area of the spacecraft assumed perpendicular to the direction of motion, used for atmospheric drag calculations. Uses SmallArea Dimension.
srp_area	Get or set the cross-sectional area of the spacecraft assumed perpendicular to the direction of solar radiation, used for solar radiation calculations. Uses SmallArea Dimension.
tank_pressure	Get or set the fuel tank pressure. Uses Pressure Dimension.
tank_temperature	Get or set the temperature of the fuel tank. Uses Temperature Dimension.
fuel_density	Get or set the density of the fuel tank. Uses SmallDensity Dimension.
cr	Get or set the reflectivity of the spacecraft used for solar radiation pressure calculations, where 2.0 is fully reflective and 1.0 is not reflective at all. Dimensionless.
cd	Get or set the dimensionless drag coefficient associated with the drag area. Dimensionless.
radiation_pressure_coefficient	Get or set the reflectivity of the spacecraft used for central body radiation pressure (albedo / thermal pressure) calculations, where 2.0 is fully reflective and 1.0 is not reflective at all. Dimensionless.
radiation_pressure_area	Get or set the cross-sectional area of the spacecraft assumed perpendicular to the direction of central body radiation, used for central body radiation (albedo / thermal pressure) calculations. Uses Small Area Dimension.
k1	If you are using a non-spherical SRP model, this field defines the model’s GPS solar radiation pressure K1 (scale) value. Dimensionless.
k2	If you are using a non-spherical SRP model, this field defines the model’s GPS solar radiation pressure K2 (scale) value. Dimensionless.

Import detail

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

Property detail

property State.element_type: ElementSetType

Get the element type.

property State.element: IElement

Return the currently selected element type.

property State.epoch: Any

Get or set the epoch of the Orbit State. Uses DateFormat Dimension.

property State.coord_system_name: str

Get the coordinate system.

property State.dry_mass: float

Get or set the mass of the spacecraft exclusive of propellant. Uses Mass Dimension.

property State.fuel_mass: float

Get or set the mass of the spacecraft propellant. Uses Mass Dimension.

property State.drag_area: float

Get or set the cross-sectional area of the spacecraft assumed perpendicular to the direction of motion, used for atmospheric drag calculations. Uses SmallArea Dimension.

property State.srp_area: float

Get or set the cross-sectional area of the spacecraft assumed perpendicular to the direction of solar radiation, used for solar radiation calculations. Uses SmallArea Dimension.

property State.tank_pressure: float

Get or set the fuel tank pressure. Uses Pressure Dimension.

property State.tank_temperature: float

Get or set the temperature of the fuel tank. Uses Temperature Dimension.

property State.fuel_density: float

Get or set the density of the fuel tank. Uses SmallDensity Dimension.

property State.cr: float

Get or set the reflectivity of the spacecraft used for solar radiation pressure calculations, where 2.0 is fully reflective and 1.0 is not reflective at all. Dimensionless.

property State.cd: float

Get or set the dimensionless drag coefficient associated with the drag area. Dimensionless.

property State.radiation_pressure_coefficient: float

Get or set the reflectivity of the spacecraft used for central body radiation pressure (albedo / thermal pressure) calculations, where 2.0 is fully reflective and 1.0 is not reflective at all. Dimensionless.

property State.radiation_pressure_area: float

Get or set the cross-sectional area of the spacecraft assumed perpendicular to the direction of central body radiation, used for central body radiation (albedo / thermal pressure) calculations. Uses Small Area Dimension.

property State.k1: float

If you are using a non-spherical SRP model, this field defines the model’s GPS solar radiation pressure K1 (scale) value. Dimensionless.

property State.k2: float

If you are using a non-spherical SRP model, this field defines the model’s GPS solar radiation pressure K2 (scale) value. Dimensionless.

Method detail

State.set_element_type(self, element_type: ElementSetType) → None

Set the element type.

Parameters:

element_type : ElementSetType

Returns:

None

State.get_in_frame_name(self, frame_name: str) → State

Get the orbit state in the specified frame.

Parameters:

frame_name : str

Returns:

State