Description

Interface used to access the phase options for a mission.

Public Methods

CopyPerformanceModels	Create a copy of the active performance models for the current phase.
GetPerformanceModelByType	Get the active performance model for the given category type.
PastePerformanceModels	Paste the performance models.
SetDefaultPerfModels	Set the phase to use the default performance models of the aircraft.

Public Properties

Name	Gets or sets the name of the phase.
Procedures	Returns the procedure collection.

CoClasses that Implement IAgAvtrPhase

Name
AgAvtrPhase

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

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

[C#]

// Add a new phase at the end of the mission
IAgAvtrPhase 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].CopyPerformanceModels();
newPhase.PastePerformanceModels();

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

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

[Visual Basic .NET]

' Add a new phase at the end of the mission
Dim newPhase As IAgAvtrPhase = 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).CopyPerformanceModels()
newPhase.PastePerformanceModels()

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

[Python - STK API]

      # IAgAvtrPhases 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].CopyPerformanceModels()
newPhase.PastePerformanceModels()

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');

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

[MATLAB]

% IAgAvtrPhases 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.Item(0).CopyPerformanceModels();
newPhase.PastePerformanceModels();

STK Aviator	Send comments on this topic.
IAgAvtrPhase Interface