CIP C++ documentation for class "pfcFeatureGroup"

Class pfcFeatureGroup

# include <pfcFeature.h> class pfcFeatureGroup : public virtual pfcObject { xaideclare(pfcFeatureGroup) ... };

Description

This class describes a feature group.

Manual References:: Features: Feature Groups and Patterns

Direct Known Subclasses:: wfcWFeatureGroup

Method Summary


`optional pfcDimensions_ptr`	`CollectUDFDimensions ()`


`pfcFeature_ptr`	`GetGroupLeader ()`
	The group leader Feature

`optional xstring`	`GetGroupName ()`
	The name of the group.

`xbool`	`GetIsTableDriven ()`
	Reports whether the UDF is table-driven.

`optional pfcGroupPattern_ptr`	`GetPattern ()`
	The group pattern, if the group is a member of a pattern.

`xstring`	`GetUDFDimensionName (pfcDimension_ptr Dim)`


`optional xstring`	`GetUDFInstanceName ()`
	If the group is an instance of a UDF, this is the UDF instance name. Otherwise this will be NULL.

`optional xstring`	`GetUDFName ()`
	If the group represents a UDF, this is the UDF name. If the group is not a UDF, this will be NULL.

`pfcFeatures_ptr`	`ListMembers ()`
	Lists the members of a feature group.

`optional pfcUDFDimensions_ptr`	`ListUDFDimensions ()`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcFeatureGroup::CollectUDFDimensions` Lists the dimensions of a user defined feature group.

Method Detail

optional pfcGroupPattern_ptr 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

pfcFeature_ptr 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

optional xstring GetGroupName ()

The name of the group.

xbool GetIsTableDriven ()

Reports whether the UDF is table-driven.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The feature is not part of a UDF

pfcFeatures_ptr ListMembers ()

Lists the members of a feature group.

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

optional xstring 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

optional xstring 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

optional pfcUDFDimensions_ptr ListUDFDimensions ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcFeatureGroup::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.

optional pfcDimensions_ptr CollectUDFDimensions ()

Returns:

xstring GetUDFDimensionName (pfcDimension_ptr Dim)

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The group is not a UDF.

Parameters:

Dim

Returns: