AGI AgAsHpopPlugin 6 Send comments on this topic.
Evaluate Method (IAgAsHpopPlugin)
See Also 
ResultEval
Interface component to access inputs and outputs.
Windows








Description

Triggered on every force model evaluation during the propagation of a step. Use the input interface to access force model settings. Returning false will turn this callback off.

Syntax

[Visual Basic .NET]
Public Function Evaluate( _
   ByVal ResultEval As AgAsHpopPluginResultEval _
) As Boolean

[C#]
public bool Evaluate(
AgAsHpopPluginResultEval ResultEval
);

[Managed C++]
public: bool Evaluate(
AgAsHpopPluginResultEval ^ ResultEval
);

[Unmanaged C++]
public: HRESULT Evaluate(
AgAsHpopPluginResultEval * ResultEval,
VARIANT_BOOL * ReturnValue
);

[VBScript]
'Function object.Evaluate(...)  returns type Boolean
' ResultEval is type AgAsHpopPluginResultEval (an object)
result = object.Evaluate(ResultEval)

[Perl]
$return_value = $objectReference->Evaluate(# $return_value is of type int
$ResultEval# type AgAsHpopPluginResultEval (object reference)
);

Parameters

ResultEval
Interface component to access inputs and outputs.

Return Type

Return true to indicate success, false to indicate failure.  If false is returned, this method will no longer be called from HPOP.

See Also

© 2017 Analytical Graphics, Inc. All Rights Reserved.

ODTK 6.5