Interface ComponentFeat
package com.ptc.pfc.pfcComponentFeat;
public interface ComponentFeat
extends com.ptc.pfc.pfcFeature.Feature
Description
Specifies a component feature.
Direct Known Subclasses:
User Guide References:
Visit Methods:ComponentFeat, Run-Time Type Identification in Creo Object TOOLKIT Java:ComponentFeat, Structure of Assemblies and Assembly Objects:ComponentFeat, Assembly Components:ComponentFeat, Regenerating an Assembly Component:ComponentFeat, Assembling Components:ComponentFeat, Constraint Attributes:ComponentFeat, Assembling a Component Parametrically:ComponentFeat, Redefining and Rerouting Assembly Components:ComponentFeat, Flexible Components and Inheritance Features in an Assembly:ComponentFeat, Variant Items for Flexible Components:ComponentFeat, Creo Object TOOLKIT Java Classes:ComponentFeat
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItem :
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 Summary
void | |
Copies the specified template model in to the component. | |
Creates a replacement operation. | |
/*cipOptional*/ ComponentType | GetCompType () |
Get method for attribute "CompType" The component type, which identifies the purpose for which the component is used in a production assembly. | |
/*cipOptional*/ ComponentConstraints | |
Returns a sequence of objects representing the component constraints. | |
/*cipOptional*/ ComponentConstraints | |
Returns a sequence of objects representing the component constraints. | |
boolean | |
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 | |
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 | |
Get method for attribute "IsSubstitute" true if the component is a substitution in a simplified rep,false otherwise. | |
boolean | |
Get method for attribute "IsUnderconstrained" true if the component is partially constrained,false if it is fully packaged or fully constrained. | |
Get method for attribute "ModelDescr" The model descriptor of the component part or subassembly | |
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 | |
Invokes the Creo Parametric UI to Package/Move the component. | |
void | |
Invokes the Creo Parametric dialog box to redefine the component constraints. | |
void | Regenerate () |
Regenerates the assembly component. | |
void | |
Set method for attribute "CompType" The component type, which identifies the purpose for which the component is used in a production assembly. | |
void | SetConstraints ( /*cipOptional*/ ComponentConstraints Constraints, /*cipOptional*/ 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 | |
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. |
Method Detail
GetModelDescr | ||
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.
User Guide References:
CreateReplaceOp | ||
CreateReplaceOp |
Creates a replacement operation.
User Guide References:
Parameters:
NewModel
The new model
Returns:
The new CompModelReplace object
GetIsBulkitem | ||
boolean | GetIsBulkitem | () |
true if the component is a bulkitem, false otherwise.
User Guide References:
CopyTemplateContents | ||
void | CopyTemplateContents |
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.
User Guide References:
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.
User Guide References:
GetCompType | ||
/*cipOptional*/ ComponentType | GetCompType | () |
SetCompType | ||
void | SetCompType |
The component type, which identifies the purpose for which the component is used in a production assembly.
User Guide References:
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.
User Guide References:
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.
User Guide References:
Returns:
GetIsPlaced | ||
boolean | GetIsPlaced | () |
SetIsPlaced | ||
void | SetIsPlaced | (boolean value) |
true if the component is placed in the assembly, false if it is unplaced.
User Guide References:
GetIsPackaged | ||
boolean | GetIsPackaged | () |
true if the component is completely packaged, false if it is partially or fully constrained.
User Guide References:
GetIsUnderconstrained | ||
boolean | GetIsUnderconstrained | () |
true if the component is partially constrained, false if it is fully packaged or fully constrained.
User Guide References:
GetIsFrozen | ||
boolean | GetIsFrozen | () |
true if the component is frozen due to missing references, false otherwise.
User Guide References:
GetConstraints | ||
/*cipOptional*/ 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.
User Guide References:
Returns:
Sequence of component constraints.
GetConstraintsWithCompPath | ||
/*cipOptional*/ ComponentConstraints | GetConstraintsWithCompPath |
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.
User Guide References:
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 | ( /*cipOptional*/ ComponentConstraints Constraints, /*cipOptional*/ 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.
User Guide References:
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.
User Guide References:
Returns:
GetPosition | ||
GetPosition | () | |
SetPosition | ||
void | SetPosition |
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 .
User Guide References: