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

lxSetPreserveFloorplanningOptions

lxSetPreserveFloorplanningOptions(
[ ?preserve { all | none } ]
[ ?rows { t | nil } ]
[ ?blockages { t | nil } ]
[ ?areaBoundaries { t | nil } ]
[ ?trackPatterns { t | nil } ]
[ ?clusters { t | nil } ]
[ ?clusterBoundaries { t | nil } ]
[ ?prBoundary { t | nil} 
[ ?snapBoundary { t | nil } ]
[ ?snapPatterns { t | nil } ]
)
=> t / nil

Description

Sets the preserve floorplanning objects options in the Generate Layout form. This function must be called between calls to lxGenerateStart and lxGenerateFinish.

Arguments

?preserve

Specifies that either all or none of the floorplanning objects are to be preserved. Enclose the string in quotation marks. The default is nil.

If you specify this argument, it overrides all other arguments.

?rows

Preserves any existing rows and custom placement areas.

?blockages

Preserves standalone blockages which have no parent object; a blockage with a parent object is preserved automatically along with its parent. The default is nil.

?areaBoundaries

Preserves any existing area boundaries. The default is nil.

?trackPatterns

Preserves any existing track patterns The default is nil.

?clusters

Preserves any existing clusters. The default is nil.

?clusterBoundaries

Preserves cluster boundaries, but only if ?clusters is also set to t. The default is nil.

?prBoundary

Preserves any existing PR boundary. The default is nil.

?snapBoundary

Preserves the snap boundary but only if ?prBoundary is also set to t. The default is nil.

?snapPatterns

Preserves snap patterns. The default is nil.

Value Returned

t

Preserve floorplanning options were set.

nil

Preserve floorplanning options were not set.

Examples

Preserves all floorplanning objects except track patterns.

lxGenerateStart(schId layId)
  lxSetPreserveFloorplanningOptions(
    ?rows t
    ?boundaries t
    ?areaBoundaries t
    ?clusterBoundaries t
    ?clusters t
    ?trackPatterns nil
    ?prBoundary t
    ?snapBoundary t
    ?snapPatterns t
  )
lxGenerateFinish(schId layId)

Preserves all floorplanning objects.

lxGenerateStart(schId layId)
  lxSetPreserveFloorplanningOptions(
    ?preserve "all"
  )
lxGenerateFinish(schId layId)

Return to top
 ⠀
X