phoRegisterInstTermOpticalMonitorMenuItem

phoRegisterInstTermOpticalMonitorMenuItem(
t_menuItemText
s_callback
)
=> t / nil

Description

(Virtuoso Photonics Option) Registers the callback function to add an optical monitor to the Virtuoso Schematic Editor contextual menu. Optical monitors are used to setup a simulation and plot for complex mathematical optical signals. This function can be called at any time in the code. However, calling it several times with the same name string overrides the previously stored callback for that menu item and causes a warning to be displayed in the CIW.

Arguments

t_menuItemText	Name of the menu option for the optical monitor.
s_callback	Name of the callback function to register the optical monitor menu item.

Value Returned

t	Optical monitor callback function is registered.
nil	Optical monitor callback is not registered.

Example

The example below registers optical monitor for instTerm.

phoRegisterInstTermOpticalMonitorMenuItem("OM Incident and Phase" 'OMExpressionBuilderINCB )

phoRegisterInstTermOpticalMonitorMenuItem("OM Incident and Phase" 'OMExpressionBuilderOUTCB )

Related Topics

Photonics Flow Functions

Return to top