CIP C++ documentation for class "pfcRelationFunctionListener"

Class pfcRelationFunctionListener

# include <pfcRelations.h> class pfcRelationFunctionListener : public virtual pfcActionListener { xaideclare(pfcRelationFunctionListener) ... };

Description

Listener providing the implementation for external functions registered by this application and capable of being used in relations.

Method Summary


`void`	`AssignValue (pfcRelationOwner_ptr Owner, xrstring FunctionName, pfcParamValues_ptr Arguments, pfcParamValue_ptr Assignment)`
	Function called to evaluate a custom relation function invoked on the left hand side of a relation.

`xbool`	`CheckArguments (pfcRelationOwner_ptr Owner, xrstring FunctionName, pfcParamValues_ptr Arguments)`
	To check the validity of arguments of external function.

`pfcParamValue_ptr`	`EvaluateFunction (pfcRelationOwner_ptr Owner, xrstring FunctionName, pfcParamValues_ptr Arguments)`
	Function called to evaluate a custom relation function invoked on the right hand side of a relation.

Method Detail

xbool CheckArguments (pfcRelationOwner_ptr Owner, xrstring FunctionName, pfcParamValues_ptr Arguments)

To check the validity of arguments of external function.

This method can be used to check the contents of the arguments. If you want to restrict the arguments to be a certain number and a certain type, use the optional argument pfcRelationFunctionOptions::GetArgumentTypes(optional pfcRelationFunctionArguments_ptr) instead.

Manual References:: Relations: Relation Function Listeners, Relations: Relation Function Listeners

Parameters:

Owner: Owner item of the relations
FunctionName: Name of the external function.
Arguments: Arguments passed by the relation to the external function.

Returns:: true or false depending on the check.

pfcParamValue_ptr EvaluateFunction (pfcRelationOwner_ptr Owner, xrstring FunctionName, pfcParamValues_ptr Arguments)

Function called to evaluate a custom relation function invoked on the right hand side of a relation.

Manual References:: Relations: Relation Function Listeners

Parameters:

Owner: Owner item of the relations
FunctionName: Name of the external function.
Arguments: Arguments passed by the relation to the external function.

Returns:: The result of the relation function calculation.

void AssignValue (pfcRelationOwner_ptr Owner, xrstring FunctionName, pfcParamValues_ptr Arguments, pfcParamValue_ptr Assignment)

Function called to evaluate a custom relation function invoked on the left hand side of a relation.

Manual References:: Relations: Relation Function Listeners, Relations: Relation Function Listeners

Parameters:

Owner: Owner item of the relations
FunctionName: Name of the external function.
Arguments: Arguments passed by the relation to the external function.
Assignment: The right hand side of the relation to be used in the assignment.

Returns: