PayloadStation

class ansys.stk.core.stkobjects.aviator.PayloadStation

Bases: IStation

Class defining a payload station for an Aviator aircraft.

Overview

Methods

set_position	Set the payload station’s parent relative position.
remove_sub_item	Remove any sub item that may be attached to the payload station.
add_external_fuel_tank	Add an external fuel tank to the payload station.
get_external_fuel_tank	Get the external fuel tank attached to the payload station.

Properties

name	Get or set the name of the payload station.
position_x	Get the X value of the payload station’s parent relative position.
position_y	Get the Y value of the payload station’s parent relative position.
position_z	Get the Z value of the payload station’s parent relative position.

Examples

Set the Configuration used for the Mission

# Mission mission: Aviator Mission object
# Get the configuration used for the mission
configuration = mission.configuration
# Set the max landing weight
configuration.max_landing_weight = 300000
# Set the empty weight
configuration.empty_weight = 210000
# Update the center of gravity of the aircraft when empty
configuration.set_empty_cg(2, 0, 1)

# Get the stations
stations = configuration.get_stations()
# Check if there is an internal fuel station
if stations.contains_station("Internal Fuel") is True:
    # Get the fuel tank
    fuelTank = stations.get_internal_fuel_tank_by_name("Internal Fuel")
    # Set the capacity of the fuel tank
    fuelTank.capacity = 175000
    # Set the initial state of the fuel tank
    fuelTank.initial_fuel_state = 125000

# Add a new payload station
newPayload = stations.add_payload_station()
# Set the position of the payload station
newPayload.set_position(0, 2, 0)
# Add an external fuel tank
externalTank = newPayload.add_external_fuel_tank()
# Set the empty weight of the tank
externalTank.empty_weight = 2000

Import detail

from ansys.stk.core.stkobjects.aviator import PayloadStation

Property detail

property PayloadStation.name: str

Get or set the name of the payload station.

property PayloadStation.position_x: float

Get the X value of the payload station’s parent relative position.

property PayloadStation.position_y: float

Get the Y value of the payload station’s parent relative position.

property PayloadStation.position_z: float

Get the Z value of the payload station’s parent relative position.

Method detail

PayloadStation.set_position(self, x: float, y: float, z: float) → None

Set the payload station’s parent relative position.

Parameters:

x : float

y : float

z : float

Returns:

None

PayloadStation.remove_sub_item(self) → None

Remove any sub item that may be attached to the payload station.

Returns:

None

PayloadStation.add_external_fuel_tank(self) → FuelTankExternal

Add an external fuel tank to the payload station.

Returns:

FuelTankExternal

PayloadStation.get_external_fuel_tank(self) → FuelTankExternal

Get the external fuel tank attached to the payload station.

Returns:

FuelTankExternal