CIP JAVA documentation for class "com.ptc.wfc.wfcAssembly.WExplodedState"

Interface WExplodedState

package com.ptc.wfc.wfcAssembly; public interface WExplodedState extends com.ptc.wfc.wfcModelItem.WModelItem, com.ptc.pfc.pfcAssembly.ExplodedState

Description

Represent Exploded state in Assembly

Method Summary
`WComponentPaths`	`GetExplodedcomponents ()` Gets the sequence of components of an explode state
`ExplodedAnimationMoveInstructions`	`GetExplodedStateMoves ()` Gets the moves of an explode state
`String`	`GetExplodedStateName ()` Returns the name of an explode state
`void`	`SetExplodedStateMoves (ExplodedAnimationMoveInstructions AnimMoveInstructions)` Sets the moves of an explode state
`void`	`SetExplodedStateName (String ExplodedStateName)` Sets the name of an explode state

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.pfc.pfcAssembly.ExplodedState`
`Activate`

Method Detail

GetExplodedStateName

String GetExplodedStateName ()

Returns the name of an explode state

Exceptions thrown (but not limited to):

XToolkitNotFound - explode state was not found.

Manual References:: Assemblies and Components: Accessing Exploded States, Assemblies and Components: Accessing Exploded States

Returns:: The name of the explode state.

SetExplodedStateName

void SetExplodedStateName (String ExplodedStateName)

Sets the name of an explode state

Exceptions thrown (but not limited to):

XToolkitNotFound - explode state was not found.

Manual References:: Assemblies and Components: Accessing Exploded States, Assemblies and Components: Accessing Exploded States

Parameters:

ExplodedStateName: The name of the explode state. Cannot be NULL.

Returns:

GetExplodedStateMoves

ExplodedAnimationMoveInstructions GetExplodedStateMoves ()

Gets the moves of an explode state

Exceptions thrown (but not limited to):

XToolkitNotFound - The explode state was not found.

Manual References:: Assemblies and Components: Accessing Exploded States, Assemblies and Components: Accessing Exploded States

Returns:: Returns sequence of ExplodedAnimationMoveInstruction

SetExplodedStateMoves

void SetExplodedStateMoves (ExplodedAnimationMoveInstructions AnimMoveInstructions)

Sets the moves of an explode state

Exceptions thrown (but not limited to):

XToolkitNotFound - The explode state was not found, or some ProAsmcomppath in comp_set for some moves do not correspond to any component (this error may be also returned for other non-specified cases).

Manual References:: Assemblies and Components: Accessing Exploded States, Assemblies and Components: Accessing Exploded States

Parameters:

AnimMoveInstructions: Array of ExplodedAnimationMoveInstruction

Returns:

GetExplodedcomponents

WComponentPaths GetExplodedcomponents ()

Gets the sequence of components of an explode state

Manual References:: Assemblies and Components: Accessing Exploded States, Assemblies and Components: Accessing Exploded States

Returns:: Array of WComponentPath