Product Documentation
Virtuoso Layout Suite SKILL Reference
Product Version IC23.1, November 2023

gpeCreateSandbox

gpeCreateSandbox(
[ ?cv d_cellview ] 
[ ?ids l_figs ]
[ ?sync { t | nil } ]
[ ?verbose { t | nil } ]
)
=> u_sandbox / nil

Description

Creates a Modgen sandbox object that includes the specified instances. This function can be used to create Modgen sandbox objects in both schematic and layout cellviews. If none of the arguments are provided, the current edit cellview and selected instances are considered.

Changes made to a Modgen sandbox object are updated to the associated Modgen constraint and layout placement only when the Modgen sandbox object is in the synchronization mode. Either set the ?sync argument to t or use the gpeSyncSandbox API to turn on the synchronization mode. After customizing the Modgen sandbox object as per your requirements, use the gpeFinishSandbox SKILL function to delete the Modgen sandbox object and its associated scratch cellview and transfer the Modgen constraint to the schematic view.

Arguments

?cv d_cellview

Specifies the cellview ID. If unspecified, uses the current cellview.

?ids l_figs

Specifies a list of instances to be included in the Modgen sandbox.

?sync { t | nil}

Turns on synchronization mode for the Modgen sandbox object created. The default is nil.

?verbose { t | nil }

Controls the display of warning messages.

Value Returned

u_sandbox

Returns the Modgen sandbox object created.

nil

The Modgen sandbox object could not be created.

Examples

In the following example, a Modgen sandbox is created using the current cellview:

sbox = gpeCreateSandbox()

In the following example, cv is a list of cellviews returned by geGetEditCellView and instList are the instances returned by geGetSelectedSet. These values are passed as arguments to create a Modgen sandbox object:

cv = geGetEditCellView()
instList = geGetSelectedSet()
sb = gpeCreateSandbox(cv instList)
The cv references

Creates a Modgen that includes the specified instances.

sbox = gpeCreateSandbox( ?sync t);
gpeSetMap(sbox list( list("M0" "X") list("M1" "Y")));
gpeSetGrid(sbox list( "X" "X") list("Y" "Y")));

Return to top
 ⠀
X