CIP C++ documentation for class "pfcAssembly"

Class pfcAssembly

# include <pfcAssembly.h> class pfcAssembly : public virtual pfcSolid { xaideclare(pfcAssembly) ... };

Description

This class describes an assembly.

Direct Known Subclasses:: wfcWAssembly

Method Summary


`pfcFeature_ptr`	`AssembleByCopy (xrstring NewModelName, pfcSolid_ptr ModelToCopy, xbool LeaveUnplaced)`
	Assembles a copy of a model into the assembly.

`pfcFeature_ptr`	`AssembleComponent (pfcSolid_ptr Model, optional pfcTransform3D_ptr Position)`
	Assembles the model into the assembly.

`void`	`AssembleSkeleton (pfcSolid_ptr SkeletonModel)`
	Adds a skeleton model in the assembly.

`void`	`AssembleSkeletonByCopy (xrstring NewSkeletonName, pfcSolid_ptr SkeletonToCopy)`
	Copies the specified template model into the assembly as a skeleton model.

`void`	`DeleteSkeleton ()`
	Deletes the skeleton model from the assembly.

`void`	`Explode ()`
	Explodes the specified assembly. The function invalidates the display list, but the application needs to repaint the window.

`optional pfcExplodedState_ptr`	`GetActiveExplodedState ()`
	Returns the current active exploded state in the assembly.

`pfcExplodedState_ptr`	`GetDefaultExplodedState ()`
	Returns the default exploded state in the assembly.

`xbool`	`GetDynamicPositioning ()`
`void`	`SetDynamicPositioning (xbool value)`
	If the assembly uses dynamic positioning, this attribute is `true`; otherwise, it is `false`

`xbool`	`GetIsExploded ()`
	If the assembly is exploded, this attribute is `true`; otherwise, it is`false`

`pfcMassProperty_ptr`	`GetMassPropertyByCompPath (optional pfcComponentPath_ptr CompPath, optional pfcModelItem_ptr CsysItem, optional pfcComponentPath_ptr CsysPath)`
	Calculates the mass properties of solid referenced by the specified coordinate system, using respective component paths.

`pfcSolid_ptr`	`GetSkeleton ()`
	Returns the skeleton model in the assembly.



`void`	`UnExplode ()`
	Unexplodes the assembly. The function invalidates the display list, but the application needs to repaint the window.

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 pfcParent:: GetChild

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 pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

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

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

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, 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 Class pfcSolid:: 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

Method Detail

xbool GetIsExploded ()

If the assembly is exploded, this attribute is true; otherwise, it isfalse

The exploded status of an assembly depends on the mode, in particular, while the drawing view is active, it does not represent the real explode state of the assembly, but the state of the assembly in the current drawing view.

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

`xbool`	`GetDynamicPositioning`	`()`
`void`	`SetDynamicPositioning`	`(xbool value)`

If the assembly uses dynamic positioning, this attribute is true; otherwise, it is false

void Explode ()

Explodes the specified assembly. The function invalidates the display list, but the application needs to repaint the window.

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - The specified assembly is already exploded.

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

Returns:

void UnExplode ()

Unexplodes the assembly. The function invalidates the display list, but the application needs to repaint the window.

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - The specified assembly is already unexploded.

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

Returns:

pfcExplodedState_ptr GetDefaultExplodedState ()

Returns the default exploded state in the assembly.

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

Returns:: The default exploded state.

optional pfcExplodedState_ptr GetActiveExplodedState ()

Returns the current active exploded state in the assembly.

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

Returns:: The active exploded state, or null, if the assembly is not exploded.

pfcFeature_ptr AssembleComponent (pfcSolid_ptr Model, optional pfcTransform3D_ptr Position)

Assembles the model into the assembly.

The new component will be packaged at the designated location.

Exceptions thrown (but not limited to):

pfcXToolkitUnsupported - Unsupported model. For instance, models which come from Multi-CAD model approach, are not supported in this release.

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

Parameters:

Model: The model to assemble.
Position: The initial position of the component.

Returns:: The new component feature object.

pfcFeature_ptr AssembleByCopy (xrstring NewModelName, pfcSolid_ptr ModelToCopy, xbool LeaveUnplaced)

Assembles a copy of a model into the assembly.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - Template type does not correspond to component type.

pfcXToolkitAbort - The model can not be used as a template or has external dependencies. Copy is aborted.

pfcXToolkitNotValid - Required license not found.

pfcXToolkitLineTooLong - comp_name length of the new component is more than 31 chars. This restriction will be removed in future releases.

pfcXToolkitUnsupported - Unsupported model. For instance, models which come from Multi-CAD model approach, are not supported in this release.

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

Parameters:

NewModelName: The name of the new copy of the model.
ModelToCopy: The template model to copy.
LeaveUnplaced: true to leave the component unplaced, false to place the component in the default location.

Returns:: The new assembly component feature object.

void AssembleSkeleton (pfcSolid_ptr SkeletonModel)

Adds a skeleton model in the assembly.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - Skeleton is a handle not to a skeleton model.

pfcXToolkitFound - Skeleton model already exists in the assembly.

pfcXToolkitNotValid - Required license not found.

Manual References:: Assemblies and Components: Skeleton Models, Assemblies and Components: Skeleton Models

Parameters:

SkeletonModel: The skeleton model.

Returns:

void AssembleSkeletonByCopy (xrstring NewSkeletonName, pfcSolid_ptr SkeletonToCopy)

Copies the specified template model into the assembly as a skeleton model.

Exceptions thrown (but not limited to):

pfcXToolkitFound - Skeleton model already exists in the assembly.

pfcXToolkitAbort - Template type is invalid (for example, is a manufacturing part), or has external external dependencies. Copying is aborted.

pfcXToolkitNotValid - Required license is absent.

pfcXToolkitUnsupported - Models which come from Multi-CAD approach are not supported as template model.

pfcXToolkitLineTooLong - Name length of skeleton model is more than 31 chars.

Manual References:: Assemblies and Components: Skeleton Models, Assemblies and Components: Skeleton Models

Parameters:

NewSkeletonName: The name of the new skeleton model.
SkeletonToCopy: The template model to copy.

Returns:

pfcSolid_ptr GetSkeleton ()

Returns the skeleton model in the assembly.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified assembly has no skeleton model.

pfcXToolkitCantAccess - The skeleton exists, but can not be used.

pfcXToolkitNotValid - Required license not found.

Manual References:: Assemblies and Components: Skeleton Models, Assemblies and Components: Skeleton Models

Returns:: The skeleton model.

void DeleteSkeleton ()

Deletes the skeleton model from the assembly.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified assembly has no skeleton model.

pfcXToolkitNotValid - Required license not found.

Manual References:: Assemblies and Components: Skeleton Models, Assemblies and Components: Skeleton Models

Returns:

pfcMassProperty_ptr GetMassPropertyByCompPath (optional pfcComponentPath_ptr CompPath, optional pfcModelItem_ptr CsysItem, optional pfcComponentPath_ptr CsysPath)

Calculates the mass properties of solid referenced by the specified coordinate system, using respective component paths.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified coordinate system was not found.

Manual References:: Solid: Mass Properties

Parameters:

CompPath: The component path of solid. If this is null, the top assembly is referred.
CsysItem: The csys model item. If this is null, default csys is referred.
CsysPath: The component path of csys. If this is null, default csys is referred.

Returns: