Space Allocation Functions

The SpaceAllocationFunctions package contains a set of functions for exposure and usage in knowledge tools.

This page discusses:

GetSpaceClone

You can use this function to get space clone from a given space reference.

Signature

SpaceReference.GetSpaceClone() : Feature

Arguments

Name Input / Output Required? Type Comment
SpaceReference In Yes ProductOccurrence The occurrence of the space reference that contains a space clone.

ReturnType

Feature

The space clone contained in the given space reference.

Example

/*
Input Argument:
SpaceOcc (ProductOccurrence)
*/
let result (Feature)

result = SpaceOcc.GetSpaceClone()
if (result <> NULL)
{
  Message (“Space Clone Name: ”, result.Name())
}

AssignVolume

You can use this function to assign volume to a space reference.

Signature

SpaceReference.AssignVolume(VolumeGeometry : Feature, SourceOccurrence : ProductOccurrence) : Boolean

Arguments

Name Input / Output Required? Type Comment
SpaceReference In Yes ProductOccurrence The occurrence of the space reference to which a 3D volume is assigned.
VolumeGeometry In Yes Feature The 3D volume geometry feature to be assigned to the space reference.
SourceOccurrence In Yes ProductOccurrence The product occurrence that contains the 3D volume feature.

ReturnType

Boolean

TRUE if the 3D volume is assigned to the space reference successfully, FALSE if not.

Example

/*
Input Argument:
SpaceOcc (ProductOccurrence)
VolumeGeometry (Feature)
SourceOcc (ProductOccurrence)
*/
let result (boolean)

result = SpaceOcc.AssignVolume(VolumeGeometry, SourceOcc)
if (result)
{
  Message (“The 3D volume is assigned to the space reference successfully.”)
}