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

hsmGetSelectedSet

hsmGetSelectedSet(
[ ?top g_top ]
[ ?type d_type ]
[ ?pathStyle g_pathStyle ]
[ ?includeExtra g_includeExtra ]
[ ?cellview d_cellview ]
[ ?path g_path ]
)
=> list / nil

Description

Gets the hierarchical selected set.

Arguments

?top g_top

The top cellview or window.

?type d_type

The object type to be retrieved.

Objects currently supported are: instances, nets, pins, terminals, paths, vias, PRBoundary, areaBoundary, clusterBoundary, snapBoundary, figGroups and clusters.

?pathStyle g_pathStyle

The path style. For example:

  • list - gives the path as a list of lists
  • string - gives a simple path as a simple string e.g. “(L.C:V)/I1/I2/I3”)
  • qualified - gives the path as a full path including library, cell and view

?includeExtra g_includeExtra

Lists extra details on selected objects.

This is nil by default.

?cellview d_cellview

Enter either a db cellview or a string of the form “lib cell view”, so that it only returns the selections that are in that cellview.

If you have the same cellview open in multiple windows or tabs, at different levels of the hierarchy, you will get multiple entries for all of the difference hierarchies.

?path g_path

Enter a hierarchical path that can be either a string, window or list of lists, and it will return only the those selections at the lowest level of the path.

Value Returned

list

The returned hierarchical selected set.

nil

Commands failed.

Examples

Will get everything.

hsmGetSelectedSet() 

Will get just instances in the hierarchy starting at the given cell view.

hsmGetSelectedSet(?type ‘inst) 

Will get nets and instances in the hierarchy starting at the given cell view.

hsmGetSelectedSet(?type list(‘inst ‘net)) 

Will get extra details on selected objects.

hsmGetSelectedSet(?includeExtra t)

Related Topics

hsmSelect


Return to top
 ⠀
X