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

Interface WAssembly

package com.ptc.wfc.wfcAssembly; public interface WAssembly extends com.ptc.wfc.wfcSolid.WSolid, com.ptc.pfc.pfcAssembly.Assembly

Description

The interface WAssembly combines methods from both Assembly and WSolid.

Method Summary
`void`	`AutoInterchange (intseq ComponentIDs, WSolid ReplacementModel)` Performs the automatic replacement of assembly member(s).
`AssemblyItem`	`CreateAssemblyItem (AssemblyItemInstructions AsmItemInstrs)` Create an 'assembly item' for defining flexible components
`WExplodedState`	`CreateExplodedState (String Name, /optional/ ExplodedAnimationMoveInstructions AnimMoveInstructions)` Creates an explode state
`void`	`DeleteExplodedState (WExplodedState ExplodedState)` Deletes an explode state
`void`	`ExpandLightweightGraphicsSimprep (Selection TreeItem, LightweightGraphicsSimprepLevel LWG_Level)` Expands the light weight graphics representation to the specified level.
`Connectors`	`GetConnectors ()` Gets the Connectors in the Assembly.
`WExplodedState`	`GetExplodeStateFromId (int ExplodedStateId)` Gets the exploded state having given ID
`WExplodedState`	`GetExplodeStateFromName (String ExplodedStateName)` Gets the exploded state having given name
`Harnesses`	`GetHarnesses ()` Gets the Harnesses in the Assembly.
`LineStocks`	`GetLinestocks ()` Gets the Linestocks in the Assembly.
`Spools`	`GetSpools ()` Gets the Spools in the Assembly.
`WComponentPaths`	`ListComponentsByAssemblyRule (AssemblyRule AsmRule)` Returns a list of components that satisfy the specified rule.
`/optional/ WComponentPaths`	`ListDisplayedComponents ()` Returns a list of all displayed components in the solid.
`WExplodedState`	`SelectExplodedState ()` Enables the user to select an explode state
`Status`	`VisitComponents (VisitingClient visitingClient)` Visits components of an assembly

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.pfcModelItem.ModelItemOwner`
`GetItemByName`, `GetItemById`, `ListItems`

Methods Inherited from Interface `com.ptc.pfc.pfcView.ViewOwner`
`RetrieveView`, `GetView`, `SaveView`, `GetCurrentViewTransform`, `SetCurrentViewTransform`, `CurrentViewRotate`, `ListViews`, `GetCurrentView`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcModel.Model`
`GetDescr`, `GetRelationId`, `GetIsModified`, `GetVersionStamp`, `GetRevision`, `GetVersion`, `GetBranch`, `GetReleaseLevel`, `GetCommonName`, `SetCommonName`, `IsCommonNameModifiable`, `GetFullName`, `GetInstanceName`, `GetGenericName`, `GetType`, `GetFileName`, `Backup`, `Copy`, `CopyAndRetrieve`, `Rename`, `Save`, `Erase`, `EraseWithDependencies`, `Delete`, `Display`, `DisplayInNewWindow`, `ListDependencies`, `ListDeclaredModels`, `CreateLayer`, `Export`, `Import`, `AccessExternalData`, `TerminateExternalData`, `CheckIsSaveAllowed`, `CheckIsModifiable`, `GetOrigin`, `GetPostRegenerationRelations`, `SetPostRegenerationRelations`, `RegeneratePostRegenerationRelations`, `DeletePostRegenerationRelations`, `CleanupDependencies`, `IsNativeModel`, `ExportIntf3D`, `SetIntf3DLayerSetupFile`, `IsIntf3DLayerSetupFileIgnored`, `IsIntf3DCsysIgnored`, `ClearIntf3DModelData`

Methods Inherited from Interface com.ptc.pfc.pfcModel.Model

GetDescr, GetRelationId, GetIsModified, GetVersionStamp, GetRevision, GetVersion, GetBranch, GetReleaseLevel, GetCommonName, SetCommonName, IsCommonNameModifiable, GetFullName, GetInstanceName, GetGenericName, GetType, GetFileName, Backup, Copy, CopyAndRetrieve, Rename, Save, Erase, EraseWithDependencies, Delete, Display, DisplayInNewWindow, ListDependencies, ListDeclaredModels, CreateLayer, Export, Import, AccessExternalData, TerminateExternalData, CheckIsSaveAllowed, CheckIsModifiable, GetOrigin, GetPostRegenerationRelations, SetPostRegenerationRelations, RegeneratePostRegenerationRelations, DeletePostRegenerationRelations, CleanupDependencies, IsNativeModel, ExportIntf3D, SetIntf3DLayerSetupFile, IsIntf3DLayerSetupFileIgnored, IsIntf3DCsysIgnored, ClearIntf3DModelData

