Interface WAssembly
package com.ptc.wfc.wfcAssembly;
public interface WAssembly
extends com.ptc.wfc.wfcSolid.WSolid,
com.ptc.pfc.pfcAssembly.Assembly
Description
User Guide References:
Visit Methods:WAssembly, Assembling Components:WAssembly, Accessing Exploded States:WAssembly, Manipulating Exploded States:WAssembly, Expanding Light Weight Graphics Simplified Representations:WAssembly
Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WParameterOwner :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WRelationOwner :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItemOwner :
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 :
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.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 :
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.pfc.pfcAssembly.Assembly :
GetIsExploded, GetDynamicPositioning, SetDynamicPositioning, Explode, UnExplode, GetDefaultExplodedState, GetActiveExplodedState, AssembleComponent, AssembleByCopy, AssembleSkeleton, AssembleSkeletonByCopy, GetSkeleton, DeleteSkeleton, GetMassPropertyByCompPath
Method Summary
void | |
Performs the automatic replacement of assembly member(s). | |
Create an 'assembly item' for defining flexible components | |
CreateExplodedState (String Name, /*optional*/ ExplodedAnimationMoveInstructions AnimMoveInstructions) | |
Creates an explode state | |
void | |
Deletes an explode state | |
void | |
Expands the light weight graphics representation to the specified level. | |
Gets the Connectors in the Assembly. | |
GetExplodeStateFromId (int ExplodedStateId) | |
Gets the exploded state having given ID | |
GetExplodeStateFromName (String ExplodedStateName) | |
Gets the exploded state having given name | |
GetHarnesses () | |
Gets the Harnesses in the Assembly. | |
Gets the Linestocks in the Assembly. | |
GetSpools () | |
Gets the Spools in the Assembly. | |
Returns a list of components that satisfy the specified rule. | |
/*optional*/ WComponentPaths | |
Returns a list of all displayed components in the solid. | |
Enables the user to select an explode state | |
Visits components of an assembly |
Method Detail
Performs the automatic replacement of assembly member(s).
User Guide References:
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 | ||
GetConnectors | () |
Gets the Connectors in the Assembly.
User Guide References:
Returns:
List of connectors in the assembly.
GetHarnesses | ||
GetHarnesses | () |
Gets the Harnesses in the Assembly.
Exceptions thrown (but not limited to):
XToolkitNotFound - Harness not found in assembly.
User Guide References:
Returns:
List of harnesses in the assembly.
GetLinestocks | ||
GetLinestocks | () |
Gets the Linestocks in the Assembly.
Exceptions thrown (but not limited to):
XToolkitNotFound - No linestock found.
User Guide References:
Returns:
List of linestocks in the assembly.
GetSpools | ||
GetSpools | () |
Gets the Spools in the Assembly.
Exceptions thrown (but not limited to):
XToolkitNotFound - No spool found.
User Guide References:
Returns:
List of spools in the assembly.
CreateAssemblyItem | ||
CreateAssemblyItem |
Create an 'assembly item' for defining flexible components
User Guide References:
Parameters:
AsmItemInstrs
Returns:
The Assembly Item.
ExpandLightweightGraphicsSimprep | ||
void | ExpandLightweightGraphicsSimprep |
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.
User Guide References:
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 | ||
ListComponentsByAssemblyRule |
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.
User Guide References:
Returns:
List of components.
SelectExplodedState | ||
SelectExplodedState | () |
Enables the user to select an explode state
User Guide References:
Returns:
Exploded State
GetExplodeStateFromName | ||
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.
User Guide References:
Parameters:
ExplodedStateName
The name of the specified explode state in the solid
Returns:
Exploded State
GetExplodeStateFromId | ||
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.
User Guide References:
Parameters:
ExplodedStateId
The identifier of the explode state
Returns:
Exploded State
CreateExplodedState | ||
CreateExplodedState |
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).
User Guide References:
Parameters:
Name
The name of the state. Cannot be NULL
AnimMoveInstructions
Array of ExplodedAnimationMoveInstruction
Returns:
Exploded State
DeleteExplodedState | ||
void | DeleteExplodedState |
Deletes an explode state
Exceptions thrown (but not limited to):
XToolkitNotFound - explode state was not found.
User Guide References:
Parameters:
ExplodedState
The explode state to delete. Cannot be NULL
Returns:
VisitComponents | ||
VisitComponents |
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>
User Guide References:
Parameters:
visitingClient
The visiting client implemented by the application.
Returns:
Visit status