schRegPostCheckTrigger

schRegPostCheckTrigger( 
s_functionName 
[ g_onceOnly ] 
)
=> t / nil

Description

Registers a function that will be called after a schematic is checked using the Check – Current Cellview or Check – Hierarchy commands. The called function must be defined to accept three arguments: the cellview ID of the schematic, the number of errors encountered, and the number of warnings encountered during the check.

If your registered function implements additional checks, consider also using schUpdateUserSRCErrorAndWarn.

This function is called only on schematics with connectivity that requires checking.

There are limitations to be aware of when using schRegPostCheckTrigger:

schRegPostCheckTrigger does not update the last checked timestamp.
If adding markers with a custom SKILL program, you can update the last checked timestamp using the dbSetConnCurrent() API, but only after checking that the connectivity was up to date when the trigger was called and the connectivity was not modified by the trigger (see the example below).
If the trigger function calls any SKILL functions that modify the schematic database, you must ensure that these functions do not break the connectivity of the design.

Arguments

s_functionName	The symbol for the SKILL function that is to be called.
g_onceOnly	If not specified or specified as `'nil`, the registered function is called after each schematic is checked. If any other value is specified, the registered function is only called once for the top schematic in the hierarchy; this allows you to register a routine that is called only once after a hierarchical check is performed, rather than for each schematic that is checked.

Value Returned

`t`	Registers a function that will be called after a schematic is checked.
`nil`	Registration was unsuccessful.

Examples

Registers userSRC as a function to be called after the specified cellview is checked.

procedure( userSRC(cv nErr nWarn "dxx")
    let( (current (nUserErr 0) (nUserWarn 0))

printf( "Running userSRC ...\n" )

; Remember if connectivity is up to date.

current = dbIsConnCurrent(cv)

; Create markers according to your schematic rule checks. Update the
; local variables nUserErr and nUserWarn accordingly.
; (code omitted)

; Include additional errors and warnings in the check report totals.
schUpdateUserSRCErrorAndWarn(nUserErr nUserWarn)

when(current && nUserErr == 0
; Zero errors, connectivity remains up to date.

dbSetConnCurrent(cv))

schRegPostCheckTrigger( 'userSRC )

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