Methods Inherited from Interface `com.ptc.wfc.wfcModel.WModel`
`VerifyATB`, `MarkATBModelAsOutOfDate`, `UpdateATB`, `RelinkATB`, `GetAnnotationPlanesFromGallery`, `GetAnnotationPlanes`, `GetAnnotationPlaneByName`, `AddAnnotationPlaneToGallery`, `RemoveAnnotationPlaneFromGallery`, `GetActiveAnnotationPlane`, `GetTIMInfo`, `ConvertOldXSectionsToNew`, `CanCreateSectionFeature`, `ListLayers`, `SaveLayerDisplayStatus`, `GetLayerItem`, `GetSubType`, `GetDefaultName`, `IsVariantFeatModel`, `CreateUnitByExpression`, `ComputeRayIntersections`, `CollectParamTablesets`, `GenerateSelectionsFromCollection`, `MarkForSaving`, `RefreshMdlTree`, `GetMdlfileDescriptor`, `IsStandardLocation`, `DesignateSymbol`, `UndesignateSymbol`, `IsDesignatedSymbol`, `VisitItems`, `VisitDetailItems`, `CreateSurfaceFinish`, `CreateGTol`, `CreateSetDatumTag`, `MatchLayerRules`, `CopyLayerRules`, `ExecuteLayerRules`

Methods Inherited from Interface com.ptc.wfc.wfcModel.WModel

VerifyATB, MarkATBModelAsOutOfDate, UpdateATB, RelinkATB, GetAnnotationPlanesFromGallery, GetAnnotationPlanes, GetAnnotationPlaneByName, AddAnnotationPlaneToGallery, RemoveAnnotationPlaneFromGallery, GetActiveAnnotationPlane, GetTIMInfo, ConvertOldXSectionsToNew, CanCreateSectionFeature, ListLayers, SaveLayerDisplayStatus, GetLayerItem, GetSubType, GetDefaultName, IsVariantFeatModel, CreateUnitByExpression, ComputeRayIntersections, CollectParamTablesets, GenerateSelectionsFromCollection, MarkForSaving, RefreshMdlTree, GetMdlfileDescriptor, IsStandardLocation, DesignateSymbol, UndesignateSymbol, IsDesignatedSymbol, VisitItems, VisitDetailItems, CreateSurfaceFinish, CreateGTol, CreateSetDatumTag, MatchLayerRules, CopyLayerRules, ExecuteLayerRules

Methods Inherited from Interface `com.ptc.pfc.pfcFamily.FamilyMember`
`GetParent`, `GetImmediateGenericInfo`, `GetTopGenericInfo`, `ListColumns`, `ListRows`, `GetCell`, `SetCell`, `GetCellIsDefault`, `AddRow`, `GetRow`, `RemoveRow`, `AddColumn`, `RemoveColumn`, `GetColumn`, `CreateColumn`, `CreateParamColumn`, `CreateDimensionColumn`, `CreateFeatureColumn`, `CreateComponentColumn`, `CreateCompModelColumn`, `CreateGroupColumn`, `CreateMergePartColumn`, `CreateTolPlusColumn`, `CreateTolMinusColumn`, `CreateTolPlusMinusColumn`

Methods Inherited from Interface com.ptc.pfc.pfcFamily.FamilyMember

GetParent, GetImmediateGenericInfo, GetTopGenericInfo, ListColumns, ListRows, GetCell, SetCell, GetCellIsDefault, AddRow, GetRow, RemoveRow, AddColumn, RemoveColumn, GetColumn, CreateColumn, CreateParamColumn, CreateDimensionColumn, CreateFeatureColumn, CreateComponentColumn, CreateCompModelColumn, CreateGroupColumn, CreateMergePartColumn, CreateTolPlusColumn, CreateTolMinusColumn, CreateTolPlusMinusColumn

