awvLoadCustomCalcFunction

awvLoadCustomCalcFunction(
[ ?funcList l_funcList ]
[ ?fileName t_fileName ]
[ ?templateFileName t_templateFileName ]
[ @rest l_args ]
)
=> t / nil

Description

Adds the functions specified in the SKILL file (.il) and UI template file (.ocn) to the Custom Functions drop-down list in the Function Panel of Virtuoso Visualization and Analysis XL Calculator.

The SKILL file contains the definition of the custom calculator functions. The UI template file (.ocn) contains the user-interface template of the custom calculator functions.

The user-interface template can be obtained either from the SKILL file or from a separate .ocn file.

Arguments

?funcList l_funcList
	List containing names of the custom functions defined in the SKILL file that you want to add to the Custom Functions drop-down list in the Function Panel of Calculator.
?fileName t_fileName
	Path to the SKILL file (.il) that contains SKILL definitions of custom functions. This SKILL file may also contain the UI templates for custom functions. If the SKILL file is saved in the current working directory, you can specify only the file name.
?templateFileName t_templateFileName
	Path to the .ocn file that contains the UI templates for custom functions. If the .ocn file is saved in the current working directory, you can specify only the file name.
@rest l_args	List of additional arguments passed to the function.

Value Returned

t	Custom functions are added to Function Panel successfully.
nil	Custom functions cannot be added to Function Panel because of an error.

Examples

The following example adds a custom function customBandwidth to the Custom Functions drop-down list in the Function Panel. The SKILL definition of the custom function is saved in the myCustomCalFunction.il and the UI template of the custom function is saved in a separate myCustomCalFunction.ocn file.

awvLoadCustomCalcFunction(?funcList "customBandwidth" ?fileName "/home/user/myCustomCalFunction.il" ?templateFileName "/home/user/myCustomCalFunction.ocn")

=> t

The following example adds two custom functions customFrequency and customWavelength to the Custom Functions drop-down list in the Function Panel.

The SKILL definitions and UI templates for both custom functions are saved in a single SKILL file myCustomSKILL.il.

awvLoadCustomCalcFunction(?funcList list("customFrequency" "customWavelength") ?fileName "/home/user/myCustomSKILL.il")

=> t

Return to top