Product Documentation
Virtuoso Layout Suite SKILL Reference
Product Version IC23.1, November 2023

vfoPostStretchCBHandler

vfoPostStretchCBHandler
t_mode
S_callbackFunction
) 
=> t / nil

Description

Registers or deregisters a user-defined callback function that is called after the stretch command completes on an FGR instance. You can do post-processing on the edited FGR instance in the registered callback function.

The user callback function must be defined before calling the vfoPostStretchCBHandler function to successfully register it as a callback function.

Arguments

t_mode

Specifies mode to register or deregister a user-defined callback function. Valid values are:

  • r: Registers the user-defined callback function.
  • d: Deregisters an already registered user-defined callback function.

S_callbackFunction

Name or function symbol of a user-defined callback function.

Value Returned

t

The user callback function was registered or deregistered successfully.

nil

The user callback function could not be registered or deregistered.

Examples

Registers the user-defined callback function fixOrigin for post-stretch operation.

procedure(fixOrigin(inst)
                print("callback to do any post-processing on the FGR instance")
)
vfoPostStretchCBHandler("r" 'fixOrigin)
or
vfoPostStretchCBHandler("r" "fixOrigin")

Deregisters the user-defined callback function fixOrigin for post-stretch operation.

procedure(fixOrigin()
                print("callback to do any post-processing on the FGR instance")
)
vfoPostStretchCBHandler("d" 'fixOrigin)
or
vfoPostStretchCBHandler("d" "fixOrigin")

Return to top
 ⠀
X