CIP Visual Basic.NET documentation for interface "IpfcFeatureGroup"

Interface IpfcFeatureGroup

Description

This class describes a feature group.

Direct Parent Classes:: IpfcObject

Property Summary


`Property`	`GroupLeader`	`as IpfcFeature`
	The group leader Feature

`Property`	`GroupName`	`as String [readonly, optional]`
	The name of the group.

`Property`	`IsTableDriven`	`as Boolean`
	Reports whether the UDF is table-driven.

`Property`	`Pattern`	`as IpfcGroupPattern [readonly, optional]`
	The group pattern, if the group is a member of a pattern.

`Property`	`UDFInstanceName`	`as String [readonly, optional]`
	If the group is an instance of a UDF, this is the UDF instance name. Otherwise this will be NULL.

`Property`	`UDFName`	`as String [readonly, optional]`
	If the group represents a UDF, this is the UDF name. If the group is not a UDF, this will be NULL.

Method Summary


`Function`	`CollectUDFDimensions () as IpfcDimensions [optional]`


`Function`	`GetUDFDimensionName (Dim as IpfcDimension) as String`


`Function`	`ListMembers () as IpfcFeatures`
	Lists the members of a feature group.

`Function`	`ListUDFDimensions () as IpfcUDFDimensions [optional]`

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

Property Detail

Property GroupLeader as IpfcFeature

The group leader Feature

Property GroupName as String [readonly, optional]

The name of the group.

Property IsTableDriven as Boolean

Reports whether the UDF is table-driven.

Exceptions thrown (but not limited to):

IpfcXToolkitBadContext - The feature is not part of a UDF

Property Pattern as IpfcGroupPattern [readonly, optional]

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

Property UDFInstanceName as String [readonly, optional]

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

Property UDFName as String [readonly, optional]

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

Method Detail

Function CollectUDFDimensions () as IpfcDimensions [optional]

Returns:

Function GetUDFDimensionName (Dim as IpfcDimension) as String

Exceptions thrown (but not limited to):

IpfcXToolkitBadContext - The group is not a UDF.

Parameters:

Dim

Returns:

Function ListMembers () as IpfcFeatures

Lists the members of a feature group.

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

Function ListUDFDimensions () as IpfcUDFDimensions [optional]

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.

Returns:: Sequence of UDF Dimensions.