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





Description

Returns whether the specified type is supported.

Syntax

[Visual Basic .NET] 
Public Function IsTypeSupported( _
   ByVal EType As AgECrdnEventArrayType _
) As Boolean
[C#] 
public bool IsTypeSupported(

   AgECrdnEventArrayType EType

);
[Managed C++] 
public: bool IsTypeSupported(

   AgECrdnEventArrayType EType

);
[Java] 
public bool isTypeSupported(

   AgECrdnEventArrayType EType

);
[Unmanaged C++] 
public: HRESULT IsTypeSupported(

   AgECrdnEventArrayType EType, 

   VARIANT_BOOL * ReturnValue

);

Parameters

EType
Member Value Description
eCrdnEventArrayTypeUnknown -1 Unknown or unsupported time array types
eCrdnEventArrayTypeExtrema 0 Determines time of local minimum and/or maximum of specified scalar calculation.
eCrdnEventArrayTypeStartStopTimes 1 Defined by taking start and/or stop times of every interval in specified reference interval list and adding them to array.
eCrdnEventArrayTypeMerged 2 Defined by merging times from two other arrays by creating union of bounding intervals from two constituent arrays.
eCrdnEventArrayTypeFiltered 3 Defined by filtering times from original time array according to specified filtering method.
eCrdnEventArrayTypeFixedStep 4 Defined by taking fixed time steps from specified time reference and adding sampled times to array if they fall within specified bounding interval list.
eCrdnEventArrayTypeConditionCrossings 5 Time array containing times at which specified condition changes its satisfaction status.
eCrdnEventArrayTypeSignaled 6 Determines what time array is recorded at target clock location by performing signal transmission of original time array between base and target clock locations.
eCrdnEventArrayTypeFixedTimes 7 Time array containing specific times.

Example

Determine if the specified event array type is supported.
[C#] Copy Code
// Check if the specified event array type is supported. 
if (provider.EventArrays.Factory.IsTypeSupported(eventArrayType)) 
{ 
    //Create an EventArray with the supported Type 
    IAgCrdnEventArray eventArray = provider.EventArrays.Factory.Create( 
        "MyEventArray", string.Empty, 
        eventArrayType); 
} 
 
Determine if the specified event array type is supported.
[Visual Basic .NET] Copy Code
' Check if the specified event array type is supported.
If provider.EventArrays.Factory.IsTypeSupported(eventArrayType) Then
    'Create an EventArray with the supported Type
    Dim eventArray As IAgCrdnEventArray = provider.EventArrays.Factory.Create("MyEventArray", String.Empty, eventArrayType)
End If

See Also

© 2016 All Rights Reserved.

STK Programming Interface 11.0.1