AGI AgCrdnPlugin 11 Send comments on this topic.
CurrentValue Method (IAgCrdnConfiguredVectorWithRate)
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 vector at the current time
Y
Y component of the vector at the current time
Z
Z component of the vector at the current time
Vx
X component of the vector derivative at the current time
Vy
Y component of the vector derivative at the current time
Vz
Z component of the vector derivative at the current time





Description

Computes the Vector and its rate (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 _
) 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
);

[Managed C++]
public: bool CurrentValue(
IUnknown ^ DispInterface,
double ^ X,
double ^ Y,
double ^ Z,
double ^ Vx,
double ^ Vy,
double ^ Vz
);

[Java]
public bool currentValue(
Object DispInterface,
double X,
double Y,
double Z,
double Vx,
double Vy,
double Vz
);

[Unmanaged C++]
public: HRESULT CurrentValue(
IUnknown * DispInterface,
double * X,
double * Y,
double * Z,
double * Vx,
double * Vy,
double * Vz,
VARIANT_BOOL * ReturnValue
);

Parameters

DispInterface

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

X
X component of the vector at the current time
Y
Y component of the vector at the current time
Z
Z component of the vector at the current time
Vx
X component of the vector derivative at the current time
Vy
Y component of the vector derivative at the current time
Vz
Z component of the vector derivative 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.

See Also

© 2016 Analytical Graphics, Inc. All Rights Reserved.

STK Programming Interface 11.0.1