Description

Interface used to change the active performance model in a phase for a given model type.

Public Methods

CopyFromCatalog	Create a copy of the performance model in the catalog with the given name.
CreateNew	Create a new performance model of the given type.
Delete	Delete the performance model.
LinkToCatalog	Link to the performance model in the catalog with the given name.
Rename	Rename the performance model.

Public Properties

IsLinkedToCatalog	Get whether the performance model is linked to the catalog.
Name	Get the name of the performance model.
Properties	Get the properties of the performance model.

CoClasses that Implement IAgAvtrPerformanceModelOptions

Name
AgAvtrPerformanceModelOptions

Example

Configure the performance models to be used in the phase

[C#]

// Get the acceleration performance model used for the current phase
IAgAvtrPerformanceModelOptions acceleration = phase.GetPerformanceModelByType("Acceleration");
// Check if it is linked to the catalog
bool isLinkedToCatalog = acceleration.IsLinkedToCatalog;
// Use the performance model in the catalog named "Built-In Model"
acceleration.LinkToCatalog("Built-In Model");

// Get the VTOL performance model
IAgAvtrPerformanceModelOptions vtol = phase.GetPerformanceModelByType("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.CreateNew("AGI VTOL Model");
// Rename the performance model
vtol.Rename("Temporary VTOL Model");

Configure the performance models to be used in the phase

[Visual Basic .NET]

' Get the acceleration performance model used for the current phase
Dim acceleration As IAgAvtrPerformanceModelOptions = phase.GetPerformanceModelByType("Acceleration")
' Check if it is linked to the catalog
Dim isLinkedToCatalog As Boolean = acceleration.IsLinkedToCatalog
' Use the performance model in the catalog named "Built-In Model"
acceleration.LinkToCatalog("Built-In Model")

' Get the VTOL performance model
Dim vtol As IAgAvtrPerformanceModelOptions = phase.GetPerformanceModelByType("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.CreateNew("AGI VTOL Model")
' Rename the performance model
vtol.Rename("Temporary VTOL Model")

Configure the performance models to be used in the phase

[Python - STK API]

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

# Get the VTOL performance model
vtol = phase.GetPerformanceModelByType('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.CreateNew('AGI VTOL Model')
# Rename the performance model
vtol.Rename('Temporary VTOL Model')

Configure the performance models to be used in the phase

[MATLAB]

% IAgAvtrPhase phase: Phase object
% Get the acceleration performance model used for the current phase
acceleration = phase.GetPerformanceModelByType('Acceleration');
% Check if it is linked to the catalog
isLinkedToCatalog = acceleration.IsLinkedToCatalog;
% Use the performance model in the catalog named "Built-In Model"
acceleration.LinkToCatalog('Built-In Model');

% Get the VTOL performance model
vtol = phase.GetPerformanceModelByType('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.CreateNew('AGI VTOL Model');
% Rename the performance model
vtol.Rename('Temporary VTOL Model');

STK Aviator	Send comments on this topic.
IAgAvtrPerformanceModelOptions Interface