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

schRegisterCheckRule

schRegisterCheckRule( 
[ ?title t_title ]
[ ?name s_name ]
[ ?groupName s_groupName ]
[ ?checkCB u_checkCB ]
[ ?configCB u_customCB ]
[ ?severity s_severity ]
[ ?description t_description ]
)
=> r_checkrule / nil

Description

Creates and registers a new schematic rule checker. Calling this function with the same rule name as an existing rule in the same group overwrites that rule.

Arguments

?title t_title

Title text that for labels in the user interface.

?name s_name

Symbolic name of the created checker.

?groupName s_groupName

Symbolic name of the parent checker group.

?checkCB u_checkCB

The callback invoked on each run of the checker if the severity is not set as 'ignored.

?configCB u_configCB

The callback invoked when clicking the “...” button in the user interface.

?severity s_severity

The default severity for this check ('ignored 'warning 'error).

?description t_description

Text for tooltips in the user interface.

Value Returned

r_checkrule

The new schCheckRule structure was created.

nil

The new schCheckRule structure could not be created.

Examples

(schRegisterCheckRule
    ?title        "No Shorting Transistors"
    ?name         'noTxShorts
    ?groupName    'ercChecks
    ?checkCB      'noTxShortsCB
    ?severity     'warning
    ?description  "An nfet/pfet transistor can not have the source connected to a ground\nnet when the drain is connected to a power net")
=> schCheckRule@0x1154a828

Related Topics

Creating Custom Checks


Return to top
 ⠀
X