Methods Inherited from Interface `com.ptc.wfc.wfcFamily.WFamilyMember`
`SelectRows`, `GetFamilyTableStatus`, `IsModifiable`, `EditFamilyTable`, `EraseFamilyTable`, `ShowFamilyTable`

Methods Inherited from Interface `com.ptc.pfc.pfcSolid.Solid`
`GetDefaultBody`, `GetSurfaceSolidBody`, `GetEdgeSolidBody`, `GetGeomOutline`, `GetRelativeAccuracy`, `SetRelativeAccuracy`, `GetAbsoluteAccuracy`, `SetAbsoluteAccuracy`, `Regenerate`, `ExecuteFeatureOps`, `EvalOutline`, `CreateLocalGroup`, `CreateNote`, `ListFailedFeatures`, `ListFeaturesByType`, `ListCrossSections`, `GetCrossSection`, `GetIsSkeleton`, `HasRetrievalErrors`, `GetFeatureByName`, `GetFeatureById`, `CreateImportFeat`, `ActivateSimpRep`, `GetActiveSimpRep`, `CreateSimpRep`, `SelectSimpRep`, `GetSimpRep`, `GetMasterRep`, `GetGraphicsRep`, `GetGeomRep`, `DeleteSimpRep`, `GetMassProperty`, `GetMassPropertyWithDensity`, `ListGroups`, `CreateFeature`, `CreateUDFGroup`, `ExportShrinkwrap`, `GetPrincipalUnits`, `SetPrincipalUnits`, `ListUnits`, `ListUnitSystems`, `GetUnit`, `CreateCustomUnit`, `CreateUnitSystem`

Methods Inherited from Interface com.ptc.pfc.pfcSolid.Solid

GetDefaultBody, GetSurfaceSolidBody, GetEdgeSolidBody, GetGeomOutline, GetRelativeAccuracy, SetRelativeAccuracy, GetAbsoluteAccuracy, SetAbsoluteAccuracy, Regenerate, ExecuteFeatureOps, EvalOutline, CreateLocalGroup, CreateNote, ListFailedFeatures, ListFeaturesByType, ListCrossSections, GetCrossSection, GetIsSkeleton, HasRetrievalErrors, GetFeatureByName, GetFeatureById, CreateImportFeat, ActivateSimpRep, GetActiveSimpRep, CreateSimpRep, SelectSimpRep, GetSimpRep, GetMasterRep, GetGraphicsRep, GetGeomRep, DeleteSimpRep, GetMassProperty, GetMassPropertyWithDensity, ListGroups, CreateFeature, CreateUDFGroup, ExportShrinkwrap, GetPrincipalUnits, SetPrincipalUnits, ListUnits, ListUnitSystems, GetUnit, CreateCustomUnit, CreateUnitSystem

Methods Inherited from Interface `com.ptc.wfc.wfcSolid.WSolid`
`CreateBody`, `DeleteBody`, `GetIsNoResolveMode`, `WRegenerate`, `ListChildOfFailedFeatures`, `ListChildOfExternalFailedFeatures`, `GetSolidFeatureStatusFlags`, `WCreateFeature`, `DeleteFeatures`, `SuppressFeatures`, `ResumeFeatures`, `ReorderFeatures`, `ImportAsFeat`, `QuickPrint`, `CollectCurves`, `CollectSurfaces`, `CreatePlanarXSection`, `CreatePlanarXSectionWithOptions`, `ListDetailItems`, `UpdateActiveLayerState`, `CreateParallelXSection`, `ListCombStates`, `GetActiveCombState`, `ActivateCombState`, `CreateCombState`, `DeleteCombState`, `GetAnnotationsOfActiveState`, `GetStyleStateFromName`, `GetStyleStateFromId`, `GetActiveStyleState`, `ActivateStyleState`, `ListStyleStateItems`, `ListLayerStates`, `CreateLayerState`, `GetActiveLayerState`, `GetTolerance`, `SetTolerance`, `LoadToleranceClass`, `GetModelClass`, `SetModelClass`, `CheckFamilyTable`, `DisplaySolid`, `GetDefaultTextHeight`, `FindShellsAndVoids`, `ProjectPoint`, `GetDisplayOutline`, `GetAxis`, `GetCurve`, `GetCsys`, `GetEdge`, `GetPoint`, `GetQuilt`, `CreateZoneSectionFeature`, `GetAllAppearancesAndTextures`, `CreateDimension`, `CreateRefDimension`, `RefreshDetailTree`, `ExpandDetailTree`, `CollapseDetailTree`, `CreateFlatToScreenPlane`, `CreateAnnotationPlaneFromView`, `CreateFreeNote`, `CreateOnItemNote`, `CreateLeaderNote`, `CreateLeaderWithArrowTypeNote`, `RetrieveSymbolDefItem`, `CreateAnnotationFeature`, `CreateSymbolDefinition`, `CreateSymbolInstance`, `CreateOrdinateDimension`, `Tessellate`, `CreateCustomFeature`, `ActivateAutomaticSimpRep`, `ConvertAutomaticSimpRep`

