schComputePinRef
schComputePinRef(
d_cellView
[ ?reportFile t_reportFile ]
[ ?display t_display ]
[ ?formatString t_formatString ]
[ ?reportDups t_reportDups ]
[ ?sortByDir t_sortByDir ]
[ ?separator t_separator ]
[ ?inputDesignator t_inputDesignator ]
[ ?outputDesignator t_outputDesignator ]
[ ?ioDesignator t_ioDesignator ]
[ ?charsPerLine x_charsPerLine ]
)
=> t / nil
Description
Creates offsheet pin references for multisheet designs. The pin references can be displayed in the schematic next to each pin or in a report file. This function creates an offsheet pin reference report that lists each pin followed by a list of all other locations of this pin. The pin references can also be displayed in the schematic next to each pin.
Arguments
|
d_cellView
|
Cellview of the index schematic or any sheet in a multisheet design to be cross-referenced; must be enclosed in quotation marks.
|
|
?reportFile t_reportFile
|
|
|
File in which to output the cross-reference report; specify nil for no report.
Default: " "
|
|
?display t_display
|
Set to on to display cross-references in schematic, set to off to remove cross-references in schematics if they exist; must be enclosed in quotation marks.
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
|
|
|
Set to off to suppress reporting of duplicate pin references found within the same zone; must be enclosed in quotation marks.
Default: off
|
|
?sortByDir t_sortByDir
|
|
|
Sets whether pin reference sorting is by direction or sheet number; must be enclosed in quotation marks. Set this argument to on to sort by direction.
Default: off
|
|
?separator t_separator
|
|
|
String used to separate pin references; must be enclosed in quotation marks.
Default: ,
|
|
?inputDesignator t_inputDesignator
|
|
|
String used to designate input pins; must be enclosed in quotation marks.
Default: i
|
|
?outputDesignator t_outputDesignator
|
|
|
String used to designate output pins; must be enclosed in quotation marks.
Default: o
|
|
?ioDesignator t_ioDesignator
|
|
|
String used to designate IO pins; must be enclosed in quotation marks.
Default: io
|
|
?charsPerLine x_charsPerLine
|
|
|
Number of characters before automatically inserting a new line within a cross-reference list.
Default: 100
|
Value Returned
|
t
|
Created offsheet pin references for multisheet designs.
|
|
nil
|
Offsheet pin reference creation was unsuccessful.
|
Examples
Produces cross-references on pins in a schematic using default options.
schComputePinRef( cellview )
Produces a cross-reference report file in design.xref. Use a space " " or a reference separator instead of the default comma ",". The pin references also appear in the schematic by default.
schComputePinRef( cellview "design.xref" ?display "on" ?reportFile nil ?reportDups "off" ?sortByDir "off" ?reportFile " " )
Return to top
