Product Documentation
Virtuoso Schematic Editor SKILL Functions Reference
Product Version IC23.1, November 2023

schRenumberInstances

schRenumberInstances( 
g_objId 
[ t_scope ]
[ g_verbose ]
[ t_sequence ]
[ x_startIndex ]
[ t_applyTo [ t_libraryName t_cellName t_viewName ] ] 
)
=> t / nil

Description

Resequences instances using the format instNamePrefix number that results in unique numbering indexes for each component name prefix encountered. Any voids in a numbering sequence are resolved by renaming instances with the highest numbers to fill the voids.

Arguments

g_objId

ID of a cellview or library.
Valid Values: db cellview ID (d_cvId), dd library (b_libId)

t_scope

Defines the range of cellviews to have their instances renumbered; must be enclosed in quotation marks.
Valid Values: For a cellview ID: cellview, hierarchy; for a library ID: library
Default: cellview when the ID is d_cvId; library when the ID is b_libId

g_verbose

Echoes the renumbered instance names and source names to the CIW.
Default: nil

t_sequence

Defines the sequencing mechanism; must be enclosed in quotation marks.
Valid Values: filling the voids, X+Y+, Y+X+, X+Y-, Y-X+, X-Y+, Y+X-, X-Y-, Y-X-
Default: filling the voids

X + Y renumbers from the bottom left to the top right, going left to right, bottom to top.

x_startIndex

The number assigned to the first renumbered instance.

t_applyTo

Defines the group of instances; must be enclosed in quotation marks. To renumber all instances, specify any master; to renumber only the instances of a specific master, specify same master and specify t_libraryName t_cellName t_viewName
Valid Values: any master, same master
Default: any master

t_libraryName t_cellName t_viewName

The library, cell, and view name of the instance to apply the renumbering sequence to; each item must be enclosed in quotation marks.

Value Returned

t

Resequenced instances using the specified format.

nil

Instances were not resequenced.

Examples

Resequences the instances contained in the cellview.

schRenumberInstances( cv )

Resequences the symbol view of the cell buf from the library sample with verbose set to on, using the Y-X+ order, starting the sequence with index 0.

schRenumberInstances( cv "cellview" t "Y-X+" 0 "same master" "sample" "buf" "symbol" )

Return to top
 ⠀
X