AGI STK VGT 11Send comments on this topic.
IsTypeSupported Method (IAgCrdnCalcScalarFactory)
See Also  Example
EType
Windows






Windows & Linux

Description

Returns whether the specified type is supported.

Syntax

[Visual Basic .NET]
Public Function IsTypeSupported( _
   ByVal EType As AgECrdnCalcScalarType _
) As Boolean
[C#]
public bool IsTypeSupported(
   AgECrdnCalcScalarType EType
);
[Managed C++]
public: bool IsTypeSupported(
   AgECrdnCalcScalarType EType
);
[Java]
public bool isTypeSupported(
   AgECrdnCalcScalarType EType
);
[Unmanaged C++]
public: HRESULT IsTypeSupported(
   AgECrdnCalcScalarType EType, 
   VARIANT_BOOL * ReturnValue
);

Parameters

EType
MemberValueDescription
eCrdnCalcScalarTypeUnknown-1Unknown or unsupported calculation scalar types
eCrdnCalcScalarTypeAngle0Scalar equal to angular displacement obtained from any angle in VGT.
eCrdnCalcScalarTypeFixedAtTimeInstant1Constant scalar created by evaluating input scalar calculation at specified reference time instant.
eCrdnCalcScalarTypeConstant2Constant scalar value of specified dimension.
eCrdnCalcScalarTypeDataElement3Any time-dependent data element from STK data providers available for parent STK object.
eCrdnCalcScalarTypeDerivative4Derivative of input scalar calculation.
eCrdnCalcScalarTypeElapsedTime5Time elapsed since reference time instant.
eCrdnCalcScalarTypeFile6Tabulated scalar calculation data loaded from specified file.
eCrdnCalcScalarTypeFunction7Defined by performing one of specified functions on input scalar.
eCrdnCalcScalarTypeIntegral8Integral of input scalar computed with respect to time using one of specified numerical methods and using one of specified accumulation types.
eCrdnCalcScalarTypeFunction2Var9Defined by performing one of specified binary operations on two scalar arguments.
eCrdnCalcScalarTypeVectorMagnitude10Scalar equal to magnitude of specified vector.
eCrdnCalcScalarTypePlugin11A calc scalar plugin based on a COM object.
eCrdnCalcScalarTypeCustomScript12A calc scalar uses scripted algorithm in MATLAB (.m or .dll), Perl or VBScript to define its value and rate.
eCrdnCalcScalarTypeSurfaceDistanceBetweenPoints13Surface distance along the specified central body ellipsoid between two points (or their respective projections if specified at altitude).

Example

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

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

See Also

© 2019 Analytical Graphics, Inc. All Rights Reserved.