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

gpeFinishSandbox

gpeFinishSandbox(
u_sandbox
[ ?transfer { t | nil } ]
[ ?removeScratch { t | nil } ]
[ ?backAnnotate { t | nil } ]
[ ?verbose { t | nil } ]
)
=> t / nil

Description

Deletes the specified Modgen sandbox object. If run from the schematic view, the Modgen's associated scratch cellview is also deleted. If run from the layout view, the command optionally transfers the Modgen constraint to the schematic view and backannotates any dummies. gpeFinishSandbox must be used in tandem with the functions that create sandboxes, such as gpeCreateSandbox and gpeEditSandbox. It is recommend that all Modgen sandbox objects are finished by calling this function.

Arguments

u_sandbox

Specifies the Modgen sandbox object to be deleted.

?transfer { t | nil }

Specifies whether the Modgen constraint must be transferred to its schematic view. The default value is nil.

?removeScratch { t | nil}

Specifies whether the scratch cellview must be deleted. The default value is t.

?backAnnotate { t | nil }

Specifies whether all dummies must be backannotated. This value is valid only if g_transfer is set to t. The default value is nil.

?verbose { t | nil }

Controls the display of warning messages.

Value Returned

t

The specified Modgen sandbox object was deleted.

nil

The command was unsuccessful.

Example

In the following example, cv is the cellview returned by geGetCurrentCellView, and inst1 and inst2 are the instances returned by dbFindAnyInstByName. These values are passed as arguments to create a Modgen sandbox object sbox. gpeFinishSandbox is then used to delete this Modgen sandbox object. The Modgen constraint is transferred to the schematic view, the scratch cellview is deleted, and all dummies are backannotated.

cv = geGetCurrentCellView()
inst1 = dbFindAnyInstByName(cv "M1")
inst2 = dbFindAnyInstByName(cv "M2")
sbox = gpeCreateSandbox(?cv  cv ?ids list(inst1 inst2))
gpeFinishSandbox(sbox ?transfer t ?removeScratch t ?backAnnotate t)

Return to top
 ⠀
X