Methods Inherited from Interface com.ptc.wfc.wfcSolid.WSolid

CreateBody, DeleteBody, GetIsNoResolveMode, WRegenerate, ListChildOfFailedFeatures, ListChildOfExternalFailedFeatures, GetSolidFeatureStatusFlags, WCreateFeature, DeleteFeatures, SuppressFeatures, ResumeFeatures, ReorderFeatures, ImportAsFeat, QuickPrint, CollectCurves, CollectSurfaces, CreatePlanarXSection, CreatePlanarXSectionWithOptions, ListDetailItems, UpdateActiveLayerState, CreateParallelXSection, ListCombStates, GetActiveCombState, ActivateCombState, CreateCombState, DeleteCombState, GetAnnotationsOfActiveState, GetStyleStateFromName, GetStyleStateFromId, GetActiveStyleState, ActivateStyleState, ListStyleStateItems, ListLayerStates, CreateLayerState, GetActiveLayerState, GetTolerance, SetTolerance, LoadToleranceClass, GetModelClass, SetModelClass, CheckFamilyTable, DisplaySolid, GetDefaultTextHeight, FindShellsAndVoids, ProjectPoint, GetDisplayOutline, GetAxis, GetCurve, GetCsys, GetEdge, GetPoint, GetQuilt, CreateZoneSectionFeature, GetAllAppearancesAndTextures, CreateDimension, CreateRefDimension, RefreshDetailTree, ExpandDetailTree, CollapseDetailTree, CreateFlatToScreenPlane, CreateAnnotationPlaneFromView, CreateFreeNote, CreateOnItemNote, CreateLeaderNote, CreateLeaderWithArrowTypeNote, RetrieveSymbolDefItem, CreateAnnotationFeature, CreateSymbolDefinition, CreateSymbolInstance, CreateOrdinateDimension, Tessellate, CreateCustomFeature, ActivateAutomaticSimpRep, ConvertAutomaticSimpRep

Methods Inherited from Interface `com.ptc.pfc.pfcAssembly.Assembly`
`GetIsExploded`, `GetDynamicPositioning`, `SetDynamicPositioning`, `Explode`, `UnExplode`, `GetDefaultExplodedState`, `GetActiveExplodedState`, `AssembleComponent`, `AssembleByCopy`, `AssembleSkeleton`, `AssembleSkeletonByCopy`, `GetSkeleton`, `DeleteSkeleton`, `GetMassPropertyByCompPath`

Method Detail

AutoInterchange

void AutoInterchange (intseq ComponentIDs, WSolid ReplacementModel)

Performs the automatic replacement of assembly member(s).

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

Parameters:

ComponentIDs: The component identifiers from the node assembly that identifies the replaced members.
ReplacementModel: The replacement component. This can be a part or subassembly.

Returns:

GetConnectors

Connectors GetConnectors ()

Gets the Connectors in the Assembly.

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

Returns:: List of connectors in the assembly.

GetHarnesses

Harnesses GetHarnesses ()

Gets the Harnesses in the Assembly.

Exceptions thrown (but not limited to):

XToolkitNotFound - Harness not found in assembly.

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

Returns:: List of harnesses in the assembly.

GetLinestocks

LineStocks GetLinestocks ()

Gets the Linestocks in the Assembly.

Exceptions thrown (but not limited to):

XToolkitNotFound - No linestock found.

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

Returns:: List of linestocks in the assembly.

GetSpools

Spools GetSpools ()

Gets the Spools in the Assembly.

Exceptions thrown (but not limited to):

XToolkitNotFound - No spool found.

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

Returns:: List of spools in the assembly.

CreateAssemblyItem

AssemblyItem CreateAssemblyItem (AssemblyItemInstructions AsmItemInstrs)

Create an 'assembly item' for defining flexible components

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

Parameters:

AsmItemInstrs

Returns:: The Assembly Item.

ExpandLightweightGraphicsSimprep

void ExpandLightweightGraphicsSimprep (Selection TreeItem, LightweightGraphicsSimprepLevel LWG_Level)

Expands the light weight graphics representation to the specified level.

Exceptions thrown (but not limited to):

XToolkitFound - The expand already exists till the selected level.

Manual References:: Simplified Representations: Expanding Light Weight Graphics Simplified Representations

Parameters:

TreeItem: The model feature whose light weight graphic representation is to be expanded.
LWG_Level: The level up to which expand should take place.

Returns:

ListComponentsByAssemblyRule

WComponentPaths ListComponentsByAssemblyRule (AssemblyRule AsmRule)

Returns a list of components that satisfy the specified rule.

Exceptions thrown (but not limited to):

XToolkitInvalidItem - The Rule is invalid.

Parameters:

AsmRule: The rule to evaluate.

Returns:: List of components.

ListDisplayedComponents

/*optional*/ WComponentPaths ListDisplayedComponents ()

Returns a list of all displayed components in the solid.

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

Returns:: List of components.

SelectExplodedState

WExplodedState SelectExplodedState ()

Enables the user to select an explode state

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

Returns:: Exploded State

GetExplodeStateFromName

WExplodedState GetExplodeStateFromName (String ExplodedStateName)

Gets the exploded state having given name

Exceptions thrown (but not limited to):

XToolkitFound - The function found the explode state in the solid.

XToolkitNotFound - The function did not find the explode state in the solid.

XToolkitInvalidPtr - p_solid is not a correct ProSolid pointer.

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

Parameters:

ExplodedStateName: The name of the specified explode state in the solid

Returns:: Exploded State

GetExplodeStateFromId

WExplodedState GetExplodeStateFromId (int ExplodedStateId)

Gets the exploded state having given ID

Exceptions thrown (but not limited to):

XToolkitFound - The function found the explode state in the solid.

XToolkitNotFound - The function did not find the explode state in the solid.

XToolkitInvalidPtr - p_solid is not a correct ProSolid pointer.

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

Parameters:

ExplodedStateId: The identifier of the explode state

Returns:: Exploded State

CreateExplodedState

WExplodedState CreateExplodedState (String Name, /*optional*/ ExplodedAnimationMoveInstructions AnimMoveInstructions)

Creates an explode state

Exceptions thrown (but not limited to):

XToolkitInvalidName - The explode state with given name cannot be created (there is an explode state with such name; or name contains invalid characters)

XToolkitNotFound - 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: Manipulating Exploded States, Assemblies and Components: Manipulating Exploded States

Parameters:

Name: The name of the state. Cannot be NULL
AnimMoveInstructions: Array of ExplodedAnimationMoveInstruction

Returns:: Exploded State

DeleteExplodedState

void DeleteExplodedState (WExplodedState ExplodedState)

Deletes an explode state

Exceptions thrown (but not limited to):

XToolkitNotFound - explode state was not found.

Manual References:: Assemblies and Components: Manipulating Exploded States

Parameters:

ExplodedState: The explode state to delete. Cannot be NULL

Returns:

VisitComponents

Status VisitComponents (VisitingClient visitingClient)

Visits components of an assembly

If ApplyAction of the visiting client returns a value other than TK_NO_ERROR, this method returns.

If ApplyFilter returns TK_CONTINUE, the item is skipped (not passed to ApplyAction).

In C++ Object Toolkit, use wfcStatusToPro and wfcStatusFromPro to convert the returned status to ProError and back.

In ApplyAction & ApplyFilter of the visiting client, pfcObject pointer must be cast as wfcWComponentFeat.

Casting as other types may lead to unexpected behaviour

Exceptions thrown (but not limited to):

XToolkitNotFound - Either no features exist, or they were all filtered out by the filter function.

<reference 6 to unknown entity pfcExceptions::pfcXInAMethod>

Manual References:: Overview of Creo Object TOOLKIT Java: Visit Methods, Overview of Creo Object TOOLKIT Java: Visit Methods

Parameters:

visitingClient: The visiting client implemented by the application.

Returns:: Visit status