CIP JAVA documentation for class "com.ptc.pfc.pfcFeature.FeatureGroup"

Interface FeatureGroup

package com.ptc.pfc.pfcFeature; public interface FeatureGroup extends com.ptc.pfc.pfcObject.Object

Description

This class describes a feature group.

Direct Known Subclasses:: WFeatureGroup

Method Summary
`/optional/ Dimensions`	`CollectUDFDimensions ()`
`Feature`	`GetGroupLeader ()` Get method for attribute "GroupLeader" The group leader Feature
`/optional/ String`	`GetGroupName ()` Get method for attribute "GroupName" The name of the group.
`boolean`	`GetIsTableDriven ()` Get method for attribute "IsTableDriven" Reports whether the UDF is table-driven.
`/optional/ GroupPattern`	`GetPattern ()` Get method for attribute "Pattern" The group pattern, if the group is a member of a pattern.
`String`	`GetUDFDimensionName (Dimension Dim)`
`/optional/ String`	`GetUDFInstanceName ()` Get method for attribute "UDFInstanceName" If the group is an instance of a UDF, this is the UDF instance name. Otherwise this will be NULL.
`/optional/ String`	`GetUDFName ()` Get method for attribute "UDFName" If the group represents a UDF, this is the UDF name. If the group is not a UDF, this will be NULL.
`Features`	`ListMembers ()` Lists the members of a feature group.
`/optional/ UDFDimensions`	`ListUDFDimensions ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): FeatureGroup.CollectUDFDimensions` Lists the dimensions of a user defined feature group.

Method Detail

GetPattern

/*optional*/ GroupPattern GetPattern ()

The group pattern, if the group is a member of a pattern.

Manual References:: Features: Feature Groups and Patterns, Features: Feature Groups and Patterns

GetGroupLeader

Feature GetGroupLeader ()

The group leader Feature

Manual References:: Features: Access to Features, Features: Access to Features, Features: Feature Groups and Patterns, Features: Feature Groups and Patterns, Features: Changes To Feature Groups

GetGroupName

/*optional*/ String GetGroupName ()

The name of the group.

GetIsTableDriven

boolean GetIsTableDriven ()

Reports whether the UDF is table-driven.

Exceptions thrown (but not limited to):

XToolkitBadContext - The feature is not part of a UDF

ListMembers

Features ListMembers ()

Lists the members of a feature group.

Manual References:: Features: Changes To Feature Groups

Returns:: The features that are members of the group.

GetUDFName

/*optional*/ String GetUDFName ()

If the group represents a UDF, this is the UDF name. If the group is not a UDF, this will be NULL.

Manual References:: Features: Read Access to Groups and User Defined Features, Features: Read Access to Groups and User Defined Features

GetUDFInstanceName

/*optional*/ String GetUDFInstanceName ()

If the group is an instance of a UDF, this is the UDF instance name. Otherwise this will be NULL.

Manual References:: Features: Read Access to Groups and User Defined Features, Features: Read Access to Groups and User Defined Features

ListUDFDimensions

/*optional*/ UDFDimensions ListUDFDimensions ()

DEPRECATED: since Creo 4
SUCCESSOR(S): FeatureGroup.CollectUDFDimensions

Lists the dimensions of a user defined feature group.

The UDF dimensions are the dimensions in the UDF for which Creo Parametric prompts when creating the UDF.

Manual References:: Features: Read Access to Groups and User Defined Features, Features: Read Access to Groups and User Defined Features, Features: Creating a Custom UDF

Returns:: Sequence of UDF Dimensions.

CollectUDFDimensions

/*optional*/ Dimensions CollectUDFDimensions ()

Returns:

GetUDFDimensionName

String GetUDFDimensionName (Dimension Dim)

Exceptions thrown (but not limited to):

XToolkitBadContext - The group is not a UDF.

Parameters:

Dim

Returns: