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





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
Member Value Description
eCrdnCalcScalarTypeUnknown -1 Unknown or unsupported calculation scalar types
eCrdnCalcScalarTypeAngle 0 Scalar equal to angular displacement obtained from any angle in VGT.
eCrdnCalcScalarTypeFixedAtTimeInstant 1 Constant scalar created by evaluating input scalar calculation at specified reference time instant.
eCrdnCalcScalarTypeConstant 2 Constant scalar value of specified dimension.
eCrdnCalcScalarTypeDataElement 3 Any time-dependent data element from STK data providers available for parent STK object.
eCrdnCalcScalarTypeDerivative 4 Derivative of input scalar calculation.
eCrdnCalcScalarTypeElapsedTime 5 Time elapsed since reference time instant.
eCrdnCalcScalarTypeFile 6 Tabulated scalar calculation data loaded from specified file.
eCrdnCalcScalarTypeFunction 7 Defined by performing one of specified functions on input scalar.
eCrdnCalcScalarTypeIntegral 8 Integral of input scalar computed with respect to time using one of specified numerical methods and using one of specified accumulation types.
eCrdnCalcScalarTypeFunction2Var 9 Defined by performing one of specified binary operations on two scalar arguments.
eCrdnCalcScalarTypeVectorMagnitude 10 Scalar equal to magnitude of specified vector.
eCrdnCalcScalarTypePlugin 11 A calc scalar plugin based on a COM object.
eCrdnCalcScalarTypeCustomScript 12 A calc scalar uses scripted algorithm in MATLAB (.m or .dll), Perl or VBScript to define its value and rate.

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

© 2016 All Rights Reserved.

STK Programming Interface 11.0.1