schRegPreCheckTrigger

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

Description

Registers a function that will be called before a schematic is checked using the Check – Current Cellview or Check – Hierarchy commands. The called function must be defined to accept one argument; that is the cellview ID of the schematic.

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

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 before each schematic is checked.
If any other value is specified, the registered function is only called once for the top schematic. This allows you to register a routine that is called only once before a hierarchical check is performed, rather than for each schematic that is checked.
Each routine can only be registered once.

Value Returned

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

Examples

Registers checkTrig and checkOnceTrig as functions to be called. It then calls the pre-check trigger for schematics that require updating and automatically saves the schematics as they are checked.

procedure( checkTrig(cv "d")

    info(".. Check Trigger called for %s/%s/%s\n" cv~>libName cv~>cellName

cv~>viewName)

procedure(checkOnceTrig(cv "d")

    info(".. Check Once Trigger called for %s/%s/%s\n" cv~>libName

cv~>cellName cv~>viewName)

schRegPreCheckTrigger 'checkTrig

schRegPreCheckTrigger 'checkOnceTrig t

envSetVal("schematic" "checkAlways" 'boolean nil)

envSetVal("schematic" "checkHierSave" 'boolean t)

schCheckHier( geGetEditCellView() "schematic" " " )

Calls the pre-check trigger for every schematic in the hierarchy. The modified schematics are not saved.

envSetVal("schematic" "checkAlways" 'boolean t)

envSetVal("schematic" "checkHierSave" 'boolean nil)

schCheckHier( geGetEditCellView() "schematic" " " )

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