CIP C++ documentation for class "pfcComponentFeat"

Class pfcComponentFeat

# include <pfcComponentFeat.h> class pfcComponentFeat : public virtual pfcFeature { xaideclare(pfcComponentFeat) ... };

Description

Specifies a component feature.

Direct Known Subclasses:: wfcWComponentFeat

Method Summary


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

`pfcCompModelReplace_ptr`	`CreateReplaceOp (pfcModel_ptr NewModel)`
	Creates a replacement operation.

`optional pfcComponentType`	`GetCompType ()`
`void`	`SetCompType (optional pfcComponentType value)`
	The component type, which identifies the purpose for which the component is used in a production assembly.

`optional pfcComponentConstraints_ptr`	`GetConstraints ()`
	Returns a sequence of objects representing the component constraints.

`optional pfcComponentConstraints_ptr`	`GetConstraintsWithCompPath (optional pfcComponentPath_ptr CompPath)`
	Returns a sequence of objects representing the component constraints.

`xbool`	`GetIsBulkitem ()`
	`true` if the component is a bulkitem, `false` otherwise.

`xbool`	`GetIsFrozen ()`
	`true` if the component is frozen due to missing references, `false` otherwise.

`xbool`	`GetIsPackaged ()`
	`true` if the component is completely packaged, `false` if it is partially or fully constrained.

`xbool`	`GetIsPlaced ()`
`void`	`SetIsPlaced (xbool value)`
	`true` if the component is placed in the assembly, `false` if it is unplaced.

`xbool`	`GetIsSubstitute ()`
	`true` if the component is a substitution in a simplified rep, `false` otherwise.

`xbool`	`GetIsUnderconstrained ()`
	`true` if the component is partially constrained, `false` if it is fully packaged or fully constrained.

`pfcModelDescriptor_ptr`	`GetModelDescr ()`
	The model descriptor of the component part or subassembly

`pfcTransform3D_ptr`	`GetPosition ()`
`void`	`SetPosition (pfcTransform3D_ptr 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.

`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_ptr Constraints, optional pfcComponentPath_ptr ReferenceAssembly)`
	Sets the component constraints for the component feature.

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

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

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

Methods Inherited from Class pfcParent:: GetChild

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

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

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

Method Detail

pfcModelDescriptor_ptr GetModelDescr ()

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.

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

pfcCompModelReplace_ptr CreateReplaceOp (pfcModel_ptr 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

xbool GetIsBulkitem ()

true if the component is a bulkitem, false otherwise.

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

void CopyTemplateContents (pfcModel_ptr 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.

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

Parameters:

TemplateModel: The template model to copy into the component.

Returns:

xbool 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

`optional pfcComponentType`	`GetCompType`	`()`
`void`	`SetCompType`	`(optional pfcComponentType 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

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.

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

Returns:

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.

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

Returns:

`xbool`	`GetIsPlaced`	`()`
`void`	`SetIsPlaced`	`(xbool 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

xbool 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

xbool 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

xbool 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

optional pfcComponentConstraints_ptr 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.

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

Returns:: Sequence of component constraints.

optional pfcComponentConstraints_ptr GetConstraintsWithCompPath (optional pfcComponentPath_ptr 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.

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.

void SetConstraints (optional pfcComponentConstraints_ptr Constraints, optional pfcComponentPath_ptr 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.

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:

void Regenerate ()

Regenerates the assembly component.

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

Returns:

`pfcTransform3D_ptr`	`GetPosition`	`()`
`void`	`SetPosition`	`(pfcTransform3D_ptr 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):

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

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