STK AgCrdnPlugin	Send comments on this topic.
CurrentValue Method (IAgCrdnConfiguredSystemWithRate)
See Also

DispInterface: An interface supporting IAgEpoch. This is the interface that is passed to the plugin component method call.

X: X component of the System's origin location at the current time.

Y: Y component of the System's origin location at the current time.

Z: Z component of the System's origin location at the current time.

Vx: X component of the System's origin location derivative at the current time.

Vy: Y component of the System's origin location derivative at the current time.

Vz: Z component of the System's origin location derivative at the current time.

Q1: Q1 component of the System's axes quaternion at the currrent time.

Q2: Q2 component of the System's axes quaternion at the current time.

Q3: Q3 component of the System's axes quaternion at the current time.

Q4: Q4 component of the System's axes quaternion at the current time.

Wx: X component of the System's axes angular velocity at the current time.

Wy: Y component of the System's axes angular velocity at the current time.

Wz: Z component of the System's axes angular velocity at the current time.

Description

Computes the System position and velocity, quaternion, and angular rate in reference components (in internal units) at the interface's current time.

Syntax

[Visual Basic .NET]
Public Function CurrentValue( _ ByVal DispInterface As Object, _ ByRef X As Double, _ ByRef Y As Double, _ ByRef Z As Double, _ ByRef Vx As Double, _ ByRef Vy As Double, _ ByRef Vz As Double, _ ByRef Q1 As Double, _ ByRef Q2 As Double, _ ByRef Q3 As Double, _ ByRef Q4 As Double, _ ByRef Wx As Double, _ ByRef Wy As Double, _ ByRef Wz As Double _ ) As Boolean

[Visual Basic .NET]

Public Function CurrentValue( _
    ByVal DispInterface As Object, _
    ByRef X As Double, _
    ByRef Y As Double, _
    ByRef Z As Double, _
    ByRef Vx As Double, _
    ByRef Vy As Double, _
    ByRef Vz As Double, _
    ByRef Q1 As Double, _
    ByRef Q2 As Double, _
    ByRef Q3 As Double, _
    ByRef Q4 As Double, _
    ByRef Wx As Double, _
    ByRef Wy As Double, _
    ByRef Wz As Double _
) As Boolean

[C#]
public bool CurrentValue( Object DispInterface, ref double X, ref double Y, ref double Z, ref double Vx, ref double Vy, ref double Vz, ref double Q1, ref double Q2, ref double Q3, ref double Q4, ref double Wx, ref double Wy, ref double Wz );

[C#]

public bool CurrentValue(
    Object DispInterface,
    ref double X,
    ref double Y,
    ref double Z,
    ref double Vx,
    ref double Vy,
    ref double Vz,
    ref double Q1,
    ref double Q2,
    ref double Q3,
    ref double Q4,
    ref double Wx,
    ref double Wy,
    ref double Wz
);

[Managed C++]
public: bool CurrentValue( IUnknown ^ DispInterface, double ^ X, double ^ Y, double ^ Z, double ^ Vx, double ^ Vy, double ^ Vz, double ^ Q1, double ^ Q2, double ^ Q3, double ^ Q4, double ^ Wx, double ^ Wy, double ^ Wz );

[Managed C++]

public: bool CurrentValue(
    IUnknown ^ DispInterface,
    double ^ X,
    double ^ Y,
    double ^ Z,
    double ^ Vx,
    double ^ Vy,
    double ^ Vz,
    double ^ Q1,
    double ^ Q2,
    double ^ Q3,
    double ^ Q4,
    double ^ Wx,
    double ^ Wy,
    double ^ Wz
);

[Unmanaged C++]
public: HRESULT CurrentValue( IUnknown * DispInterface, double * X, double * Y, double * Z, double * Vx, double * Vy, double * Vz, double * Q1, double * Q2, double * Q3, double * Q4, double * Wx, double * Wy, double * Wz, VARIANT_BOOL * pResult );

[Unmanaged C++]

public: HRESULT CurrentValue(
    IUnknown * DispInterface,
    double * X,
    double * Y,
    double * Z,
    double * Vx,
    double * Vy,
    double * Vz,
    double * Q1,
    double * Q2,
    double * Q3,
    double * Q4,
    double * Wx,
    double * Wy,
    double * Wz,
    VARIANT_BOOL * pResult
);

Parameters

DispInterface: An interface supporting IAgEpoch. This is the interface that is passed to the plugin component method call.
X: X component of the System's origin location at the current time.
Y: Y component of the System's origin location at the current time.
Z: Z component of the System's origin location at the current time.
Vx: X component of the System's origin location derivative at the current time.
Vy: Y component of the System's origin location derivative at the current time.
Vz: Z component of the System's origin location derivative at the current time.
Q1: Q1 component of the System's axes quaternion at the currrent time.
Q2: Q2 component of the System's axes quaternion at the current time.
Q3: Q3 component of the System's axes quaternion at the current time.
Q4: Q4 component of the System's axes quaternion at the current time.
Wx: X component of the System's axes angular velocity at the current time.
Wy: Y component of the System's axes angular velocity at the current time.
Wz: Z component of the System's axes angular velocity at the current time.

Return Type

Returns false if an error occurred, else returns true.

Remarks

Plugin components that know a current time use interface arguments supporting this interface. See IAgAsHpopPluginResult and IAgGatorPluginResultState for examples.

Description

Syntax

Parameters

Return Type

Remarks

See Also