CIP C++ documentation for class "wfcWComponentFeat"

Class wfcWComponentFeat

# include <wfcComponentFeat.h> class wfcWComponentFeat : public virtual wfcWFeature, : public virtual pfcComponentFeat { xaideclare(wfcWComponentFeat) ... };

Description

The interface wfcWComponentFeat combines methods from both pfcComponentFeat and wfcWFeature.

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes, Overview of Creo Object TOOLKIT C++: Visit Methods

Method Summary


`pfcModel_ptr`	`CreateFlexibleModel (wfcWComponentPath_ptr FlexModelPath)`
	Creates a flexible model from the specified model of the flexible component.

`void`	`CreatePredefinedFlexibilityComponent (pfcModel_ptr SourceModel, wfcAssemblyItems_ptr AsmItems)`
	Convert the specified component to flexible one using the predefined flexibility varied items defined on its component model.

`xbool`	`IsFlexible ()`
	Determines whether the specified component is a flexible component.

`xbool`	`IsUnplaced ()`
	Determine if the specified component is unplaced.

`void`	`MakeUniqueSubAssembly (wfcWComponentPath_ptr PathToSubAsm)`
	Make new instance of a sub-assembly, given its path.

`void`	`RemoveConstraint (xint Index)`
	Removes a component constraint, given index of the constraint to remove.

`void`	`RemoveUniqueSubAssembly (wfcWComponentPath_ptr PathToSubAsm)`
	Remove the run-time instance of a unique sub-assembly, given its path.

`void`	`SetAsFlexible (wfcAssemblyItems_ptr AsmItems)`
	Convert the component to flexible one using the specified variant items

`void`	`UnsetAsFlexible ()`
	Convert a flexible component to the regular one

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

Methods Inherited from Class pfcParent:: GetChild

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

Methods Inherited from Class wfcWParameterOwner:: ExportParameterTable, ApplyParameterTableset

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

Methods Inherited from Class wfcWRelationOwner:: GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

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

Methods Inherited from Class wfcWModelItem:: DeleteUserDefinedName, Unhide, Hide, IsHidden, IsNameReadOnly, IsZoneFeature, GetDefaultName

Methods Inherited from Class wfcLayerItem:: IsLayerItemVisible, RemoveNoUpdate, GetLayers, AddNoUpdate

Methods Inherited from Class pfcFeature:: GetFeatType, GetFeatTypeName, GetFeatSubType, GetStatus, GetGroup, GetPattern, GetGroupPattern, GetPatternByType, GetPatternStatus, GetGroupStatus, GetGroupPatternStatus, GetIsVisible, GetIsReadonly, GetNumber, GetVersionStamp, GetIsGroupMember, GetIsEmbedded, CreateSuppressOp, CreateResumeOp, CreateDeleteOp, CreateReorderBeforeOp, CreateReorderAfterOp, ListChildren, ListParents, ListSubItems, GetGroupDirectHeader

Methods Inherited from Class wfcWFeature:: GetElementTree, IsElementVisible, IsElementIncomplete, GetStatusFlag, RedefineFeature, CreatePattern, GetDimensionId, GetSections, GetImportFeatureData, GetIdMap, GetItemIds, GetUserIds, RedefineImportFeature, GetZoneFeatureReferences, GetZoneXSectionGeometry, GetZoneFeaturePlaneData, GetSolid, IsCableCosmetic, GetExternalParents, VisitItems, IsInFooter, MoveToFooter, MoveFromFooter, ListVariedItems, ListVariedParameters

Methods Inherited from Class pfcComponentFeat:: GetModelDescr, CreateReplaceOp, GetIsBulkitem, CopyTemplateContents, GetIsSubstitute, GetCompType, SetCompType, RedefineThroughUI, MoveThroughUI, GetIsPlaced, SetIsPlaced, GetIsPackaged, GetIsUnderconstrained, GetIsFrozen, GetConstraints, GetConstraintsWithCompPath, SetConstraints, Regenerate, GetPosition, SetPosition

Method Detail

void RemoveConstraint (xint Index)

Removes a component constraint, given index of the constraint to remove.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified constraint does not exist.

Manual References:: Assemblies and Components: Assembling Components, Assemblies and Components: Assembling Components

Parameters:

Index: The index of the constraint to remove.

Returns:

xbool IsUnplaced ()

Determine if the specified component is unplaced.

Exceptions thrown (but not limited to):

pfcXToolkitNotValid - Required license not found.

Manual References:: Assemblies and Components: Assembly Components

Returns:: true if component is unplaced, false otherwise.

void MakeUniqueSubAssembly (wfcWComponentPath_ptr PathToSubAsm)

Make new instance of a sub-assembly, given its path.

Manual References:: Assemblies and Components: Assembly Components, Assemblies and Components: Assembly Components

Parameters:

PathToSubAsm: The path from the top level assembly to the specified unique sub-assembly.

Returns:

void RemoveUniqueSubAssembly (wfcWComponentPath_ptr PathToSubAsm)

Remove the run-time instance of a unique sub-assembly, given its path.

Manual References:: Assemblies and Components: Assembly Components, Assemblies and Components: Assembly Components

Parameters:

PathToSubAsm: The path from top level assembly to the unique sub-assembly which is to be removed.

Returns:

void SetAsFlexible (wfcAssemblyItems_ptr AsmItems)

Convert the component to flexible one using the specified variant items

Manual References:: Assemblies and Components: Flexible Components and Inheritance Features in an Assembly, Assemblies and Components: Flexible Components and Inheritance Features in an Assembly

Parameters:

AsmItems: The variant items.

Returns:

void UnsetAsFlexible ()

Convert a flexible component to the regular one

Manual References:: Assemblies and Components: Flexible Components and Inheritance Features in an Assembly

Returns:

xbool IsFlexible ()

Determines whether the specified component is a flexible component.

Manual References:: Assemblies and Components: Flexible Components and Inheritance Features in an Assembly, Assemblies and Components: Flexible Components and Inheritance Features in an Assembly

Returns:: true if component is flexible, false otherwise.

pfcModel_ptr CreateFlexibleModel (wfcWComponentPath_ptr FlexModelPath)

Creates a flexible model from the specified model of the flexible component.

Manual References:: Assemblies and Components: Flexible Components and Inheritance Features in an Assembly, Assemblies and Components: Flexible Components and Inheritance Features in an Assembly

Parameters:

FlexModelPath: Relative path to flexible model from the top model of the flexible component

Returns:: The created flexible model

void CreatePredefinedFlexibilityComponent (pfcModel_ptr SourceModel, wfcAssemblyItems_ptr AsmItems)

Convert the specified component to flexible one using the predefined flexibility varied items defined on its component model.

Manual References:: Assemblies and Components: Flexible Components and Inheritance Features in an Assembly, Assemblies and Components: Flexible Components and Inheritance Features in an Assembly

Parameters:

SourceModel
AsmItems: Variant items to be added as predefined flexibility for the specified model. Path of varied items should start from 'SourceModel'.

Returns: