CIP C++ documentation for class "pfcUDFReference"

Class pfcUDFReference

# include <pfcUDFCreate.h> class pfcUDFReference : public virtual xobject { xdeclare(pfcUDFReference) ... }; This is a COMPACT class.

Description

This class describes an array of element references.

Method Summary


`static pfcUDFReference_ptr`	`Create (xrstring PromptForReference, pfcSelection_ptr ReferenceItem)`
	Creates a UDF reference that is required when placing a UDF with references.

`xbool`	`GetIsExternal ()`
`void`	`SetIsExternal (xbool value)`
	Determines whether reference is to current solid or to an external solid.

`xstring`	`GetPromptForReference ()`
`void`	`SetPromptForReference (xrstring value)`
	String given to user if placing UDF interactively.

`pfcSelection_ptr`	`GetReferenceItem ()`
`void`	`SetReferenceItem (pfcSelection_ptr value)`
	Item used for reference.

Method Detail

`xstring`	`GetPromptForReference`	`()`
`void`	`SetPromptForReference`	`(xrstring value)`

String given to user if placing UDF interactively.

`pfcSelection_ptr`	`GetReferenceItem`	`()`
`void`	`SetReferenceItem`	`(pfcSelection_ptr value)`

Item used for reference.

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

`xbool`	`GetIsExternal`	`()`
`void`	`SetIsExternal`	`(xbool value)`

Determines whether reference is to current solid or to an external solid.

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

static pfcUDFReference_ptr Create (xrstring PromptForReference, pfcSelection_ptr ReferenceItem)

Creates a UDF reference that is required when placing a UDF with references.

Used as a component of pfcUDFCustomCreateInstructions .

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

Parameters:

PromptForReference: String that would be given to user if placing UDF interactively.
ReferenceItem: Item to use as reference. Include component path if reference is external.