PerformanceModelOptions#

class ansys.stk.core.stkobjects.aviator.PerformanceModelOptions#: Class defining the options for the active performance model in a phase.

Overview#

Methods

`link_to_catalog`	Link to the performance model in the catalog with the given name.
`copy_from_catalog`	Create a copy of the performance model in the catalog with the given name.
`create_new`	Create a new performance model of the given type.
`rename`	Rename the performance model.
`delete`	Delete the performance model.

Properties

`name`	Get the name of the performance model.
`is_linked_to_catalog`	Get whether the performance model is linked to the catalog.
`properties`	Get the properties of the performance model.

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")

Import detail#

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

Property detail#

property PerformanceModelOptions.name: str#: Get the name of the performance model.

property PerformanceModelOptions.is_linked_to_catalog: bool#: Get whether the performance model is linked to the catalog.

property PerformanceModelOptions.properties: IPerformanceModel#: Get the properties of the performance model.

Method detail#

PerformanceModelOptions.link_to_catalog(self, name: str) → None#

Link to the performance model in the catalog with the given name.

Parameters:: name : str
Returns:: None

PerformanceModelOptions.copy_from_catalog(self, name: str) → None#

Create a copy of the performance model in the catalog with the given name.

Parameters:: name : str
Returns:: None

PerformanceModelOptions.create_new(self, type: str) → None#

Create a new performance model of the given type.

Parameters:: type : str
Returns:: None

PerformanceModelOptions.rename(self, type: str) → None#

Rename the performance model.

Parameters:: type : str
Returns:: None

PerformanceModelOptions.delete(self) → None#

Delete the performance model.

Returns:: None