CIP C++ documentation for class "pfcUDFCustomCreateInstructions"

Class pfcUDFCustomCreateInstructions

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

Description

Contains all options required to place a UDF programmatically. Users can enter attribute data programmatically, or wait for Creo Parametric to interactively prompt for the missing data.

Direct Known Subclasses:: wfcWUDFCustomCreateInstructions

Method Summary


`static pfcUDFCustomCreateInstructions_ptr`	`Create (xrstring Name)`
	Creates an instructions object, which is used to place a UDF programmatically.

`optional pfcComponentPath_ptr`	`GetAssemblyReference ()`
`void`	`SetAssemblyReference (optional pfcComponentPath_ptr value)`
	This property specifies the path to the placement model from the top-level assembly used by reference selections, if the placement model is not the top level assembly. This is necessary whenever external references are used for placement, or whenever the reference selections are made from a context outside of the placement model.

`optional pfcUDFDependencyType`	`GetDependencyType ()`
`void`	`SetDependencyType (optional pfcUDFDependencyType value)`
	The dependency of the UDF. The choices correspond to the choices available when you create the UDF interactively.

`optional pfcUDFDimensionDisplayType`	`GetDimDisplayType ()`
`void`	`SetDimDisplayType (optional pfcUDFDimensionDisplayType value)`
	These values correspond to the options in Creo Parametric for determining the appearance in the model of UDF dimensions and pattern parameters that were not variable in the UDF, and therefore cannot be modified in the model.

`optional pfcUDFExternalReferences_ptr`	`GetExtReferences ()`
`void`	`SetExtReferences (optional pfcUDFExternalReferences_ptr value)`
	This property is deprecated. To specify the path to the placement model from the top-level assembly used by reference selections use the AssemblyReference property.

`optional xstring`	`GetInstanceName ()`
`void`	`SetInstanceName (optional xrstring value)`
	If the UDF contains a family table, this field can be used to select which instance in that table is to be selected. If the UDF contains no family table, or if the generic instance is to be selected, the string should be empty.

`optional pfcUDFAssemblyIntersections_ptr`	`GetIntersections ()`
`void`	`SetIntersections (optional pfcUDFAssemblyIntersections_ptr value)`
	An array of intersections of the UDF and parts within the assembly.

`optional pfcUDFOrientations_ptr`	`GetOrientations ()`
`void`	`SetOrientations (optional pfcUDFOrientations_ptr value)`
	An array of orientations that provide the answers to Creo Parametric prompts that use a flip arrow. The order of orientations should correspond to the order in which Creo Parametric prompts for them when the UDF is created interactively. If you do not provide an orientation that Creo Parametric needs, it uses the default value ``no flip.''

`optional pfcPoint3Ds_ptr`	`GetQuadrants ()`
`void`	`SetQuadrants (optional pfcPoint3Ds_ptr value)`
	An array of points, which provide the X, Y, and Z coordinates that correspond to the picks answering the Creo Parametric prompts for the feature positions. The order of quadrants should correspond to the order in which Creo Parametric prompts for them when the UDF is created interactively.

`optional pfcUDFReferences_ptr`	`GetReferences ()`
`void`	`SetReferences (optional pfcUDFReferences_ptr value)`
	An array of element references.

`optional xreal`	`GetScale ()`
`void`	`SetScale (optional xreal value)`
	If the value of the ScaleType field is UDFSCALE_CUSTOM, this field is the user-defined scale factor. Otherwise, this field is ignored.

`optional pfcUDFScaleType`	`GetScaleType ()`
`void`	`SetScaleType (optional pfcUDFScaleType value)`
	Specifies what should happen if the UDF used different length units than the model to which it is being applied.

`optional pfcUDFVariantValues_ptr`	`GetVariantValues ()`
`void`	`SetVariantValues (optional pfcUDFVariantValues_ptr value)`
	An array of variable dimensions and pattern parameters

Methods Inherited from Class pfcUDFGroupCreateInstructions:: GetName, SetName, GetShowUDFEditMenu, SetShowUDFEditMenu, GetShowModifyNCSeqMenu, SetShowModifyNCSeqMenu, GetUseExistingTools, SetUseExistingTools, GetTurnOffUDFRedefineMenu, SetTurnOffUDFRedefineMenu, GetTurnOffFixModelUI, SetTurnOffFixModelUI

