CIP JAVA documentation for class "com.ptc.pfc.pfcComponentFeat.ComponentFeat"

Interface ComponentFeat

package com.ptc.pfc.pfcComponentFeat; public interface ComponentFeat extends com.ptc.pfc.pfcFeature.Feature

Description

Specifies a component feature.

Direct Known Subclasses:: WComponentFeat

Method Summary
`void`	`CopyTemplateContents (Model TemplateModel)` Copies the specified template model in to the component.
`CompModelReplace`	`CreateReplaceOp (Model NewModel)` Creates a replacement operation.
`/optional/ ComponentType`	`GetCompType ()` Get method for attribute "CompType" The component type, which identifies the purpose for which the component is used in a production assembly.
`/optional/ ComponentConstraints`	`GetConstraints ()` Returns a sequence of objects representing the component constraints.
`/optional/ ComponentConstraints`	`GetConstraintsWithCompPath ( /optional/ ComponentPath CompPath)` Returns a sequence of objects representing the component constraints.
`boolean`	`GetIsBulkitem ()` Get method for attribute "IsBulkitem" `true` if the component is a bulkitem, `false` otherwise.
`boolean`	`GetIsFrozen ()` Get method for attribute "IsFrozen" `true` if the component is frozen due to missing references, `false` otherwise.
`boolean`	`GetIsPackaged ()` Get method for attribute "IsPackaged" `true` if the component is completely packaged, `false` if it is partially or fully constrained.
`boolean`	`GetIsPlaced ()` Get method for attribute "IsPlaced" `true` if the component is placed in the assembly, `false` if it is unplaced.
`boolean`	`GetIsSubstitute ()` Get method for attribute "IsSubstitute" `true` if the component is a substitution in a simplified rep, `false` otherwise.
`boolean`	`GetIsUnderconstrained ()` Get method for attribute "IsUnderconstrained" `true` if the component is partially constrained, `false` if it is fully packaged or fully constrained.
`ModelDescriptor`	`GetModelDescr ()` Get method for attribute "ModelDescr" The model descriptor of the component part or subassembly
`Transform3D`	`GetPosition ()` Get method for attribute "Position" The initial position and orientation of the component in the assembly. If the component is fully packaged, this is the actual position. If the component is underconstrained, the constraints will override part of this matrix. If the component is fully constrained, the entire matrix will be overridden.
`void`	`MoveThroughUI ()` Invokes the Creo Parametric UI to Package/Move the component.
`void`	`RedefineThroughUI ()` Invokes the Creo Parametric dialog box to redefine the component constraints.
`void`	`Regenerate ()` Regenerates the assembly component.
`void`	`SetCompType ( /optional/ ComponentType value)` Set method for attribute "CompType" The component type, which identifies the purpose for which the component is used in a production assembly.
`void`	`SetConstraints ( /optional/ ComponentConstraints Constraints, /optional/ ComponentPath ReferenceAssembly)` Sets the component constraints for the component feature.
`void`	`SetIsPlaced (boolean value)` Set method for attribute "IsPlaced" `true` if the component is placed in the assembly, `false` if it is unplaced.
`void`	`SetPosition (Transform3D value)` Set method for attribute "Position" The initial position and orientation of the component in the assembly. If the component is fully packaged, this is the actual position. If the component is underconstrained, the constraints will override part of this matrix. If the component is fully constrained, the entire matrix will be overridden.

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`

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

Method Detail

GetModelDescr

ModelDescriptor GetModelDescr ()

The model descriptor of the component part or subassembly

Exceptions thrown (but not limited to):

XToolkitNotFound - Assembly component model is not a solid or is not in memory.

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

CreateReplaceOp

CompModelReplace CreateReplaceOp (Model NewModel)

Creates a replacement operation.

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

Parameters:

NewModel: The new model

Returns:: The new CompModelReplace object

GetIsBulkitem

boolean GetIsBulkitem ()

true if the component is a bulkitem, false otherwise.

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

CopyTemplateContents

void CopyTemplateContents (Model TemplateModel)

Copies the specified template model in to the component.

Exceptions thrown (but not limited to):

XToolkitInvalidType - The template type does not correspond to the component type.

XToolkitFound - Features exist in a model of the component; copying the template to this model is not allowed.

XToolkitAbort - The model can not be used as a template or has external dependencies. Copy is aborted.

XToolkitNotValid - Required license not found.

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

Parameters:

TemplateModel: The template model to copy into the component.

Returns:

GetIsSubstitute

boolean GetIsSubstitute ()

true if the component is a substitution in a simplified rep, false otherwise.

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

GetCompType/SetCompType

`/optional/ ComponentType`	`GetCompType`	`()`
`void`	`SetCompType`	`( /optional/ ComponentType value)`

The component type, which identifies the purpose for which the component is used in a production assembly.

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

RedefineThroughUI

void RedefineThroughUI ()

Invokes the Creo Parametric dialog box to redefine the component constraints.

The assembly containing the component feature must be in the active window.

Exceptions thrown (but not limited to):

XToolkitUserAbort - The user aborted component redefinition.

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

Returns:

MoveThroughUI

void MoveThroughUI ()

Invokes the Creo Parametric UI to Package/Move the component.

The assembly containing the component must be in the active window.

Exceptions thrown (but not limited to):

XToolkitUserAbort - The package move was aborted by the user.

Manual References:: Assemblies and Components: Redefining and Rerouting Assembly Components

Returns:

GetIsPlaced/SetIsPlaced

`boolean`	`GetIsPlaced`	`()`
`void`	`SetIsPlaced`	`(boolean value)`

true if the component is placed in the assembly, false if it is unplaced.

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

GetIsPackaged

boolean GetIsPackaged ()

true if the component is completely packaged, false if it is partially or fully constrained.

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

GetIsUnderconstrained

boolean GetIsUnderconstrained ()

true if the component is partially constrained, false if it is fully packaged or fully constrained.

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

GetIsFrozen

boolean GetIsFrozen ()

true if the component is frozen due to missing references, false otherwise.

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

GetConstraints

/*optional*/ ComponentConstraints GetConstraints ()

Returns a sequence of objects representing the component constraints.

Exceptions thrown (but not limited to):

XToolkitInvalidType - The component argument is not a valid assembly component.

XToolkitNotFound - The assembly component does not have any constraints.

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

Returns:: Sequence of component constraints.

GetConstraintsWithCompPath

/*optional*/ ComponentConstraints GetConstraintsWithCompPath ( /*optional*/ ComponentPath CompPath)

Returns a sequence of objects representing the component constraints.

Exceptions thrown (but not limited to):

XToolkitInvalidType - The component argument is not a valid assembly component.

XToolkitNotFound - The assembly component does not have any constraints.

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

Parameters:

CompPath: The path from the top level assembly to the assembly owning the component feature, if the constraints are to contain external references. Pass null if the constraints will not contain external references.

Returns:: Sequence of component constraints.

SetConstraints

void SetConstraints ( /*optional*/ ComponentConstraints Constraints, /*optional*/ ComponentPath ReferenceAssembly)

Sets the component constraints for the component feature.

Exceptions thrown (but not limited to):

XToolkitInvalidType - The component argument is not a valid assembly component.

<reference 6 to unknown entity pfcExceptions::pfcXToolkitInvalidReference> - Assembly reference must have Assembly Component Path.

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

Parameters:

Constraints: Sequence of assembly component constraints.
ReferenceAssembly: The path from the top level assembly to the assembly owning the component feature, if the constraints are to contain external references. Pass null if the constraints will not contain external references.

Returns:

Regenerate

void Regenerate ()

Regenerates the assembly component.

Manual References:: Assemblies and Components: Assembly Components, Assemblies and Components: Regenerating an Assembly Component

Returns:

GetPosition/SetPosition

`Transform3D`	`GetPosition`	`()`
`void`	`SetPosition`	`(Transform3D value)`

The initial position and orientation of the component in the assembly. If the component is fully packaged, this is the actual position. If the component is underconstrained, the constraints will override part of this matrix. If the component is fully constrained, the entire matrix will be overridden.

This attribute can be set to move a packaged component. Regenerate to ensure that constraints are reapplied to the component after moving.

Exceptions thrown (but not limited to):

XToolkitNotFound - The input argument was of type - bulk item .

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