STK AviatorSend comments on this topic.
IAgAvtrProcedureTimeOptions Interface

Description

Interface used to access the time options for the current procedure. Use this interface to set an Interrupt Time or Fixed Duration for a procedure.

Public Methods

Public Method SetInterruptTimeSet the interrupt time for the procedure.
Public Method SetStartTimeSet the start time for the procedure.
Public Method SetStopTimeSet the stop time for the procedure.

Public Properties

Public Property InterruptTimeInterrupt time for the procedure.
Public Property InterruptTimeEnabledCheck to see if the interrupt time is enabled for this procedure.
Public Property StartTimeStart time for the procedure.
Public Property StartTimeEnabledCheck to see if the start time is enabled for this procedure.
Public Property StopTimeStop time for the procedure.
Public Property StopTimeEnabledCheck to see if the stop time is enabled for this procedure.
Public Property UseInterruptTimeOpt whether to set an interrupt time for the procedure.
Public Property UseStartTimeOpt whether to set a start time for the procedure.
Public Property UseStopTimeOpt whether to set a stop time for the procedure.

CoClasses that Implement IAgAvtrProcedureTimeOptions

Example

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