CIP JAVA documentation for class "com.ptc.wfc.wfcComponentFeat.WComponentFeat"

Interface WComponentFeat

package com.ptc.wfc.wfcComponentFeat; public interface WComponentFeat extends com.ptc.wfc.wfcFeature.WFeature, com.ptc.pfc.pfcComponentFeat.ComponentFeat

Description

The interface WComponentFeat combines methods from both ComponentFeat and WFeature.

Method Summary
`Model`	`CreateFlexibleModel (WComponentPath FlexModelPath)` Creates a flexible model from the specified model of the flexible component.
`void`	`CreatePredefinedFlexibilityComponent (Model SourceModel, AssemblyItems AsmItems)` Convert the specified component to flexible one using the predefined flexibility varied items defined on its component model.
`boolean`	`IsFlexible ()` Determines whether the specified component is a flexible component.
`boolean`	`IsUnplaced ()` Determine if the specified component is unplaced.
`void`	`MakeUniqueSubAssembly (WComponentPath PathToSubAsm)` Make new instance of a sub-assembly, given its path.
`void`	`RemoveConstraint (int Index)` Removes a component constraint, given index of the constraint to remove.
`void`	`RemoveUniqueSubAssembly (WComponentPath PathToSubAsm)` Remove the run-time instance of a unique sub-assembly, given its path.
`void`	`SetAsFlexible (AssemblyItems 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 Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

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.wfc.wfcModelItem.WParameterOwner`
`ExportParameterTable`, `ApplyParameterTableset`, `MathcadParametersSet`, `MathcadInputParametersGet`

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

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WRelationOwner`
`GetRelationConstraints`, `UnitsUsed`, `UseUnits`, `EvaluateExpressionWithUnits`

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

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

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WModelItem`
`DeleteUserDefinedName`, `Unhide`, `Hide`, `IsHidden`, `IsNameReadOnly`, `IsZoneFeature`, `GetDefaultName`

Methods Inherited from Interface `com.ptc.wfc.wfcLayerState.LayerItem`
`IsLayerItemVisible`, `RemoveNoUpdate`, `GetLayers`, `AddNoUpdate`

Methods Inherited from Interface `com.ptc.pfc.pfcFeature.Feature`
`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 Interface com.ptc.pfc.pfcFeature.Feature

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 Interface `com.ptc.wfc.wfcFeature.WFeature`
`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 Interface com.ptc.wfc.wfcFeature.WFeature

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 Interface `com.ptc.pfc.pfcComponentFeat.ComponentFeat`
`GetModelDescr`, `CreateReplaceOp`, `GetIsBulkitem`, `CopyTemplateContents`, `GetIsSubstitute`, `GetCompType`, `SetCompType`, `RedefineThroughUI`, `MoveThroughUI`, `GetIsPlaced`, `SetIsPlaced`, `GetIsPackaged`, `GetIsUnderconstrained`, `GetIsFrozen`, `GetConstraints`, `GetConstraintsWithCompPath`, `SetConstraints`, `Regenerate`, `GetPosition`, `SetPosition`

Method Detail

RemoveConstraint

void RemoveConstraint (int Index)

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

Exceptions thrown (but not limited to):

XToolkitNotFound - 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:

IsUnplaced

boolean IsUnplaced ()

Determine if the specified component is unplaced.

Exceptions thrown (but not limited to):

XToolkitNotValid - Required license not found.

Manual References:: Assemblies and Components: Assembly Components

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

MakeUniqueSubAssembly

void MakeUniqueSubAssembly (WComponentPath 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:

RemoveUniqueSubAssembly

void RemoveUniqueSubAssembly (WComponentPath 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:

SetAsFlexible

void SetAsFlexible (AssemblyItems 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:

UnsetAsFlexible

void UnsetAsFlexible ()

Convert a flexible component to the regular one

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

Returns:

IsFlexible

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

CreateFlexibleModel

Model CreateFlexibleModel (WComponentPath 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

CreatePredefinedFlexibilityComponent

void CreatePredefinedFlexibilityComponent (Model SourceModel, AssemblyItems 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

Parameters:

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

Returns: