CIP C++ documentation for class "pfcRelationFunctionArgument"

Class pfcRelationFunctionArgument

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

Description

Attributes of argument to be used in the custom relation function.

Method Summary


`static pfcRelationFunctionArgument_ptr`	`Create (pfcParamValueType Type)`
	Create a relation function argument object.

`optional xbool`	`GetIsOptional ()`
`void`	`SetIsOptional (optional xbool value)`
	Specifies whether argument is optional, indicating that the argument does not always need to be suppiled in the relation. Optional arguments must come at the end of the argument list. Default is `false`.

`pfcParamValueType`	`GetType ()`
`void`	`SetType (pfcParamValueType value)`
	Parameter value type of argument.

Method Detail

`pfcParamValueType`	`GetType`	`()`
`void`	`SetType`	`(pfcParamValueType value)`

Parameter value type of argument.

Manual References:: Relations: Relation Function Options

`optional xbool`	`GetIsOptional`	`()`
`void`	`SetIsOptional`	`(optional xbool value)`

Specifies whether argument is optional, indicating that the argument does not always need to be suppiled in the relation. Optional arguments must come at the end of the argument list. Default is false.

Manual References:: Relations: Relation Function Options

static pfcRelationFunctionArgument_ptr Create (pfcParamValueType Type)

Create a relation function argument object.

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

Parameters:

Type: Value type of argument.

Returns:: The new object.