AGI STK VGT 11 Send comments on this topic.
IAgCrdnCalcScalarFactory Interface





Description

The factory creates scalar calculation components.

Object Model
















Public Methods

Public Method Create Creates and registers a scalar calculation using specified name, description, and type.
Public Method CreateCalcScalarAngle Create a scalar calculation equal to angular displacement obtained from any angle in VGT.
Public Method CreateCalcScalarConstant Create a scalar calculation of constant value of the specified dimension.
Public Method CreateCalcScalarDataElement Create a scalar calculation defined from a time-dependent data element from STK data providers available for parent STK object.
Public Method CreateCalcScalarDataElementWithGroup Create a scalar calculation defined from a time-dependent data element from STK data providers available for parent STK object.
Public Method CreateCalcScalarDerivative Create a scalar calculation that is the derivative of an input scalar calculation.
Public Method CreateCalcScalarElapsedTime Create a scalar calculation that is the time elapsed since a reference time instant.
Public Method CreateCalcScalarFile Create scalar calculation specified by external data file.
Public Method CreateCalcScalarFixedAtTimeInstant Create a scalar calculation defined by evaluating the input scalar calculation at the specified reference time instant.
Public Method CreateCalcScalarFromCustomScript Create a calc scalar calculation that uses scripted algorithm in MATLAB (.m or .dll), Perl or VBScript to define its value and rate.
Public Method CreateCalcScalarFunction Create a scalar calculation that is defined by performing the specified function on the input scalar or time instant.
Public Method CreateCalcScalarFunction2Var Create a scalar calculation that is defined by performing a function(x,y) on two scalar arguments.
Public Method CreateCalcScalarIntegral Create a scalar calculation that is the integral of an input scalar computed with respect to time using one of the specified numerical methods and using one of the specified accumulation types.
Public Method CreateCalcScalarPluginFromDisplayName Create a scalar calculation based on a COM plugin. For information how to implement and register VGT plugins, see COM-based Engine Plugins..
Public Method CreateCalcScalarVectorMagnitude Create a scalar calculation equal to the magnitude of a specified vector.
Public Method IsTypeSupported Returns whether the specified type is supported.

Public Properties

Public Property AvailableCalcScalarPluginDisplayNames An array of display names associated with available scalar calculation plugins. The elements of the array are strings. Display names are used to create Calc scalars based on COM plugins using method.

Example

Create a calc scalar constant.
[C#] Copy Code
//Create a calc scalar constant. 
IAgCrdnCalcScalarConstant calcScalar = (IAgCrdnCalcScalarConstant)provider.CalcScalars.Factory.Create( 
    "CalcScalarName""Calc scalar constant.", AgECrdnCalcScalarType.eCrdnCalcScalarTypeConstant); 
 

Determine if the specified calc scalar type is supported.
[C#] Copy Code
// Check if the specified calc scalar type is supported. 
if (provider.CalcScalars.Factory.IsTypeSupported(calcScalarType)) 

    //Create a CalcScalar with the supported Type 
    IAgCrdnCalcScalar calcScalar = provider.CalcScalars.Factory.Create( 
        "MyCalcScalar"string.Empty, 
        calcScalarType); 

 

Create a calc scalar constant.
[Visual Basic .NET] Copy Code
'Create a calc scalar constant.
Dim calcScalar As IAgCrdnCalcScalarConstant = DirectCast(provider.CalcScalars.Factory.Create("CalcScalarName", "Calc scalar constant.", AgECrdnCalcScalarType.eCrdnCalcScalarTypeConstant), IAgCrdnCalcScalarConstant)

Determine if the specified calc scalar type is supported.
[Visual Basic .NET] Copy Code
' Check if the specified calc scalar type is supported.
If provider.CalcScalars.Factory.IsTypeSupported(calcScalarType) Then
    'Create a CalcScalar with the supported Type
    Dim calcScalar As IAgCrdnCalcScalar = provider.CalcScalars.Factory.Create("MyCalcScalar", String.Empty, calcScalarType)
End If

© 2016 All Rights Reserved.

STK Programming Interface 11.0.1