API Documentation > Interfaces > Interface 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:
Direct Known Subclasses:
User Guide References:
Annotation Features and Annotations:Feature, Inheritance:Feature, Inheritance:Feature, Enumeration Classes:Feature, Example Code - Array Class:Feature, Visit Methods:Feature, Parent_Child_Relationships_Between_Creo_Object_TOOLKIT_Java_Objects:Feature, Run-Time Type Identification in Creo Object TOOLKIT Java:Feature, Creo Notification Manager:Feature, Displaying Feature Parameters:Feature, Selection:Feature, Accessing Selection Data:Feature, Solid Operations:Feature, Solid Body Information:Feature, Overview of Annotation Features:Feature, Creating Annotation Features:Feature, Redefining Annotation Features:Feature, Accessing and Modifying Annotation Elements:Feature, ModelItem:Feature, Getting ModelItem Objects:Feature, ModelItem Information:Feature, Feature Element Tree:Feature, Building Features Using Element Trees:Feature, Feature Element Values:Feature, Feature Element Special Values:Feature, Feature Element Paths:Feature, Feature Element Tree:Feature, Creating FET Using WCreateFeature:Feature, Feature Elements:Feature, Creating Patterns:Feature, Redefining Features:Feature, Features:Feature, Access to Features:Feature, Feature Information:Feature, Feature Inquiry:Feature, Feature Operations:Feature, Feature Groups and Patterns:Feature, Changes To Feature Groups:Feature, User Defined Features:Feature, Read Access to Groups and User Defined Features:Feature, Creating Features from UDFs:Feature, Setting the Variable Dimensions and Parameters:Feature, Datum Features:Feature, Datum Axis Features:Feature, General Datum Point Features:Feature, Datum Coordinate System Features:Feature, Creating and Modifying Cross Sections:Feature, Creating External Object References:Feature, Overview:Feature, To Create and Save a Section Model:Feature, Retrieving a Section:Feature, Element Trees: Sketched Features:Feature, Creating Features Containing Sections:Feature, To Create Sketched Features Element Trees:Feature, Creating Features with 2D Sections:Feature, Creating Features with 3D Sections:Feature, Holes:Feature, Dimension Information:Feature, Structure of Assemblies and Assembly Objects:Feature, Assembly Components:Feature, Assembling Components:Feature, Flexible Components and Inheritance Features in an Assembly:Feature, Variant Feature Model:Feature, Variant Items for Flexible Components:Feature, Gathering Components by Zone:Feature, Accessing Columns:Feature, Creating Family Table Columns:Feature, Action Sources:Feature, Solid Level Action Listeners:Feature, Feature Level Action Listeners:Feature, Cancelling an ActionListener Operation:Feature, Import Feature Properties:Feature, Import Feature Attributes:Feature, Redefining the Import Feature:Feature, Associative Topology Bus Enabled Models and Features:Feature, Creating Import Features from Files:Feature, Creo Object TOOLKIT Java Classes:Feature
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItem :
Method Summary
Creates a feature delete operation.
Creates an operation that will reorder the features after the specified feature.
Creates an operation that will reorder the features before the specified feature.
Creates a new resume operation object.
Creates a new suppress operation object.
String
Get method for attribute "FeatSubType"
The feature subtype, i.e. "Extrude" or "Revolve" for a protrusion.
Get method for attribute "FeatType"
The feature type.
String
Get method for attribute "FeatTypeName"
The feature type expressed as a string.
/*cipOptional*/ FeatureGroup
Get method for attribute "Group"
The group, if the feature is a member of a group. Otherwise this will benull.
/*cipOptional*/ FeatureGroup
Get method for attribute "GroupDirectHeader"
/*cipOptional*/ GroupPattern
Get method for attribute "GroupPattern"
The group pattern, if the feature is a member of a group pattern. Otherwise this will benull.
Get method for attribute "GroupPatternStatus"
The group pattern status.
Get method for attribute "GroupStatus"
The group status.
boolean
Get method for attribute "IsEmbedded"
A Boolean flag that specifies whether the feature is an embedded datum or not.
boolean
Get method for attribute "IsGroupMember"
Retrieves the group status of the specified feature.
boolean
Get method for attribute "IsReadonly"
A Boolean flag that specifies whether the feature is read only
boolean
Get method for attribute "IsVisible"
A Boolean flag that specifies whether the feature is visible.
/*cipOptional*/ Integer
Get method for attribute "Number"
The regeneration number of the feature. If the feature is suppressed or unregenerated, this will benull.
/*cipOptional*/ FeaturePattern
Get method for attribute "Pattern"
The pattern, if the feature is a member of a pattern. Otherwise this will benull. This function should only be used for simple patttern and use GetPatternByType function for nested pattern.
/*cipOptional*/ FeaturePattern
Get method for attribute "PatternStatus"
The pattern status.
Get method for attribute "Status"
The feature status.
String
Get method for attribute "VersionStamp"
The version stamp
Lists the children of the feature.
Lists the parents of the feature.
/*cipOptional*/ ModelItems
ListSubItems ( /*cipOptional*/ ModelItemType Type)
Lists the component model items that make up the feature.
Method Detail
GetFeatType
GetFeatType
()
The feature type.
User Guide References:
GetFeatTypeName
String
GetFeatTypeName
()
The feature type expressed as a string.
User Guide References:
GetFeatSubType
String
GetFeatSubType
()
The feature subtype, i.e. "Extrude" or "Revolve" for a protrusion.
User Guide References:
GetStatus
GetStatus
()
The feature status.
User Guide References:
GetGroup
/*cipOptional*/ FeatureGroup
GetGroup
()
The group, if the feature is a member of a group. Otherwise this will be null.
User Guide References:
GetPattern
/*cipOptional*/ 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.
User Guide References:
GetGroupPattern
/*cipOptional*/ GroupPattern
GetGroupPattern
()
The group pattern, if the feature is a member of a group pattern. Otherwise this will be null.
GetPatternByType
/*cipOptional*/ FeaturePattern
GetPatternByType
(PatternType Type)
User Guide References:
Parameters:
Type
Returns:
GetPatternStatus
GetPatternStatus
()
The pattern status.
User Guide References:
GetGroupStatus
GetGroupStatus
()
The group status.
User Guide References:
GetGroupPatternStatus
GetGroupPatternStatus
()
The group pattern status.
User Guide References:
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.
User Guide References:
GetIsReadonly
boolean
GetIsReadonly
()
A Boolean flag that specifies whether the feature is read only
User Guide References:
GetNumber
/*cipOptional*/ Integer
GetNumber
()
The regeneration number of the feature. If the feature is suppressed or unregenerated, this will be null.
User Guide References:
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.
User Guide References:
CreateSuppressOp
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, /*cipOptional*/ RegenInstructions) .
User Guide References:
Returns:
The new suppress operation object
CreateResumeOp
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, /*cipOptional*/ RegenInstructions) .
User Guide References:
Returns:
The new resume operation object
CreateDeleteOp
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, /*cipOptional*/ RegenInstructions) .
User Guide References:
Returns:
The deletion operation
CreateReorderBeforeOp
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, /*cipOptional*/ RegenInstructions) .
User Guide References:
Parameters:
BeforeFeat
The feature before which you want to reorder the features
Returns:
The new ReorderBeforeOperation object
CreateReorderAfterOp
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, /*cipOptional*/ RegenInstructions) .
User Guide References:
Parameters:
AfterFeat
The feature after which you want to reorder the features
Returns:
The new ReorderAfterOperation object
ListChildren
ListChildren
()
Lists the children of the feature.
User Guide References:
Returns:
The list of first-generation children features.
ListParents
ListParents
()
Lists the parents of the feature.
User Guide References:
Returns:
The list of first-generation parents features.
ListSubItems
/*cipOptional*/ ModelItems
ListSubItems
( /*cipOptional*/ 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.
User Guide References:
Parameters:
Type
The type of subitem you want to find
Returns:
The list of subitems of the specified type
GetGroupDirectHeader
/*cipOptional*/ FeatureGroup
GetGroupDirectHeader
()
User Guide References:
Was this helpful?