Method Detail

`optional xstring`	`GetInstanceName`	`()`
`void`	`SetInstanceName`	`(optional xrstring value)`

If the UDF contains a family table, this field can be used to select which instance in that table is to be selected. If the UDF contains no family table, or if the generic instance is to be selected, the string should be empty.

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

`optional pfcUDFDependencyType`	`GetDependencyType`	`()`
`void`	`SetDependencyType`	`(optional pfcUDFDependencyType value)`

The dependency of the UDF. The choices correspond to the choices available when you create the UDF interactively.

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

`optional pfcUDFScaleType`	`GetScaleType`	`()`
`void`	`SetScaleType`	`(optional pfcUDFScaleType value)`

Specifies what should happen if the UDF used different length units than the model to which it is being applied.

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

`optional xreal`	`GetScale`	`()`
`void`	`SetScale`	`(optional xreal value)`

If the value of the ScaleType field is UDFSCALE_CUSTOM, this field is the user-defined scale factor. Otherwise, this field is ignored.

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

`optional pfcUDFVariantValues_ptr`	`GetVariantValues`	`()`
`void`	`SetVariantValues`	`(optional pfcUDFVariantValues_ptr value)`

An array of variable dimensions and pattern parameters

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

`optional pfcUDFDimensionDisplayType`	`GetDimDisplayType`	`()`
`void`	`SetDimDisplayType`	`(optional pfcUDFDimensionDisplayType value)`

These values correspond to the options in Creo Parametric for determining the appearance in the model of UDF dimensions and pattern parameters that were not variable in the UDF, and therefore cannot be modified in the model.

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

`optional pfcUDFReferences_ptr`	`GetReferences`	`()`
`void`	`SetReferences`	`(optional pfcUDFReferences_ptr value)`

An array of element references.

Manual References:: Features: Creating a Custom UDF

`optional pfcUDFAssemblyIntersections_ptr`	`GetIntersections`	`()`
`void`	`SetIntersections`	`(optional pfcUDFAssemblyIntersections_ptr value)`

An array of intersections of the UDF and parts within the assembly.

Manual References:: Features: Creating a Custom UDF

`optional pfcUDFOrientations_ptr`	`GetOrientations`	`()`
`void`	`SetOrientations`	`(optional pfcUDFOrientations_ptr value)`

An array of orientations that provide the answers to Creo Parametric prompts that use a flip arrow. The order of orientations should correspond to the order in which Creo Parametric prompts for them when the UDF is created interactively. If you do not provide an orientation that Creo Parametric needs, it uses the default value ``no flip.''

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

`optional pfcPoint3Ds_ptr`	`GetQuadrants`	`()`
`void`	`SetQuadrants`	`(optional pfcPoint3Ds_ptr value)`

An array of points, which provide the X, Y, and Z coordinates that correspond to the picks answering the Creo Parametric prompts for the feature positions. The order of quadrants should correspond to the order in which Creo Parametric prompts for them when the UDF is created interactively.

Manual References:: Features: Creating a Custom UDF

`optional pfcComponentPath_ptr`	`GetAssemblyReference`	`()`
`void`	`SetAssemblyReference`	`(optional pfcComponentPath_ptr value)`

This property specifies the path to the placement model from the top-level assembly used by reference selections, if the placement model is not the top level assembly. This is necessary whenever external references are used for placement, or whenever the reference selections are made from a context outside of the placement model.

`optional pfcUDFExternalReferences_ptr`	`GetExtReferences`	`()`
`void`	`SetExtReferences`	`(optional pfcUDFExternalReferences_ptr value)`

This property is deprecated. To specify the path to the placement model from the top-level assembly used by reference selections use the AssemblyReference property.

If one or more valid component path is supplied for this property, and null is supplied for the AssemblyReference property, the first component path supplied will be used for the AssemblyReference path.

Manual References:: Features: Creating a Custom UDF

static pfcUDFCustomCreateInstructions_ptr Create (xrstring Name)

Creates an instructions object, which is used to place a UDF programmatically.

Used as a component of pfcUDFCustomCreateInstructions .

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

Parameters:

Name: Name of UDF to be placed.

Returns:: Instance of the UDFCustomCreateInstructions object.