CIP C++ documentation for class "wfcWAssembly"

Class wfcWAssembly

# include <wfcAssembly.h> class wfcWAssembly : public virtual wfcWSolid, : public virtual pfcAssembly { xaideclare(wfcWAssembly) ... };

Description

The interface wfcWAssembly combines methods from both pfcAssembly and wfcWSolid.

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Method Summary


`void`	`AutoInterchange (xintsequence_ptr ComponentIDs, wfcWSolid_ptr ReplacementModel)`
	Performs the automatic replacement of assembly member(s).

`wfcAssemblyItem_ptr`	`CreateAssemblyItem (wfcAssemblyItemInstructions_ptr AsmItemInstrs)`
	Create an 'assembly item' for defining flexible components

`wfcWExplodedState_ptr`	`CreateExplodedState (xrstring Name, optional wfcExplodedAnimationMoveInstructions_ptr AnimMoveInstructions)`
	Creates an explode state

`void`	`DeleteExplodedState (wfcWExplodedState_ptr ExplodedState)`
	Deletes an explode state

`void`	`ExpandLightweightGraphicsSimprep (pfcSelection_ptr TreeItem, wfcLightweightGraphicsSimprepLevel LWG_Level)`
	Expands the light weight graphics representation to the specified level.

`wfcConnectors_ptr`	`GetConnectors ()`
	Gets the Connectors in the Assembly.

`wfcWExplodedState_ptr`	`GetExplodeStateFromId (xint ExplodedStateId)`
	Gets the exploded state having given ID

`wfcWExplodedState_ptr`	`GetExplodeStateFromName (xrstring ExplodedStateName)`
	Gets the exploded state having given name

`wfcHarnesses_ptr`	`GetHarnesses ()`
	Gets the Harnesses in the Assembly.

`wfcLineStocks_ptr`	`GetLinestocks ()`
	Gets the Linestocks in the Assembly.

`wfcSpools_ptr`	`GetSpools ()`
	Gets the Spools in the Assembly.

`wfcWComponentPaths_ptr`	`ListComponentsByAssemblyRule (wfcAssemblyRule_ptr AsmRule)`
	Returns a list of components that satisfy the specified rule.

`optional wfcWComponentPaths_ptr`	`ListDisplayedComponents ()`
	This method is enabled for Creo Direct. Returns a list of all displayed components in the solid.

`wfcWExplodedState_ptr`	`SelectExplodedState ()`
	Enables the user to select an explode state

`wfcStatus`	`VisitComponents (wfcVisitingClient_ptr visitingClient)`
	This method is enabled for Creo Direct. Visits components of an assembly

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener

Methods Inherited from Class pfcParent:: GetChild

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

Methods Inherited from Class wfcWParameterOwner:: ExportParameterTable, ApplyParameterTableset

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

Methods Inherited from Class wfcWRelationOwner:: GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Class pfcModelItemOwner:: GetItemByName, GetItemById, ListItems

Methods Inherited from Class pfcViewOwner:: RetrieveView, GetView, SaveView, GetCurrentViewTransform, SetCurrentViewTransform, CurrentViewRotate, ListViews, GetCurrentView

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcModel:: 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, ListDependencies, ListDeclaredModels, CreateLayer, Export, Import, AccessExternalData, TerminateExternalData, CheckIsSaveAllowed, CheckIsModifiable, GetOrigin, GetPostRegenerationRelations, SetPostRegenerationRelations, RegeneratePostRegenerationRelations, DeletePostRegenerationRelations, CleanupDependencies, IsNativeModel, ExportIntf3D

Methods Inherited from Class wfcWModel:: VerifyATB, MarkATBModelAsOutOfDate, UpdateATB, RelinkATB, GetTIMInfo, ConvertOldXSectionsToNew, CanCreateSectionFeature, ListLayers, SaveLayerDisplayStatus, GetLayerItem, GetSubType, GetDefaultName, IsVariantFeatModel, CreateUnitByExpression, ComputeRayIntersections, CollectParamTablesets, GenerateSelectionsFromCollection, MarkForSaving, RefreshMdlTree, GetMdlfileDescriptor, IsStandardLocation, DesignateSymbol, UndesignateSymbol, IsDesignatedSymbol, VisitItems, VisitDetailItems, CreateSurfaceFinish, MatchLayerRules, CopyLayerRules, ExecuteLayerRules

Methods Inherited from Class pfcFamilyMember:: 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 Class wfcWFamilyMember:: SelectRows, GetFamilyTableStatus, IsModifiable, EditFamilyTable, EraseFamilyTable, ShowFamilyTable

Methods Inherited from Class pfcSolid:: 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, ListGroups, CreateFeature, CreateUDFGroup, ExportShrinkwrap, GetPrincipalUnits, SetPrincipalUnits, ListUnits, ListUnitSystems, GetUnit, CreateCustomUnit, CreateUnitSystem

