STK Vector Geometry ToolSend comments on this topic.
IAgCrdnEventExtremum Interface

Description

Determines time of global minimum or maximum of specified scalar calculation. Determination is performed within interval list using Sampling and Convergence parameters.

Public Properties

Public Property CalculationThe scalar calculation.
Public Property ConvergenceA Convergence definition, which uses time tolerance to determine when time of extremum is found.
Public Property CustomTimeLimitsA custom interval list or a single interval. By default it is set to overall availability of host object. This determines time limits within which global minimum or maximum is sought. The time limits will be used if UseCustomTimeLimits is set to true.
Public Property ExtremumTypeThe extremum type of interest (either minimum or maximum) for scalar calculation.
Public Property SamplingA Sampling definition, which can use a fixed step, relative tolerance or curvature tolerance. Relative tolerance uses a combination of relative and absolute changes in scalar values between samples. Curvature tolerance also uses changes in slope between samples.
Public Property SaveDataOptionDetermines if computed time of extremum is saved/loaded, otherwise it is recomputed on load if necessary.
Public Property UseCustomTimeLimitsIndicate whether to use specified custom time limits (see CustomTimeLimits).

Interfaces

Implemented Interface
IAgCrdnEvent
IAgCrdn

CoClasses that Implement IAgCrdnEventExtremum

Example

Create and configure extremum event.
[C#]
IAgCrdnEvent timeEvent = provider.Events.Factory.CreateEventExtremum("MyEventExtremum", "MyDescription");
IAgCrdnEventExtremum asExtremum = timeEvent as IAgCrdnEventExtremum;

// For instance, time at highest altitude
asExtremum.Calculation = provider.CalcScalars["GroundTrajectory.Detic.LLA.Altitude"];
asExtremum.ExtremumType = AgECrdnExtremumConstants.eCrdnExtremumMaximum;

IAgCrdnEventFindOccurrenceResult occurrence = timeEvent.FindOccurrence();
if (occurrence.IsValid)
{
    Console.WriteLine("Event occurred at: " + occurrence.Epoch);
}
Create and configure extremum event.
[Visual Basic .NET]
Dim timeEvent As IAgCrdnEvent = provider.Events.Factory.CreateEventExtremum("MyEventExtremum", "MyDescription")
Dim asExtremum As IAgCrdnEventExtremum = TryCast(timeEvent, IAgCrdnEventExtremum)

' For instance, time at highest altitude
asExtremum.Calculation = provider.CalcScalars("GroundTrajectory.Detic.LLA.Altitude")
asExtremum.ExtremumType = AgECrdnExtremumConstants.eCrdnExtremumMaximum

Dim occurrence As IAgCrdnEventFindOccurrenceResult = timeEvent.FindOccurrence()
If occurrence.IsValid Then
	Console.WriteLine("Event occurred at: " + occurrence.Epoch)
End If
© 2024 Analytical Graphics, Inc. All Rights Reserved.