CIP Visual Basic.NET documentation for interface "IpfcFeature"

Interface IpfcFeature

Description

This class defines a feature.

See Also:: IpfcSolid.GetFeatureById(), IpfcSolid.GetFeatureByName(), IpfcSolid.ListFeaturesByType()

Direct Parent Classes:: IpfcModelItem

Direct Known Subclasses:: IpfcComponentFeat, IpfcDatumAxisFeat, IpfcCurveFeat, IpfcCoordSysFeat, IpfcDatumPlaneFeat, IpfcRoundFeat, IpfcDatumPointFeat

Property Summary


`Property`	`FeatSubType`	`as String`
	The feature subtype, i.e. "Extrude" or "Revolve" for a protrusion.

`Property`	`FeatType`	`as IpfcFeatureType`
	The feature type.

`Property`	`FeatTypeName`	`as String`
	The feature type expressed as a string.

`Property`	`Group`	`as IpfcFeatureGroup [readonly, optional]`
	The group, if the feature is a member of a group. Otherwise this will be `null`.

`Property`	`GroupDirectHeader`	`as IpfcFeatureGroup [readonly, optional]`


`Property`	`GroupPattern`	`as IpfcGroupPattern [readonly, optional]`
	The group pattern, if the feature is a member of a group pattern. Otherwise this will be `null`.

`Property`	`GroupPatternStatus`	`as IpfcGroupPatternStatus`
	The group pattern status.

`Property`	`GroupStatus`	`as IpfcGroupStatus`
	The group status.

`Property`	`IsEmbedded`	`as Boolean`
	A Boolean flag that specifies whether the feature is an embedded datum or not.

`Property`	`IsGroupMember`	`as Boolean`
	Retrieves the group status of the specified feature.

`Property`	`IsReadonly`	`as Boolean`
	A Boolean flag that specifies whether the feature is read only

`Property`	`IsVisible`	`as Boolean`
	A Boolean flag that specifies whether the feature is visible.

`Property`	`Number`	`as Long [readonly, optional]`
	The regeneration number of the feature. If the feature is suppressed or unregenerated, this will be `null`.

`Property`	`Pattern`	`as IpfcFeaturePattern [readonly, optional]`
	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.

`Property`	`PatternStatus`	`as IpfcPatternStatus`
	The pattern status.

`Property`	`Status`	`as IpfcFeatureStatus`
	The feature status.

`Property`	`VersionStamp`	`as String`
	The version stamp

Method Summary


`Function`	`CreateDeleteOp () as IpfcDeleteOperation`
	Creates a feature delete operation.

`Function`	`CreateReorderAfterOp (AfterFeat as IpfcFeature) as IpfcReorderAfterOperation`
	Creates an operation that will reorder the features after the specified feature.

`Function`	`CreateReorderBeforeOp (BeforeFeat as IpfcFeature) as IpfcReorderBeforeOperation`
	Creates an operation that will reorder the features before the specified feature.

`Function`	`CreateResumeOp () as IpfcResumeOperation`
	Creates a new resume operation object.

`Function`	`CreateSuppressOp () as IpfcSuppressOperation`
	Creates a new suppress operation object.

`Function`	`GetPatternByType (Type as IpfcPatternType) as IpfcFeaturePattern [optional]`


`Function`	`ListChildren () as IpfcFeatures`
	Lists the children of the feature.

`Function`	`ListParents () as IpfcFeatures`
	Lists the parents of the feature.

`Function`	`ListSubItems (Type as IpfcModelItemType [optional]) as IpfcModelItems [optional]`
	Lists the component model items that make up the feature.

Property Detail

Property FeatSubType as String

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

Property FeatType as IpfcFeatureType

The feature type.

Property FeatTypeName as String

The feature type expressed as a string.

Property Group as IpfcFeatureGroup [readonly, optional]

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

Property GroupDirectHeader as IpfcFeatureGroup [readonly, optional]

Property GroupPattern as IpfcGroupPattern [readonly, optional]

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

Property GroupPatternStatus as IpfcGroupPatternStatus

The group pattern status.

Property GroupStatus as IpfcGroupStatus

The group status.

Property IsEmbedded as Boolean

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

Property IsGroupMember as Boolean

Retrieves the group status of the specified feature.

Property IsReadonly as Boolean

A Boolean flag that specifies whether the feature is read only

Property IsVisible as Boolean

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.

Property Number as Long [readonly, optional]

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

Property Pattern as IpfcFeaturePattern [readonly, optional]

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.

Property PatternStatus as IpfcPatternStatus

The pattern status.

Property Status as IpfcFeatureStatus

The feature status.

Property VersionStamp as String

The version stamp

Method Detail

Function CreateDeleteOp () as IpfcDeleteOperation

Creates a feature delete operation.

The return value must be passed as a member of a IpfcFeatureOperations sequence to the method IpfcSolid.ExecuteFeatureOps() .

Returns:: The deletion operation

Function CreateReorderAfterOp (AfterFeat as IpfcFeature) as IpfcReorderAfterOperation

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

The return value must be passed as a member of a IpfcFeatureOperations sequence to the method IpfcSolid.ExecuteFeatureOps() .

Parameters:

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

Returns:: The new ReorderAfterOperation object

Function CreateReorderBeforeOp (BeforeFeat as IpfcFeature) as IpfcReorderBeforeOperation

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

The return value must be passed as a member of a IpfcFeatureOperations sequence to the method IpfcSolid.ExecuteFeatureOps() .

Parameters:

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

Returns:: The new ReorderBeforeOperation object

Function CreateResumeOp () as IpfcResumeOperation

Creates a new resume operation object.

The return value must be passed as a member of a IpfcFeatureOperations sequence to the method IpfcSolid.ExecuteFeatureOps() .

Returns:: The new resume operation object

Function CreateSuppressOp () as IpfcSuppressOperation

Creates a new suppress operation object.

The return value must be passed as a member of a IpfcFeatureOperations sequence to the method IpfcSolid.ExecuteFeatureOps() .

Returns:: The new suppress operation object

Function GetPatternByType (Type as IpfcPatternType) as IpfcFeaturePattern [optional]

Parameters:

Type

Returns:

Function ListChildren () as IpfcFeatures

Lists the children of the feature.

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

Function ListParents () as IpfcFeatures

Lists the parents of the feature.

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

Function ListSubItems (Type as IpfcModelItemType [optional]) as IpfcModelItems [optional]

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.

Parameters:

Type: The type of subitem you want to find

Returns:: The list of subitems of the specified type