Methods Inherited from Class wfcWSolid:: GetIsNoResolveMode, WRegenerate, ListChildOfFailedFeatures, ListChildOfExternalFailedFeatures, GetSolidFeatureStatusFlags, WCreateFeature, DeleteFeatures, SuppressFeatures, ResumeFeatures, ReorderFeatures, ImportAsFeat, QuickPrint, CollectCurves, CollectSurfaces, CreatePlanarXSection, ListDetailItems, UpdateActiveLayerState, CreateParallelXSection, ListCombStates, GetActiveCombState, ActivateCombState, CreateCombState, DeleteCombState, 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

Methods Inherited from Class pfcAssembly:: GetIsExploded, GetDynamicPositioning, SetDynamicPositioning, Explode, UnExplode, GetDefaultExplodedState, GetActiveExplodedState, AssembleComponent, AssembleByCopy, AssembleSkeleton, AssembleSkeletonByCopy, GetSkeleton, DeleteSkeleton

Method Detail

void AutoInterchange (xintsequence_ptr ComponentIDs, wfcWSolid_ptr 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:

wfcConnectors_ptr 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.

wfcHarnesses_ptr GetHarnesses ()

Gets the Harnesses in the Assembly.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - Harness not found in assembly.

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

Returns:: List of harnesses in the assembly.

wfcLineStocks_ptr GetLinestocks ()

Gets the Linestocks in the Assembly.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No linestock found.

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

Returns:: List of linestocks in the assembly.

wfcSpools_ptr GetSpools ()

Gets the Spools in the Assembly.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No spool found.

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

Returns:: List of spools in the assembly.

wfcAssemblyItem_ptr CreateAssemblyItem (wfcAssemblyItemInstructions_ptr 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.

void ExpandLightweightGraphicsSimprep (pfcSelection_ptr TreeItem, wfcLightweightGraphicsSimprepLevel LWG_Level)

Expands the light weight graphics representation to the specified level.

Exceptions thrown (but not limited to):

pfcXToolkitFound - The expand already exists till the selected level.

Manual References:: Simplified Representations: Expanding LightWeight Graphics Simplified Representations, Technical Summary of Changes for Creo 4.0 F000: Simplified Representation

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:

wfcWComponentPaths_ptr ListComponentsByAssemblyRule (wfcAssemblyRule_ptr AsmRule)

Returns a list of components that satisfy the specified rule.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidItem - The Rule is invalid.

Manual References:: Assemblies and Components: Listing Components By Rule

Parameters:

AsmRule: The rule to evaluate.

Returns:: List of components.

optional wfcWComponentPaths_ptr ListDisplayedComponents ()

This method is enabled for Creo Direct.

Returns a list of all displayed components in the solid.

Manual References:: Assemblies and Components: Assembling Components, Technical Summary of Changes for Creo 4.0 F000: Assemblies

Returns:: List of components.

wfcWExplodedState_ptr SelectExplodedState ()

Enables the user to select an explode state

Manual References:: Assemblies and Components: Accessing Exploded States, Assemblies and Components: Accessing Exploded States, Technical Summary of Changes for Creo 4.0 F000: Exploded States

Returns:: Exploded State

wfcWExplodedState_ptr GetExplodeStateFromName (xrstring ExplodedStateName)

Gets the exploded state having given name

Exceptions thrown (but not limited to):

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

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

pfcXToolkitInvalidPtr - p_solid is not a correct ProSolid pointer.

Manual References:: Assemblies and Components: Accessing Exploded States, Assemblies and Components: Accessing Exploded States, Technical Summary of Changes for Creo 4.0 F000: Exploded States

Parameters:

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

Returns:: Exploded State

wfcWExplodedState_ptr GetExplodeStateFromId (xint ExplodedStateId)

Gets the exploded state having given ID

Exceptions thrown (but not limited to):

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

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

pfcXToolkitInvalidPtr - p_solid is not a correct ProSolid pointer.

Manual References:: Assemblies and Components: Accessing Exploded States, Assemblies and Components: Accessing Exploded States, Technical Summary of Changes for Creo 4.0 F000: Exploded States

Parameters:

ExplodedStateId: The identifier of the explode state

Returns:: Exploded State

wfcWExplodedState_ptr CreateExplodedState (xrstring Name, optional wfcExplodedAnimationMoveInstructions_ptr AnimMoveInstructions)

Creates an explode state

Exceptions thrown (but not limited to):

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

pfcXToolkitNotFound - 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, Technical Summary of Changes for Creo 4.0 F000: Exploded States

Parameters:

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

Returns:: Exploded State

void DeleteExplodedState (wfcWExplodedState_ptr ExplodedState)

Deletes an explode state

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - explode state was not found.

Manual References:: Assemblies and Components: Manipulating Exploded States, Technical Summary of Changes for Creo 4.0 F000: Exploded States

Parameters:

ExplodedState: The explode state to delete. Cannot be NULL

Returns:

wfcStatus VisitComponents (wfcVisitingClient_ptr visitingClient)

This method is enabled for Creo Direct.

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

Visit status The visiting client implemented by the application.

Exceptions thrown (but not limited to):

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

<reference 4 to unknown entity pfcExceptions::pfcXInAMethod>

Manual References:: Overview of Creo Object TOOLKIT C++: Visit Methods, Overview of Creo Object TOOLKIT C++: Visit Methods, Technical Summary of Changes for Creo 4.0 F000: Visit Methods

Parameters:

visitingClient

Returns: