STK AviatorSend comments on this topic.
IAgAvtrProcedure Interface

Description

Interface used to access the options for a procedure. Use this interface to get the Site and Get the time options for the current procedure.

Public Properties

Public Property AtmosphereModelGet the mission atmosphere model.
Public Property CalculationOptionsGet the calculation options for the current procedure.
Public Property FastTimeOptionsGet the fast time options (without validation or constraints) for the current procedure.
Public Property NameGets or sets the name of the procedure.
Public Property RefuelDumpIsSupportedRefuel/dump is supported for the current procedure.
Public Property RefuelDumpPropertiesGet the refuel/dump properties for the current procedure.
Public Property SiteGet the site of the current procedure.
Public Property TimeOptionsGet the time options for the current procedure.
Public Property WindModelGet the wind model for the current procedure.

Interfaces

Implemented Interface
IAgAvtrConnect

CoClasses that Implement IAgAvtrProcedure

Example

Rename a procedure and its site
[C#]
// Rename the procedure
procedure.Name = "New Procedure";
// Get the site corresponding to the procedure
IAgAvtrSite site = procedure.Site;
// Rename the site
site.Name = "New Site";
Configure the wind and atmosphere for a procedure
[C#]
// Get the wind model for the procedure
IAgAvtrWindModel windModel = procedure.WindModel;
// Use the procedure model
windModel.WindModelSource = AgEAvtrWindAtmosModelSource.eProcedureModel;
// Let's use constant wind
windModel.WindModelType = AgEAvtrWindModelType.eConstantWind;
// Get the constant wind model options
IAgAvtrWindModelConstant constantWind = windModel.ModeAsConstant;
// Set the wind bearing
constantWind.WindBearing = 30;
// Set the wind speed
constantWind.WindSpeed = 5;

// Get the atmosphere model used for the procedure
IAgAvtrAtmosphereModel atmosphere = procedure.AtmosphereModel;
// Let's use the procedure model
atmosphere.AtmosphereModelSource = AgEAvtrWindAtmosModelSource.eProcedureModel;
// Get the basic atmosphere options
IAgAvtrAtmosphereModelBasic basicAtmosphere = atmosphere.ModeAsBasic;
// Use standard 1976 atmosphere
basicAtmosphere.BasicModelType = AgEAvtrAtmosphereModel.eStandard1976;
Configure procedure time options
[C#]
// Get the time in epoch seconds
Application.UnitPreferences.SetCurrentUnit("DateFormat", "EpSec");
// Get the time options
IAgAvtrProcedureTimeOptions timeOptions = procedure.TimeOptions;
// Get the start time
Object startTime = timeOptions.StartTime;
// Set the procedure to interrupt after 15 seconds
timeOptions.SetInterruptTime(15);
Rename a procedure and its site
[Visual Basic .NET]
' Rename the procedure
procedure.Name = "New Procedure"
' Get the site corresponding to the procedure
Dim site As IAgAvtrSite = procedure.Site
' Rename the site
site.Name = "New Site"
Configure the wind and atmosphere for a procedure
[Visual Basic .NET]
' Get the wind model for the procedure
Dim windModel As IAgAvtrWindModel = procedure.WindModel
' Use the procedure model
windModel.WindModelSource = AgEAvtrWindAtmosModelSource.eProcedureModel
' Let's use constant wind
windModel.WindModelType = AgEAvtrWindModelType.eConstantWind
' Get the constant wind model options
Dim constantWind As IAgAvtrWindModelConstant = windModel.ModeAsConstant
' Set the wind bearing
constantWind.WindBearing = 30
' Set the wind speed
constantWind.WindSpeed = 5

' Get the atmosphere model used for the procedure
Dim atmosphere As IAgAvtrAtmosphereModel = procedure.AtmosphereModel
' Let's use the procedure model
atmosphere.AtmosphereModelSource = AgEAvtrWindAtmosModelSource.eProcedureModel
' Get the basic atmosphere options
Dim basicAtmosphere As IAgAvtrAtmosphereModelBasic = atmosphere.ModeAsBasic
' Use standard 1976 atmosphere
basicAtmosphere.BasicModelType = AgEAvtrAtmosphereModel.eStandard1976
Configure procedure time options
[Visual Basic .NET]
' Get the time in epoch seconds
Application.UnitPreferences.SetCurrentUnit("DateFormat", "EpSec")
' Get the time options
Dim timeOptions As IAgAvtrProcedureTimeOptions = procedure.TimeOptions
' Get the start time
Dim startTime As [Object] = timeOptions.StartTime
' Set the procedure to interrupt after 15 seconds
timeOptions.SetInterruptTime(15)
Rename a procedure and its site
[Python - STK API]
      # IAgAvtrProcedure procedure: Procedure object
# Rename the procedure
procedure.Name = 'New Procedure'
# Get the site corresponding to the procedure
site = procedure.Site
# Rename the site
site.Name = 'New Site'
Configure a procedure time options
[Python - STK API]
      # IAgAvtrProcedure procedure: Procedure object
# Get the time in epoch seconds
root.UnitPreferences.SetCurrentUnit('DateFormat', 'EpSec')
# Get the time options
timeOptions = procedure.TimeOptions
# Get the start time
startTime = timeOptions.StartTime
# Set the procedure to interrupt after 15 seconds
timeOptions.SetInterruptTime(15)
Configure the wind and atmosphere for a procedure
[Python - STK API]
      # IAgAvtrProcedure procedure: Procedure object
# Get the wind model for the procedure
windModel = procedure.WindModel
# Use the procedure model
windModel.WindModelSource = AgEAvtrWindAtmosModelSource.eProcedureModel
# Let's use constant wind
windModel.WindModelType = AgEAvtrWindModelType.eConstantWind
# Get the constant wind model options
constantWind = windModel.ModeAsConstant
# Set the wind bearing
constantWind.WindBearing = 30
# Set the wind speed
constantWind.WindSpeed = 5

# Get the atmosphere model used for the procedure
atmosphere = procedure.AtmosphereModel
# Let's use the procedure model
atmosphere.AtmosphereModelSource = AgEAvtrWindAtmosModelSource.eProcedureModel
# Get the basic atmosphere options
basicAtmosphere = atmosphere.ModeAsBasic
# Use standard 1976 atmosphere
basicAtmosphere.BasicModelType = AgEAvtrAtmosphereModel.eStandard1976
Rename a procedure and its site
[MATLAB]
% IAgAvtrProcedure procedure: Procedure object
% Rename the procedure
procedure.Name = 'New Procedure';
% Get the site corresponding to the procedure
site = procedure.Site;
% Rename the site
site.Name = 'New Site';
Configure the wind and atmosphere for a procedure
[MATLAB]
% IAgAvtrProcedure procedure: Procedure object
% Get the wind model for the procedure
windModel = procedure.WindModel;
% Use the procedure model
windModel.WindModelSource = 'eProcedureModel';
% Let's use constant wind
windModel.WindModelType = 'eConstantWind';
% Get the constant wind model options
constantWind = windModel.ModeAsConstant;
% Set the wind bearing
constantWind.WindBearing = 30;
% Set the wind speed
constantWind.WindSpeed = 5;

% Get the atmosphere model used for the procedure
atmosphere = procedure.AtmosphereModel;
% Let's use the procedure model
atmosphere.AtmosphereModelSource = 'eProcedureModel';
% Get the basic atmosphere options
basicAtmosphere = atmosphere.ModeAsBasic;
% Use standard 1976 atmosphere
basicAtmosphere.BasicModelType = 'eStandard1976';
Configure a procedure time options
[MATLAB]
% IAgAvtrProcedure procedure: Procedure object
% Get the time in epoch seconds
root.UnitPreferences.SetCurrentUnit('DateFormat', 'EpSec');
% Get the time options
timeOptions = procedure.TimeOptions;
% Get the start time
startTime = timeOptions.StartTime;
% Set the procedure to interrupt after 15 seconds
timeOptions.SetInterruptTime(15);
© 2024 Analytical Graphics, Inc. All Rights Reserved.