Configuration

class ansys.stk.core.stkobjects.aviator.Configuration

Class defining the aircraft configuration for an Aviator mission.

Overview

Methods

set_empty_cg	Set the aircraft’s Empty CG position.
paste_configuration	Paste the aircraft’s configuration.
get_stations	Get a collection of the aircraft’s payload stations.
save	Save.

Properties

empty_weight	Get or set the empty weight of the aircraft.
max_landing_weight	Get or set the max landing weight of the aircraft.
base_drag_index	Get or set the base drag index of the aircraft.
empty_cgx	Get the X value of the aircraft’s Empty CG position.
empty_cgy	Get the Y value of the aircraft’s Empty CG position.
empty_cgz	Get the Z value of the aircraft’s Empty CG position.
total_weight	Get the total weight of the aircraft.
total_weight_max_fuel	Get the total weight of the aircraft with all fuel tanks full.
total_drag_index	Get the total drag index of the aircraft.
total_cgx	Get the X value of the aircraft’s Total CG position.
total_cgy	Get the Y value of the aircraft’s Total CG position.
total_cgz	Get the Z value of the aircraft’s Total CG position.
total_capacity	Get the total fuel capacity of the aircraft.
initial_fuel_state	Get the initial fuel state of the aircraft.

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 Configuration

Property detail

property Configuration.empty_weight: float

Get or set the empty weight of the aircraft.

property Configuration.max_landing_weight: float

Get or set the max landing weight of the aircraft.

property Configuration.base_drag_index: float

Get or set the base drag index of the aircraft.

property Configuration.empty_cgx: float

Get the X value of the aircraft’s Empty CG position.

property Configuration.empty_cgy: float

Get the Y value of the aircraft’s Empty CG position.

property Configuration.empty_cgz: float

Get the Z value of the aircraft’s Empty CG position.

property Configuration.total_weight: float

Get the total weight of the aircraft.

property Configuration.total_weight_max_fuel: float

Get the total weight of the aircraft with all fuel tanks full.

property Configuration.total_drag_index: float

Get the total drag index of the aircraft.

property Configuration.total_cgx: float

Get the X value of the aircraft’s Total CG position.

property Configuration.total_cgy: float

Get the Y value of the aircraft’s Total CG position.

property Configuration.total_cgz: float

Get the Z value of the aircraft’s Total CG position.

property Configuration.total_capacity: float

Get the total fuel capacity of the aircraft.

property Configuration.initial_fuel_state: float

Get the initial fuel state of the aircraft.

Method detail

Configuration.set_empty_cg(self, x: float, y: float, z: float) → None

Set the aircraft’s Empty CG position.

Parameters:

x : float

y : float

z : float

Returns:

None

Configuration.paste_configuration(self, other_configuration: Configuration) → None

Paste the aircraft’s configuration.

Parameters:

other_configuration : Configuration

Returns:

None

Configuration.get_stations(self) → StationCollection

Get a collection of the aircraft’s payload stations.

Returns:

StationCollection

Configuration.save(self) → None

Save.

Returns:

None