cdfRemasterAction

cdfRemasterAction(
[ ?noFormInitCall g_noFormInitCall ]
[ ?noFormDoneCall g_noFormDoneCall ]
[ ?paramList g_paramList ]
[ ?paramCallbacks g_paramCallbacks ]

)
=> l_returnDPL

Description

Helper function for the CDF remastering callback function that is registered using cdfRegRemasterTrigger. The callback function is expected to return a SKILL disembodied property list (DPL) having specific named properties. The cdfRemasterAction function constructs this DPL from its key arguments.

The callback function must be defined in the following format:

(d_instId d_newMasterCVID) => l_returnDPL

Here,

d_instId is the database instance ID being remastered
d_newMasterCVID is the ID of the new master
l_returnDPL is a DPL created by the cdfRemasterAction function

Arguments

`?noFormInitCall` g_noFormInitCall
	Boolean that specifies whether the CDF form initialization procedure of the instance should be called during property value application. The procedure is called only if the value is `nil`, and not called if the value is `t`. Other boolean trues such as 1 or "some value" are an error. The default is `nil`.
`?noFormDoneCall` g_noFormDoneCall
	Boolean that specifies whether the CDF form done procedure of the instance should be called during property value application. The procedure is called only if the value is `nil`, and not called if the value is `t`. Other boolean trues such as 1 or "some value" are an error. The default is `nil`.
`?paramList` g_paramList
	List of parameter name-value pairs in the following format: (list t_paramName g_paramValue) For example: `?paramList list(list("l" 10e-9) list("model" "newModel") "m")` Here, running `cdfRemasterAction` with the above example ensures that the remastered instance has three properties, where `l` is set to `10e-9`, `model` is set to `newModel`, and `m` is set to the value on the instance before remastering. When `?paramList` is set to `nil`, no properties are preserved or mapped. The default is `nil`.
`?paramCallbacks` g_paramCallbacks
	Controls the parameter callbacks executed on the remastered instance. Possible values are: `'none`: Does not run any parameter callbacks. `'all`: Calls the callbacks for all the parameters of the new master cell CDF. Here, callbacks will be called for CDF parameters which are part of `paramList` first followed by callbacks of the rest of the new master cell CDF parameters. `'paramList`: Runs only the callbacks for parameters specified in the `paramList` argument and in the order specified. `list`: List of strings specifying the parameter names and sequence to trigger callbacks in the following format: list(t_param1 t_param2 ...) For example, to first run the `model` and then the `l` parameter, specify the following: ?paramCallbacks list("model" "l") The default is '`paramList`.

Value Returned

l_returnDPL

A disembodied property list (DPL) used by the remaster infrastructure.

Examples

Defines a remaster function. The callback MyRemasterFunc function specifies:

The formInitProc of the new master is not called.
The formDoneProc of the new master is called.
The property p1 is set to the value 1 and the property values p2 and p3 are set to the instance value before remastering.
The ?paramCallback key argument is not specified and the default 'paramList is used.

(defun MyRemasterFunc (instId newMasterCvId) cdfRemasterAction(?noFormInitCall t ?noFormDoneCall nil ?paramList list(list("p1" 1) "p2" "p3")))

Registers the remaster function.

cdfRegRemasterTrigger("MyRemasterFunc")
=>t

Performs the remastering on an instance.

dbRemasterAnyInst(inst new_cv)
=>t

Virtuoso ADE SKILL Reference
Product Version IC23.1, November 2023