gpeEditSandbox

gpeEditSandbox(
[ d_modgenID | d_figGroupID ]
[ g_sync ]
[ ?verbose { t | nil } ]
)
=> u_sandbox / nil

Description

Returns a Modgen sandbox object that represents the current Modgen or figGroup. The sandbox object can be edited using SKILL APIs.

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

d_modgenID | d_figGroupID
	Specifies the figGroup ID or Modgen constraint ID. The default is the selected Modgen figGroup then the selected Modgen constraint.
g_sync	Specifies whether the sandbox is in the synchronized state. The default value is nil.
?verbose { t | nil }
	Controls the display of warning messages.

Value Returned

u_sandbox	Returns the Modgen sandbox object.
nil	The Modgen sandbox object could not be found.

Example

In the following example, the editing mode is turned on for the Modgen sandbox that is present in the current cellview:

sb = gpeEditSandbox()

In the following example, the values for fg and sync are first instantiated. These values are then used in gpeEditSandbox to turn on editing mode for corresponding Modgen sandbox objects:

fg = car(exists(x geGetSelectedSet() (x~>objType=="figGroup" && x~>type=="modgen")))

sync = nil

sb = gpeEditSandbox(fg sync)

Return to top