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

schHiComputePinRef

schHiComputePinRef( 
[ ?reportFile t_reportFile ] 
[ ?display t_display ] 
[ ?formatString t_formatString ]
[ ?reportDups t_reportDups ] 
[ ?sortByDir t_sortByDir ] 
)
=> t

Description

Displays the Cross-Reference Options form for current index or sheet schematic, which computes, stores, and lists zone references for all pins and offsheet connectors in a multisheet schematic. The zone references identify where pins on other sheets reference the same net. Uses stored references to identify pin locations. The pin references can be displayed in the schematic alongside each pin or written to a report file. Can be used only when editing either the index or a sheet of a multisheet design. The index requires checking before zones can be computed.

Arguments

?reportFile t_reportFile

Filename for the cross-reference report; must be enclosed in quotation marks. Use an empty string to suppress the report file.
Default: " "

?display t_display

Controls display of cross-references in the schematic; must be enclosed in quotation marks. Set this argument to on to display cross-references or to off to remove any existing cross-references.
Default: on

?formatString t_formatString

Controls the cross-reference format. You can build the cross-reference format using any combination of the following in any order: 

sheetNumber zone referenceName direction

Default: schGetEnv("pinRefFormat")

?reportDups t_reportDups

Controls reporting of duplicate pin references found within the same zone; must be enclosed in quotation marks. Set this argument to on to report duplicate pin references or to off to suppress these reports.
Default: schGetEnv("pinRefDuplicates")

?sortByDir t_sortByDir

Controls sorting of pin references; must be enclosed in quotation marks. Set this argument to on to sort by direction or to off to sort by sheet number.
Default: schGetEnv("pinRefSorting")

Value Returned

Always returns t.

Examples

Displays the Cross-Reference Options form and also creates a report file named design.xref. 

schHiComputePinRef( ?reportFile "design.xref" ) 
Displays the Cross-Reference Options form to produce cross-references in the schematic alongside each pin in sheet 1 zone B.Duplicate references are not reported and references are sorted by direction.
schHiComputePinRef( t_reportFile "" ?display "on" ?formatString "1 B" ?display "off" ?display "on" )

Return to top
 ⠀
X