CIP C++ documentation for class "pfcFeature"

Class pfcFeature

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

Description

This class defines a feature.

See Also:: pfcSolid::GetFeatureById(xint), pfcSolid::GetFeatureByName(xrstring), pfcSolid::ListFeaturesByType(optional xbool, optional pfcFeatureType)

Direct Known Subclasses:: pfcComponentFeat, pfcDatumAxisFeat, pfcCurveFeat, pfcCoordSysFeat, pfcDatumPlaneFeat, pfcRoundFeat, pfcDatumPointFeat, wfcWFeature

Method Summary


`pfcDeleteOperation_ptr`	`CreateDeleteOp ()`
	Creates a feature delete operation.

`pfcReorderAfterOperation_ptr`	`CreateReorderAfterOp (pfcFeature_ptr AfterFeat)`
	Creates an operation that will reorder the features after the specified feature.

`pfcReorderBeforeOperation_ptr`	`CreateReorderBeforeOp (pfcFeature_ptr BeforeFeat)`
	Creates an operation that will reorder the features before the specified feature.

`pfcResumeOperation_ptr`	`CreateResumeOp ()`
	Creates a new resume operation object.

`pfcSuppressOperation_ptr`	`CreateSuppressOp ()`
	Creates a new suppress operation object.

`xstring`	`GetFeatSubType ()`
	The feature subtype, i.e. "Extrude" or "Revolve" for a protrusion.

`pfcFeatureType`	`GetFeatType ()`
	The feature type.

`xstring`	`GetFeatTypeName ()`
	The feature type expressed as a string.

`optional pfcFeatureGroup_ptr`	`GetGroup ()`
	The group, if the feature is a member of a group. Otherwise this will be `null`.

`optional pfcFeatureGroup_ptr`	`GetGroupDirectHeader ()`


`optional pfcGroupPattern_ptr`	`GetGroupPattern ()`
	The group pattern, if the feature is a member of a group pattern. Otherwise this will be `null`.

`pfcGroupPatternStatus`	`GetGroupPatternStatus ()`
	The group pattern status.

`pfcGroupStatus`	`GetGroupStatus ()`
	The group status.

`xbool`	`GetIsEmbedded ()`
	A Boolean flag that specifies whether the feature is an embedded datum or not.

`xbool`	`GetIsGroupMember ()`
	Retrieves the group status of the specified feature.

`xbool`	`GetIsReadonly ()`
	A Boolean flag that specifies whether the feature is read only

`xbool`	`GetIsVisible ()`
	A Boolean flag that specifies whether the feature is visible.

`optional xint`	`GetNumber ()`
	The regeneration number of the feature. If the feature is suppressed or unregenerated, this will be `null`.

`optional pfcFeaturePattern_ptr`	`GetPattern ()`
	The pattern, if the feature is a member of a pattern. Otherwise this will be `null`. This function should only be used for simple patttern and use GetPatternByType function for nested pattern.

`optional pfcFeaturePattern_ptr`	`GetPatternByType (pfcPatternType Type)`


`pfcPatternStatus`	`GetPatternStatus ()`
	The pattern status.

`pfcFeatureStatus`	`GetStatus ()`
	The feature status.

`xstring`	`GetVersionStamp ()`
	The version stamp

`pfcFeatures_ptr`	`ListChildren ()`
	Lists the children of the feature.

`pfcFeatures_ptr`	`ListParents ()`
	Lists the parents of the feature.

`optional pfcModelItems_ptr`	`ListSubItems (optional pfcModelItemType Type)`
	Lists the component model items that make up the feature.

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Method Detail

pfcFeatureType GetFeatType ()

The feature type.

Manual References:: Features: Feature Information, Features: Feature Information

xstring GetFeatTypeName ()

The feature type expressed as a string.

Manual References:: Features: Feature Information, Features: Feature Information

xstring GetFeatSubType ()

The feature subtype, i.e. "Extrude" or "Revolve" for a protrusion.

Manual References:: Features: Feature Information, Features: Feature Information

pfcFeatureStatus GetStatus ()

The feature status.

Manual References:: Features: Feature Information, Features: Feature Information

optional pfcFeatureGroup_ptr GetGroup ()

The group, if the feature is a member of a group. Otherwise this will be null.

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

optional pfcFeaturePattern_ptr GetPattern ()

The pattern, if the feature is a member of a pattern. Otherwise this will be null. This function should only be used for simple patttern and use GetPatternByType function for nested pattern.

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

optional pfcGroupPattern_ptr GetGroupPattern ()

The group pattern, if the feature is a member of a group pattern. Otherwise this will be null.

optional pfcFeaturePattern_ptr GetPatternByType (pfcPatternType Type)

Manual References:: Features: Feature Groups and Patterns, Features: Feature Groups and Patterns, Technical Summary of Changes for Creo 11.0.2.0: Features

Parameters:

Type

