CIP JavaScript documentation for class " pfcComponentFeat"

Class pfcComponentFeat

Description

Specifies a component feature.

Direct Parent Classes:: pfcFeature

Property Summary


`/* optional */ pfcComponentType`	`CompType`
	The component type, which identifies the purpose for which the component is used in a production assembly.

`/* readonly */ boolean`	`IsBulkitem`
	`true` if the component is a bulkitem, `false` otherwise.

`/* readonly */ boolean`	`IsFrozen`
	`true` if the component is frozen due to missing references, `false` otherwise.

`/* readonly */ boolean`	`IsPackaged`
	`true` if the component is completely packaged, `false` if it is partially or fully constrained.

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

`/* readonly */ boolean`	`IsSubstitute`
	`true` if the component is a substitution in a simplified rep, `false` otherwise.

`/* readonly */ boolean`	`IsUnderconstrained`
	`true` if the component is partially constrained, `false` if it is fully packaged or fully constrained.

`/* readonly */ pfcModelDescriptor`	`ModelDescr`
	The model descriptor of the component part or subassembly

`pfcTransform3D`	`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.

Method Summary


`void`	`CopyTemplateContents (pfcModel TemplateModel)`
	Copies the specified template model in to the component.

`pfcCompModelReplace`	`CreateReplaceOp (pfcModel NewModel)`
	Creates a replacement operation.

`/* optional */ pfcComponentConstraints`	`GetConstraints ()`
	Returns a sequence of objects representing the component constraints.

`/* optional */ pfcComponentConstraints`	`GetConstraintsWithCompPath ( /* optional */ pfcComponentPath CompPath)`
	Returns a sequence of objects representing the component constraints.

`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`	`SetConstraints ( /* optional / pfcComponentConstraints Constraints, / optional */ pfcComponentPath ReferenceAssembly)`
	Sets the component constraints for the component feature.

Property Detail

/* optional */ pfcComponentType CompType

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

/* readonly */ boolean IsBulkitem

true if the component is a bulkitem, false otherwise.

/* readonly */ boolean IsFrozen

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

/* readonly */ boolean IsPackaged

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

boolean IsPlaced

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

/* readonly */ boolean IsSubstitute

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

/* readonly */ boolean IsUnderconstrained

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

/* readonly */ pfcModelDescriptor ModelDescr

The model descriptor of the component part or subassembly

Exceptions thrown (but not limited to):

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

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

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

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

Method Detail

void CopyTemplateContents (pfcModel TemplateModel)

Copies the specified template model in to the component.

Exceptions thrown (but not limited to):

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

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

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

pfcXToolkitNotValid - Required license not found.

Parameters:

TemplateModel: The template model to copy into the component.

pfcCompModelReplace CreateReplaceOp (pfcModel NewModel)

Creates a replacement operation.

Parameters:

NewModel: The new model

Returns:: The new CompModelReplace object

/* optional */ pfcComponentConstraints GetConstraints ()

Returns a sequence of objects representing the component constraints.

Exceptions thrown (but not limited to):

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

pfcXToolkitNotFound - The assembly component does not have any constraints.

Returns:: Sequence of component constraints.

/* optional */ pfcComponentConstraints GetConstraintsWithCompPath ( /* optional */ pfcComponentPath CompPath)

Returns a sequence of objects representing the component constraints.

Exceptions thrown (but not limited to):

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

pfcXToolkitNotFound - The assembly component does not have any constraints.

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.

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

pfcXToolkitUserAbort - The package move was aborted by the user.

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

pfcXToolkitUserAbort - The user aborted component redefinition.

void Regenerate ()

Regenerates the assembly component.

void SetConstraints ( /* optional */ pfcComponentConstraints Constraints, /* optional */ pfcComponentPath ReferenceAssembly)

Sets the component constraints for the component feature.

Exceptions thrown (but not limited to):

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

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

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.