CIP JavaScript documentation for class " pfcAssembly"

Class pfcAssembly

Description

This class describes an assembly.

Direct Parent Classes:: pfcSolid

Property Summary


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

`/* readonly */ boolean`	`IsExploded`
	If the assembly is exploded, this attribute is `true`; otherwise, it is`false`

Method Summary


`pfcFeature`	`AssembleByCopy (string NewModelName, pfcSolid ModelToCopy, boolean LeaveUnplaced)`
	Assembles a copy of a model into the assembly.

`pfcFeature`	`AssembleComponent (pfcSolid Model, /* optional */ pfcTransform3D Position)`
	Assembles the model into the assembly.

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

`void`	`AssembleSkeletonByCopy (string NewSkeletonName, pfcSolid 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`	`GetActiveExplodedState ()`
	Returns the current active exploded state in the assembly.

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

`pfcMassProperty`	`GetMassPropertyByCompPath ( /* optional / pfcComponentPath CompPath, / optional / pfcModelItem CsysItem, / optional */ pfcComponentPath CsysPath)`
	Calculates the mass properties of solid referenced by the specified coordinate system, using respective component paths.

`pfcSolid`	`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.

Property Detail

boolean DynamicPositioning

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

/* readonly */ boolean IsExploded

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.

Method Detail

pfcFeature AssembleByCopy (string NewModelName, pfcSolid ModelToCopy, boolean 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.

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.

pfcFeature AssembleComponent (pfcSolid Model, /* optional */ pfcTransform3D 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.

Parameters:

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

Returns:: The new component feature object.

void AssembleSkeleton (pfcSolid 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.

Parameters:

SkeletonModel: The skeleton model.

void AssembleSkeletonByCopy (string NewSkeletonName, pfcSolid 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.

Parameters:

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

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.

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.

/* optional */ pfcExplodedState GetActiveExplodedState ()

Returns the current active exploded state in the assembly.

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

pfcExplodedState GetDefaultExplodedState ()

Returns the default exploded state in the assembly.

Returns:: The default exploded state.

pfcMassProperty GetMassPropertyByCompPath ( /* optional */ pfcComponentPath CompPath, /* optional */ pfcModelItem CsysItem, /* optional */ pfcComponentPath 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.

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:

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

Returns:: The skeleton model.

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.