CIP C++ documentation for class "pfcRelationFunctionOptions"

Class pfcRelationFunctionOptions

# include <pfcRelations.h> class pfcRelationFunctionOptions : public virtual xobject { xdeclare(pfcRelationFunctionOptions) ... };

Description

Options to enable/disable various relation function related features.

Method Summary


`static pfcRelationFunctionOptions_ptr`	`Create ()`
	Create a `pfcRelationFunctionOptions` object.

`optional pfcRelationFunctionArguments_ptr`	`GetArgumentTypes ()`
`void`	`SetArgumentTypes (optional pfcRelationFunctionArguments_ptr value)`
	The types of arguments permitted by the relation function. Default is `null`, indicating that no arguments are permitted.

`optional xbool`	`GetEnableArgumentCheckMethod ()`
`void`	`SetEnableArgumentCheckMethod (optional xbool value)`
	Turn the method (using `pfcRelationFunctionListener::CheckArguments(pfcRelationOwner_ptr, xrstring, pfcParamValues_ptr)`) on/off. Default is `false`.

`optional xbool`	`GetEnableExpressionEvaluationMethod ()`
`void`	`SetEnableExpressionEvaluationMethod (optional xbool value)`
	Turn the method (using `pfcRelationFunctionListener::EvaluateFunction(pfcRelationOwner_ptr, xrstring, pfcParamValues_ptr)`) on/off. Default is `true`.

`optional xbool`	`GetEnableTypeChecking ()`
`void`	`SetEnableTypeChecking (optional xbool value)`
	Turn argument type checking (using `pfcRelationFunctionOptions::GetArgumentTypes(optional pfcRelationFunctionArguments_ptr)`) on/off. Default is `false`.

`optional xbool`	`GetEnableValueAssignmentMethod ()`
`void`	`SetEnableValueAssignmentMethod (optional xbool value)`
	Turn `pfcRelationFunctionListener::AssignValue(pfcRelationOwner_ptr, xrstring, pfcParamValues_ptr, pfcParamValue_ptr)` on/off. Default is `false`.

Method Detail

`optional pfcRelationFunctionArguments_ptr`	`GetArgumentTypes`	`()`
`void`	`SetArgumentTypes`	`(optional pfcRelationFunctionArguments_ptr value)`

The types of arguments permitted by the relation function. Default is null, indicating that no arguments are permitted.

Manual References:: Relations: Relation Function Options

`optional xbool`	`GetEnableTypeChecking`	`()`
`void`	`SetEnableTypeChecking`	`(optional xbool value)`

Turn argument type checking (using pfcRelationFunctionOptions::GetArgumentTypes(optional pfcRelationFunctionArguments_ptr)) on/off. Default is false.

Manual References:: Relations: Relation Function Options

`optional xbool`	`GetEnableArgumentCheckMethod`	`()`
`void`	`SetEnableArgumentCheckMethod`	`(optional xbool value)`

Turn the method (using pfcRelationFunctionListener::CheckArguments(pfcRelationOwner_ptr, xrstring, pfcParamValues_ptr)) on/off. Default is false.

Manual References:: Relations: Relation Function Options

`optional xbool`	`GetEnableExpressionEvaluationMethod`	`()`
`void`	`SetEnableExpressionEvaluationMethod`	`(optional xbool value)`

Turn the method (using pfcRelationFunctionListener::EvaluateFunction(pfcRelationOwner_ptr, xrstring, pfcParamValues_ptr)) on/off. Default is true.

Manual References:: Relations: Relation Function Options

`optional xbool`	`GetEnableValueAssignmentMethod`	`()`
`void`	`SetEnableValueAssignmentMethod`	`(optional xbool value)`

Turn pfcRelationFunctionListener::AssignValue(pfcRelationOwner_ptr, xrstring, pfcParamValues_ptr, pfcParamValue_ptr) on/off. Default is false.

Manual References:: Relations: Relation Function Options

static pfcRelationFunctionOptions_ptr Create ()

Create a pfcRelationFunctionOptions object.

Manual References:: Relations: Relation Function Options, Relations: Relation Function Options

Returns:: The new object.