Returns:

pfcPatternStatus GetPatternStatus ()

The pattern status.

Manual References:: Features: Feature Groups and Patterns, Features: Feature Groups and Patterns, Technical Summary of Changes for Creo 11.0.2.0: Features

pfcGroupStatus GetGroupStatus ()

The group status.

Manual References:: Features: Feature Groups and Patterns, Features: Feature Groups and Patterns, Technical Summary of Changes for Creo 11.0.2.0: Features

pfcGroupPatternStatus GetGroupPatternStatus ()

The group pattern status.

Manual References:: Features: Feature Groups and Patterns, Features: Feature Groups and Patterns, Technical Summary of Changes for Creo 11.0.2.0: Features

xbool GetIsVisible ()

A Boolean flag that specifies whether the feature is visible.

This flag distinguishes visible features from internal features. Internal features are invisible features used for construction purposes.

Manual References:: Features: Feature Information, Features: Feature Information

xbool GetIsReadonly ()

A Boolean flag that specifies whether the feature is read only

Manual References:: Features: Feature Information, Features: Feature Information

optional xint GetNumber ()

The regeneration number of the feature. If the feature is suppressed or unregenerated, this will be null.

Manual References:: Features: Feature Information, Features: Feature Information, Overview of Creo Object TOOLKIT C++: Creo-Related Interfaces

xstring GetVersionStamp ()

The version stamp

xbool GetIsGroupMember ()

Retrieves the group status of the specified feature.

xbool GetIsEmbedded ()

A Boolean flag that specifies whether the feature is an embedded datum or not.

Manual References:: Features: Feature Information, Features: Feature Information

pfcSuppressOperation_ptr CreateSuppressOp ()

Creates a new suppress operation object.

The return value must be passed as a member of a pfcFeatureOperations sequence to the method pfcSolid::ExecuteFeatureOps(pfcFeatureOperations_ptr, optional pfcRegenInstructions_ptr) .

Manual References:: Features: Feature Operations

Returns:: The new suppress operation object

pfcResumeOperation_ptr CreateResumeOp ()

Creates a new resume operation object.

The return value must be passed as a member of a pfcFeatureOperations sequence to the method pfcSolid::ExecuteFeatureOps(pfcFeatureOperations_ptr, optional pfcRegenInstructions_ptr) .

Manual References:: Features: Feature Operations

Returns:: The new resume operation object

pfcDeleteOperation_ptr CreateDeleteOp ()

Creates a feature delete operation.

The return value must be passed as a member of a pfcFeatureOperations sequence to the method pfcSolid::ExecuteFeatureOps(pfcFeatureOperations_ptr, optional pfcRegenInstructions_ptr) .

Manual References:: Features: Feature Operations

Returns:: The deletion operation

pfcReorderBeforeOperation_ptr CreateReorderBeforeOp (pfcFeature_ptr BeforeFeat)

Creates an operation that will reorder the features before the specified feature.

The return value must be passed as a member of a pfcFeatureOperations sequence to the method pfcSolid::ExecuteFeatureOps(pfcFeatureOperations_ptr, optional pfcRegenInstructions_ptr) .

Manual References:: Features: Feature Operations

Parameters:

BeforeFeat: The feature before which you want to reorder the features

Returns:: The new ReorderBeforeOperation object

pfcReorderAfterOperation_ptr CreateReorderAfterOp (pfcFeature_ptr AfterFeat)

Creates an operation that will reorder the features after the specified feature.

The return value must be passed as a member of a pfcFeatureOperations sequence to the method pfcSolid::ExecuteFeatureOps(pfcFeatureOperations_ptr, optional pfcRegenInstructions_ptr) .

Manual References:: Features: Feature Operations

Parameters:

AfterFeat: The feature after which you want to reorder the features

Returns:: The new ReorderAfterOperation object

pfcFeatures_ptr ListChildren ()

Lists the children of the feature.

Manual References:: Features: Access to Features, Features: Access to Features

Returns:: The list of first-generation children features.

pfcFeatures_ptr ListParents ()

Lists the parents of the feature.

Manual References:: Features: Access to Features, Features: Access to Features

Returns:: The list of first-generation parents features.

optional pfcModelItems_ptr ListSubItems (optional pfcModelItemType Type)

Lists the component model items that make up the feature.

Following are the subitems that can get listed with this method: ITEM_SURFACE, ITEM_EDGE, ITEM_QUILT, ITEM_CURVE, ITEM_POINT, ITEM_AXIS, ITEM_COORD_SYS and ITEM_DIMENSION.

Manual References:: ModelItem: Getting ModelItem Objects, ModelItem: Getting ModelItem Objects

Parameters:

Type: The type of subitem you want to find

Returns:: The list of subitems of the specified type

optional pfcFeatureGroup_ptr GetGroupDirectHeader ()

Manual References:: Features: Access to Features, Features: Access to Features