Description

The factory creates scalar calculation components.

Public Methods

Create	Creates and registers a scalar calculation using specified name, description, and type.
CreateCalcScalarAngle	Create a scalar calculation equal to angular displacement obtained from any angle in VGT.
CreateCalcScalarAverage	Create a scalar calculation that is the average of an input scalar computed with respect to time using one of the specified numerical methods and using one of the specified accumulation types.
CreateCalcScalarConstant	Create a scalar calculation of constant value of the specified dimension.
CreateCalcScalarCustomInlineScript	Create a custom inline script scalar.
CreateCalcScalarDataElement	Create a scalar calculation defined from a time-dependent data element from STK data providers available for parent STK object.
CreateCalcScalarDataElementWithGroup	Create a scalar calculation defined from a time-dependent data element from STK data providers available for parent STK object.
CreateCalcScalarDerivative	Create a scalar calculation that is the derivative of an input scalar calculation.
CreateCalcScalarDotProduct	Create a scalar calculation that is defined by a dot product between two vectors.
CreateCalcScalarElapsedTime	Create a scalar calculation that is the time elapsed since a reference time instant.
CreateCalcScalarFile	Create scalar calculation specified by external data file.
CreateCalcScalarFixedAtTimeInstant	Create a scalar calculation defined by evaluating the input scalar calculation at the specified reference time instant.
CreateCalcScalarFromCustomScript	Create a calc scalar calculation that uses scripted algorithm in MATLAB (.m or .dll), Perl or VBScript to define its value and rate.
CreateCalcScalarFunction	Create a scalar calculation that is defined by performing the specified function on the input scalar or time instant.
CreateCalcScalarFunction2Var	Create a scalar calculation that is defined by performing a function(x,y) on two scalar arguments.
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.
CreateCalcScalarPluginFromDisplayName	Create a scalar calculation based on a COM plugin. For information how to implement and register VGT plugins, see COM-based Engine Plugins..
CreateCalcScalarPointInVolumeCalc	Create a scalar calculation along trajectory.
CreateCalcScalarStandardDeviation	Create a scalar calculation that is the standard deviation of an input scalar computed with respect to time using one of the specified numerical methods and using one of the specified accumulation types.
CreateCalcScalarSurfaceDistanceBetweenPoints	Create a calc scalar calculation that is surface distance along the specified central body ellipsoid between two points (or their respective projections if specified at altitude).
CreateCalcScalarVectorComponent	Create a scalar calculation that is defined by a specified component of a vector when resolved in specified axes.
CreateCalcScalarVectorMagnitude	Create a scalar calculation equal to the magnitude of a specified vector.
IsTypeSupported	Returns whether the specified type is supported.

Public Properties

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 CreateCalcScalarPluginFromDisplayName method.

Example

Create a calc scalar constant.

[C#]

//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#]

// 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]

' 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

Create a calc scalar constant.

[Visual Basic .NET]

'Create a calc scalar constant.
Dim calcScalar As IAgCrdnCalcScalarConstant = DirectCast(provider.CalcScalars.Factory.Create("CalcScalarName", "Calc scalar constant.", AgECrdnCalcScalarType.eCrdnCalcScalarTypeConstant), IAgCrdnCalcScalarConstant)

STK Vector Geometry Tool	Send comments on this topic.
IAgCrdnCalcScalarFactory Interface