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

Interface Feature

package com.ptc.pfc.pfcFeature; public interface Feature extends com.ptc.pfc.pfcModelItem.ModelItem

Description

This class defines a feature.

See Also:: Solid.GetFeatureById(int), Solid.GetFeatureByName(String), Solid.ListFeaturesByType(/*optional*/ Boolean, /*optional*/ FeatureType)

Direct Known Subclasses:: ComponentFeat, DatumAxisFeat, CurveFeat, CoordSysFeat, DatumPlaneFeat, RoundFeat, DatumPointFeat, WFeature

Method Summary
`DeleteOperation`	`CreateDeleteOp ()` Creates a feature delete operation.
`ReorderAfterOperation`	`CreateReorderAfterOp (Feature AfterFeat)` Creates an operation that will reorder the features after the specified feature.
`ReorderBeforeOperation`	`CreateReorderBeforeOp (Feature BeforeFeat)` Creates an operation that will reorder the features before the specified feature.
`ResumeOperation`	`CreateResumeOp ()` Creates a new resume operation object.
`SuppressOperation`	`CreateSuppressOp ()` Creates a new suppress operation object.
`String`	`GetFeatSubType ()` Get method for attribute "FeatSubType" The feature subtype, i.e. "Extrude" or "Revolve" for a protrusion.
`FeatureType`	`GetFeatType ()` Get method for attribute "FeatType" The feature type.
`String`	`GetFeatTypeName ()` Get method for attribute "FeatTypeName" The feature type expressed as a string.
`/optional/ FeatureGroup`	`GetGroup ()` Get method for attribute "Group" The group, if the feature is a member of a group. Otherwise this will be `null`.
`/optional/ FeatureGroup`	`GetGroupDirectHeader ()` Get method for attribute "GroupDirectHeader"
`/optional/ GroupPattern`	`GetGroupPattern ()` Get method for attribute "GroupPattern" The group pattern, if the feature is a member of a group pattern. Otherwise this will be `null`.
`GroupPatternStatus`	`GetGroupPatternStatus ()` Get method for attribute "GroupPatternStatus" The group pattern status.
`GroupStatus`	`GetGroupStatus ()` Get method for attribute "GroupStatus" The group status.
`boolean`	`GetIsEmbedded ()` Get method for attribute "IsEmbedded" A Boolean flag that specifies whether the feature is an embedded datum or not.
`boolean`	`GetIsGroupMember ()` Get method for attribute "IsGroupMember" Retrieves the group status of the specified feature.
`boolean`	`GetIsReadonly ()` Get method for attribute "IsReadonly" A Boolean flag that specifies whether the feature is read only
`boolean`	`GetIsVisible ()` Get method for attribute "IsVisible" A Boolean flag that specifies whether the feature is visible.
`/optional/ Integer`	`GetNumber ()` Get method for attribute "Number" The regeneration number of the feature. If the feature is suppressed or unregenerated, this will be `null`.
`/optional/ FeaturePattern`	`GetPattern ()` Get method for attribute "Pattern" 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/ FeaturePattern`	`GetPatternByType (PatternType Type)`
`PatternStatus`	`GetPatternStatus ()` Get method for attribute "PatternStatus" The pattern status.
`FeatureStatus`	`GetStatus ()` Get method for attribute "Status" The feature status.
`String`	`GetVersionStamp ()` Get method for attribute "VersionStamp" The version stamp
`Features`	`ListChildren ()` Lists the children of the feature.
`Features`	`ListParents ()` Lists the parents of the feature.
`/optional/ ModelItems`	`ListSubItems ( /optional/ ModelItemType Type)` Lists the component model items that make up the feature.

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Method Detail

GetFeatType

FeatureType GetFeatType ()

The feature type.

Manual References:: Features: Feature Information

GetFeatTypeName

String GetFeatTypeName ()

The feature type expressed as a string.

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

GetFeatSubType

String GetFeatSubType ()

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

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

GetStatus

FeatureStatus GetStatus ()

The feature status.

Manual References:: Features: Feature Information

GetGroup

/*optional*/ FeatureGroup 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

GetPattern

/*optional*/ FeaturePattern 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

GetGroupPattern

/*optional*/ GroupPattern GetGroupPattern ()

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

GetPatternByType

/*optional*/ FeaturePattern GetPatternByType (PatternType 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:

GetPatternStatus

PatternStatus 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

GetGroupStatus

GroupStatus 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

GetGroupPatternStatus

GroupPatternStatus 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

GetIsVisible

boolean 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

GetIsReadonly

boolean GetIsReadonly ()

A Boolean flag that specifies whether the feature is read only

Manual References:: Features: Feature Information

GetNumber

/*optional*/ Integer GetNumber ()

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

Manual References:: Features: Feature Information

GetVersionStamp

String GetVersionStamp ()

The version stamp

GetIsGroupMember

boolean GetIsGroupMember ()

Retrieves the group status of the specified feature.

GetIsEmbedded

boolean GetIsEmbedded ()

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

Manual References:: Features: Feature Information

CreateSuppressOp

SuppressOperation CreateSuppressOp ()

Creates a new suppress operation object.

The return value must be passed as a member of a FeatureOperations sequence to the method Solid.ExecuteFeatureOps(FeatureOperations, /*optional*/ RegenInstructions) .

Manual References:: Features: Feature Operations

Returns:: The new suppress operation object

CreateResumeOp

ResumeOperation CreateResumeOp ()

Creates a new resume operation object.

The return value must be passed as a member of a FeatureOperations sequence to the method Solid.ExecuteFeatureOps(FeatureOperations, /*optional*/ RegenInstructions) .

Manual References:: Features: Feature Operations

Returns:: The new resume operation object

CreateDeleteOp

DeleteOperation CreateDeleteOp ()

Creates a feature delete operation.

The return value must be passed as a member of a FeatureOperations sequence to the method Solid.ExecuteFeatureOps(FeatureOperations, /*optional*/ RegenInstructions) .

Manual References:: Features: Feature Operations

Returns:: The deletion operation

CreateReorderBeforeOp

ReorderBeforeOperation CreateReorderBeforeOp (Feature BeforeFeat)

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

The return value must be passed as a member of a FeatureOperations sequence to the method Solid.ExecuteFeatureOps(FeatureOperations, /*optional*/ RegenInstructions) .

Manual References:: Features: Feature Operations

Parameters:

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

Returns:: The new ReorderBeforeOperation object

CreateReorderAfterOp

ReorderAfterOperation CreateReorderAfterOp (Feature AfterFeat)

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

The return value must be passed as a member of a FeatureOperations sequence to the method Solid.ExecuteFeatureOps(FeatureOperations, /*optional*/ RegenInstructions) .

Manual References:: Features: Feature Operations

Parameters:

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

Returns:: The new ReorderAfterOperation object

ListChildren

Features 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.

ListParents

Features 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.

ListSubItems

/*optional*/ ModelItems ListSubItems ( /*optional*/ ModelItemType 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

GetGroupDirectHeader

/*optional*/ FeatureGroup GetGroupDirectHeader ()

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