gpeStartSandbox

gpeStartSandbox(
[ ?ref l_reference ] 
[ ?cv d_cellview ] 
[ ?sync { t | nil } ]
[ ?updateSchConstraint { t | nil } ]
[ ?verbose { t | nil } ]
)
=> g_sandbox / nil

Description

Checks for a Modgen sandbox object that includes the specified instances. If one exists, the handle of the Modgen sandbox object is returned for editing with the GPE placement and routing APIs. If an existing object does not have the specified instances, a new Modgen sandbox object is created.

Arguments

?ref l_reference	Specifies a list of instances, including the Modgen figGroups and constraints, to be included in the Modgen sandbox. the default is the current selection.
?cv d_cellview	Specifies the cellview ID. If unspecified, uses the current cellview.
?sync { t | nil }	Turns on the synchronization mode for the Modgen sandbox object created. The default is nil.
?updateSchConstraint { t | nil }
	Transfers the constraint to the schematic and the object to the storage. The default is t.
?verbose { t | nil }
	Controls the display of warning messages.

Value Returned

g_sandbox	Returns the handle of the Modgen sandbox object that is open for editing.
nil	The Modgen sandbox object could not be created or opened for editing.

Examples

A Modgen sandbox object is created and its handle returned when a list of instances is passed as reference:

     inst1 = dbFindInstByName("M1")

     inst2 = dbFindInstByName("M2")

     sbox = gpeStartSandbox(?ref list(inst1 inst2))

A Modgen sandbox object is created with the selected instances and its handle returned when the selection made on the canvas contains instances, but not Modgen figGroups:

     sbox = gpeStartSandbox()

A Modgen sandbox object handle is returned for edit when a Modgen figGroup ID is passed as reference:

     figId = leGetEditFigGroup()

     sbox = gpeStartSandbox(?ref figId)

A Modgen sandbox object handle is returned for edit when a Modgen constraint ID is passed as reference:

     mgCiCon = *valid_Modgen_constraint_ID*

     sbox = gpeStartSandbox(?ref mgCiCon)

A Modgen sandbox object handle is returned for edit when a Modgen constraint is selected in the constraint manager.

     sbox = gpeStartSandbox()

A Modgen sandbox object handle is returned for edit when a list of instances that are part of a Modgen is passed as reference:

     inst1 = dbFindInstByName("M1")

     inst2 = dbFindInstByName("M2")

     inst3 = dbFindInstByName("M3")

  inst1~>figGroup == inst2~>figGroup == inst3~>figGroup &&

  inst1~>figGroup~>type == 'modgen

     sbox = gpeStartSandbox(?ref list(inst1 inst2 inst3)

A Modgen sandbox object handle is returned for edit when the selection made on the canvas contains Modgen figGroups. The function returns the sandbox handle of the first Modgen figGroup found.

     sbox = gpeStartSandbox()

Return to top