Phase

class ansys.stk.core.stkobjects.aviator.Phase

Class defining a phase in an Aviator mission.

Overview

Methods

get_performance_model_by_type	Get the active performance model for the given category type.
set_default_performance_models	Set the phase to use the default performance models of the aircraft.
copy_performance_models	Create a copy of the active performance models for the current phase.
paste_performance_models	Paste the performance models.

Properties

procedures	Return the procedure collection.
name	Get or set the name of the phase.

Examples

Configure the performance models to be used in the phase

# Phase phase: Phase object
# Get the acceleration performance model used for the current phase
acceleration = phase.get_performance_model_by_type("Acceleration")
# Check if it is linked to the catalog
isLinkedToCatalog = acceleration.is_linked_to_catalog
# Use the performance model in the catalog named "Built-In Model"
acceleration.link_to_catalog("Built-In Model")

# Get the VTOL performance model
vtol = phase.get_performance_model_by_type("VTOL")
# Create a new vtol model of type AGI VTOL Model. Note that this new model does not exist in the catalog and only exists in the phase.
vtol.create_new("AGI VTOL Model")
# Rename the performance model
vtol.rename("Temporary VTOL Model")

Add a new phase and use the same performance models as the first phase

# PhaseCollection phases: Phase Collection object
# Add a new phase at the end of the mission
newPhase = phases.add()
# Rename the phase
newPhase.name = "New Phase"
# Copy the performance models from the first phase and paste it to the new phase
phases[0].copy_performance_models()
newPhase.paste_performance_models()

Import detail

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

Property detail

property Phase.procedures: ProcedureCollection

Return the procedure collection.

property Phase.name: str

Get or set the name of the phase.

Method detail

Phase.get_performance_model_by_type(self, type: str) → PerformanceModelOptions

Get the active performance model for the given category type.

Parameters:

type : str

Returns:

PerformanceModelOptions

Phase.set_default_performance_models(self) → None

Set the phase to use the default performance models of the aircraft.

Returns:

None

Phase.copy_performance_models(self) → None

Create a copy of the active performance models for the current phase.

Returns:

None

Phase.paste_performance_models(self) → None

Paste the performance models.

Returns:

None