ProcedureAirwayRouter

class ansys.stk.core.stkobjects.aviator.ProcedureAirwayRouter

Bases: IProcedure

Class defining an Airway Router procedure.

Overview

Methods

get_as_procedure	Get the procedure interface.
update_route	Recalculate the route.
get_waypoints	Get a list of the current route’s waypoints.
get_segments	Get a list of the current route’s individual procedures.
copy_procedures	Copy the route as a set of procedures to the clipboard.

Properties

altitude_options	Get the altitude options.
enroute_options	Get the enroute options.
enroute_cruise_airspeed_options	Get the enroute cruise airspeed options.
router	Get or set the router used to provide available airways.
optimize_for_wind	Opt to account for the wind when calculating the most efficient route.
bounding_box_pad	Get or set the maximum distance beyond the bounding box that a waypoint will be considered for the final route.
max_waypoint_range	Get or set the maximum distance from the end of the previous procedure that an airway waypoint will be considered.
entry_exit_and_or	Define how the two Entry/Exit Waypoint constraints will be considered.
max_waypoint_count	Get or set the maximum number of airway waypoints that the procedure will consider for each segment.

Import detail

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

Property detail

property ProcedureAirwayRouter.altitude_options: AltitudeMSLOptions

Get the altitude options.

property ProcedureAirwayRouter.enroute_options: EnrouteOptions

Get the enroute options.

property ProcedureAirwayRouter.enroute_cruise_airspeed_options: CruiseAirspeedOptions

Get the enroute cruise airspeed options.

property ProcedureAirwayRouter.router: str

Get or set the router used to provide available airways.

property ProcedureAirwayRouter.optimize_for_wind: bool

Opt to account for the wind when calculating the most efficient route.

property ProcedureAirwayRouter.bounding_box_pad: float

Get or set the maximum distance beyond the bounding box that a waypoint will be considered for the final route.

property ProcedureAirwayRouter.max_waypoint_range: float

Get or set the maximum distance from the end of the previous procedure that an airway waypoint will be considered.

property ProcedureAirwayRouter.entry_exit_and_or: AndOr

Define how the two Entry/Exit Waypoint constraints will be considered.

property ProcedureAirwayRouter.max_waypoint_count: int

Get or set the maximum number of airway waypoints that the procedure will consider for each segment.

Method detail

ProcedureAirwayRouter.get_as_procedure(self) → IProcedure

Get the procedure interface.

Returns:

IProcedure

ProcedureAirwayRouter.update_route(self) → None

Recalculate the route.

Returns:

None

ProcedureAirwayRouter.get_waypoints(self) → list

Get a list of the current route’s waypoints.

Returns:

list

ProcedureAirwayRouter.get_segments(self) → list

Get a list of the current route’s individual procedures.

Returns:

list

ProcedureAirwayRouter.copy_procedures(self) → None

Copy the route as a set of procedures to the clipboard.

Returns:

None