SiteRunway

class ansys.stk.core.stkobjects.aviator.SiteRunway

Bases: ISite

Class defining a runway site.

Overview

Methods

add_to_catalog	Add the runway to the catalog.
copy_from_catalog	Copy the information from the runway stored in the catalog.
get_as_site	Get the site interface.

Properties

altitude	Get or set the runway altitude.
altitude_reference	Get or set the altitude reference for the runway.
high_end_heading	Get or set the high end heading of the runway.
is_magnetic	Opt whether to use a magnetic heading for the runway heading.
latitude	Get or set the runway latitude.
length	Get or set the length of the runway.
longitude	Get or set the runway longitude.
low_end_heading	Get or set the low end heading of the runway.

Examples

Configure a runway site

# SiteRunway runway: Runway object
# Set the latitude, longitude, and altitude
runway.latitude = 41
runway.longitude = 77
runway.altitude = 5

# Set the altitude reference
runway.altitude_reference = AGLMSL.ALTITUDE_MSL

# Set the heading
runway.high_end_heading = 195
# Opt to use true heading
runway.is_magnetic = False

# Set the length of the runway
runway.length = 5

# Rename the runway
runway.name = "New User Runway"
# Add the runway to the catalog to use it for next time
runway.add_to_catalog(1)

Configure a runway site from a runway in the Aviator catalog

# SiteRunway runway: Runway object
# Catalog catalog: Aviator catalog object
# Get the source of user runways
userRunways = catalog.runway_category.user_runways
# Check that the runway exists in the catalog
if userRunways.contains("New User Runway") is True:
    # If so, get the user runway with the given name
    runwayFromCatalog = userRunways.get_user_runway("New User Runway")
    # Copy the parameters of that runway
    runway.copy_from_catalog(runwayFromCatalog)

Import detail

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

Property detail

property SiteRunway.altitude: float

Get or set the runway altitude.

property SiteRunway.altitude_reference: AGLMSL

Get or set the altitude reference for the runway.

property SiteRunway.high_end_heading: Any

Get or set the high end heading of the runway.

property SiteRunway.is_magnetic: bool

Opt whether to use a magnetic heading for the runway heading.

property SiteRunway.latitude: Any

Get or set the runway latitude.

property SiteRunway.length: float

Get or set the length of the runway.

property SiteRunway.longitude: Any

Get or set the runway longitude.

property SiteRunway.low_end_heading: Any

Get or set the low end heading of the runway.

Method detail

SiteRunway.add_to_catalog(self, overwrite: bool) → None

Add the runway to the catalog.

Parameters:

overwrite : bool

Returns:

None

SiteRunway.copy_from_catalog(self, runway: ICatalogRunway) → None

Copy the information from the runway stored in the catalog.

Parameters:

runway : ICatalogRunway

Returns:

None

SiteRunway.get_as_site(self) → ISite

Get the site interface.

Returns:

ISite