CIP JAVA documentation for class "com.ptc.pfc.pfcUDFCreate.pfcUDFCreate"

Class pfcUDFCreate

package com.ptc.pfc.pfcUDFCreate; public class pfcUDFCreate

Description

Contains global CIP definitions for module "pfcUDFCreate"

Method Summary
`static UDFAssemblyIntersection`	`UDFAssemblyIntersection_Create (intseq ComponentPath, int VisibilityLevel)` Creates an assembly intersection object, which is used to place a UDF programatically.
`static UDFCustomCreateInstructions`	`UDFCustomCreateInstructions_Create (String Name)` Creates an instructions object, which is used to place a UDF programmatically.
`static UDFExternalReference`	`UDFExternalReference_Create (ComponentPath Model)` Creates a UDFExternalReference object that is required when placing a UDF with external references.
`static UDFReference`	`UDFReference_Create (String PromptForReference, Selection ReferenceItem)` Creates a UDF reference that is required when placing a UDF with references.
`static UDFVariantDimension`	`UDFVariantDimension_Create (String Name, double DimensionValue)` Specifies the value of the dimension the user must supply to place the UDF.
`static UDFVariantPatternParam`	`UDFVariantPatternParam_Create (String Name, int PatternParam)` Specifies the name of the pattern parameter the user must supply to place the UDF.

Method Detail

UDFVariantDimension_Create

static UDFVariantDimension UDFVariantDimension_Create (String Name, double DimensionValue)

Specifies the value of the dimension the user must supply to place the UDF.

Used as a component of UDFCustomCreateInstructions .

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

Parameters:

Name: The name given to the dimension by the UDF.
DimensionValue: The dimension value.

Returns:: Instance of the UDFVariantDimension object.

UDFVariantPatternParam_Create

static UDFVariantPatternParam UDFVariantPatternParam_Create (String Name, int PatternParam)

Specifies the name of the pattern parameter the user must supply to place the UDF.

Used as a component of UDFCustomCreateInstructions .

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

Parameters:

Name: The name given to the pattern parameter by the UDF.
PatternParam: The parameter value

Returns:: Instance of the UDFVariantPatternParem object.

UDFReference_Create

static UDFReference UDFReference_Create (String PromptForReference, Selection ReferenceItem)

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

Used as a component of UDFCustomCreateInstructions .

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.

Returns:: Instance of the UDFReference object.

UDFAssemblyIntersection_Create

static UDFAssemblyIntersection UDFAssemblyIntersection_Create (intseq ComponentPath, int VisibilityLevel)

Creates an assembly intersection object, which is used to place a UDF programatically.

Used as a component of UDFCustomCreateInstructions .

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

Parameters:

ComponentPath: The member identifier table that defines the location of the intersected part in the assembly that contains the UDF.
VisibilityLevel: The length of the ComponentPath that corresponds to the visibility level of the intersected part in the assembly. If VisibilityLevel == the number of entries in the ComponentPath sequence, the feature is visible in the part that it intersects. If VisibilityLevel is 0, the feature is visible at the level of the assembly containing the UDF.

Returns:: Instance of the AssemblyIntersection object.

UDFExternalReference_Create

static UDFExternalReference UDFExternalReference_Create (ComponentPath Model)

Creates a UDFExternalReference object that is required when placing a UDF with external references.

Used as a component of UDFCustomCreateInstructions .

Parameters:

Model: Component path to the model to which the external reference is made.

Returns:: Instance of the UDFExternalReference object.

UDFCustomCreateInstructions_Create

static UDFCustomCreateInstructions UDFCustomCreateInstructions_Create (String Name)

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

Used as a component of UDFCustomCreateInstructions .

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.