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

Signals or Triggers for ADE Sessions

The following table lists all the signals or triggers available for ADE sessions.

Signal Change in State

cornersUpdated

When corners are updated.

Syntax:

cornersUpdated(t_sessionName)

createdTest

When a test is created.

Syntax:

createdTest(t_sessionName t_testName)

downloadFinishedConclusion

When download of simulation data has finished.

Syntax:

downloadFinishedConclusion(t_sessionName x_runId x_runhsdb)

eligibleReferenceHistoryItemsChanged

When there is a change in the list of history items that are eligible to be used as reference history items.

Syntax:

eligibleReferenceHistoryItemsChanged(t_sessionName)

initializedTest

When a test is enabled.

Syntax:

initializedTest(t_sessionName t_testName)

netlistProgress

When the netlisting job completes a point netlist.

Syntax:

netlistProgress(t_sessionName x_runid)

ocnPostRunCommandWrite

After writing the ocnxlRun command in the OCEAN script being written from the tool.

Syntax:

ocnPostRunCommandWrite(t_sessionName g_filePointer)

ocnPreRunCommandWrite

Before writing the ocnxlRun command in the OCEAN script being written from the tool.

Syntax:

ocnPreRunCommandWrite(t_sessionName g_filePointer)

parametersUpdated

When the values of parameters are updated.

Syntax:

parametersUpdated(t_sessionName)

pointCompleted

When the simulation of a point is completed.

Syntax:

pointCompleted(t_sessionName x_historyHSDB x_pointId t_testName t_cornerName)

pointSimulationCompleted

When simulation for a point is completed.

Syntax:

pointSimulationCompleted(t_sessionName x_historyHSDB t_testName x_pointId)

postCloseCellView

After the cellview is closed.

Syntax:

postCloseCellView(t_sessionName t_lib t_cell t_view t_mode )

postCreateDatasheet

After a datasheet is created.

Syntax:

postCreateDatasheet(t_sessionName x_hsdb t_datasheetDir)

postCreateHistoryEntry

After a history item is created.

Syntax:

postCreateHistoryEntry(t_sessionName x_hsdb)

postCreateMainSetupDB

After a setup database is created.

Syntax:

postCreateMainSetupDB(t_sessionName x_hsdb)

postCreatedTest

After a test is created.

Syntax:

postCreatedTest(t_sessionName t_testName)

postExportResults

After exporting the simulation result data in the HTML or CSV format

Syntax:

postExportResults(t_sessionName x_historyHSDB t_exportedType t_exportedFilePath x_exportSuccessful)

where, t_exportedType specifies the source names from where you are exporting results. For example, a Results view or other specification analysis views. Possible values that this argument can take are listed below:

  • Detail
  • Detail - Transpose
  • Optimization
  • Summary
  • Yield
  • Spec Summary
  • Spec Comparison
  • Spec Comparison View

postImportSetup

After importing the simulation setup from an existing cellview to the current cellview.

Syntax:

postImportSetup(t_sessionName t_newSetupPath l_importTags t_historyName t_operation)

postInstall

After opening the GUI of tool.

Syntax:

postInstall(t_sessionName)

postInstallSchematic

After opening the schematic in ADE Explorer and ADE Assembler

Syntax:

postInstallSchematic(t_sessionName)

postLoadMainSetupDB

After a setup database is loaded

Syntax:

postLoadMainSetupDB(t_sessionName x_hsdb)

postLoadSetupState

After a setup state is loaded.

Syntax:

postLoadSetupState(t_sessionName t_stateName)

postRestoreHistory

After a history item is restored.

Syntax:

postRestoreHistory(t_sessionName x_hsdb)

postSaveSetupState

After a setup state is saved.

Syntax:

postSaveSetupState(t_sessionName t_stateName l_saveTags)

postSaveSimulationResults

After saving the simulation results for a history to the given destination directory.

Syntax:

postSaveSimulationResults(t_sessionName x_sdbHandle t_historyName t_destinationDir x_copyPSFResults)

where, x_copyPSFResults takes the Boolean value specified for the Copy PSF Results option on the Save Results form, which opens when you save results for a history.

postSwitchMaestroMode

When switching from ADE Explorer to Assembler or vice versa.

Syntax:

postSwitchMaestroMode(t_sessionName t_oldMode t_newMode)

postViewHistoryResults

After the results for a history item are displayed.

Syntax:

postViewHistoryResults(t_sessionName x_historyHSDB t_resultsDBPath)

preCreateDatasheet

Before a datasheet is created.

Syntax:

preCreateDatasheet(t_sessionName x_hsdb t_datasheetDir)

preCreateHistoryEntry

Before a history item is created.

Syntax:

preCreateHistoryEntry(t_sessionName x_hsdb)

preDestroySession

Before closing a session.

Syntax:

preDestroySession(t_sessionName)

preExportResults

Before exporting the results data in the HTML or CSV format.

Syntax:

preExportResults(t_sessionName x_historyHSDB t_exportedType t_exportedFilePath)

where, t_exportedType specifies the name of the user interface from where you are exporting results. For example, a Results view or other specification analysis views. Possible values that this argument can take are listed below:

  • Detail
  • Detail - Transpose
  • Optimization
  • Summary
  • Yield
  • Spec Summary
  • Spec Comparison
  • Spec Comparison View

preImportSetup

Before a setup is imported.

Syntax:

preImportSetup(t_sessionName t_newSetupPath l_importTags t_historyName t_operation)

For the list of available tags to be used for l_importTags, refer to axlImportSetup.

preInstallCellView

Before opening a cellview.

Syntax:

preInstallCellView(t_sessionName t_lib t_cell t_view t_mode )

preLoadSetupState

Before a setup state is loaded.

Syntax:

preLoadSetupState(t_sessionName t_stateName)

preRemoveTest

Before a test is deleted.

Syntax:

preRemoveTest(t_sessionName t_testName)

preRestoreHistory

Before a history item is restored.

Syntax:

preRestoreHistory(t_sessionName x_hsdb)

preRun

Before a simulation run is started.

Syntax:

preRun(t_sessionName x_setupdb t_mode t_testName)

preSaveSetup

When saving a maestro view.

Syntax:

preSaveSetup(t_sessionName)

preSaveSetupState

Before a setup state is saved.

Syntax:

preSaveSetupState(t_sessionName t_stateName l_saveTags)

For the list of available tags to be used for l_saveTags, refer to axlSaveSetupState.

preSaveSimulationResults

Before saving the simulation results.

Syntax:

preSaveSimulationResults(t_sessionName x_sdbHandle t_historyName t_destinationDir x_copyPSFResults)

where, x_copyPSFResults takes the Boolean value specified for the Copy PSF Results option on the Save Results form, which opens when you save results for a history.

preViewHistoryResults

Before the results for a history item are viewed.

Syntax:

preViewHistoryResults(t_sessionName x_historyHSDB t_resultsDBPath)

referenceHistoryItemChanged

When the reference history item is changed.

Syntax:

referenceHistoryItemChanged(t_name)

removedHistoryEntry

When a history item is deleted.

Syntax:

removedHistoryEntry(t_sessionName x_hsdb)

removedTest

When a test is deleted.

Syntax:

removedTest(t_sessionName t_testName)

renamedHistoryEntry

When a history item is renamed.

Syntax:

renamedHistoryEntry(t_sessionName x_hsdb t_oldName)

renamedTest

When a test is renamed.

Syntax:

renamedTest(t_sessionName t_originalName t_newName)

runFinished

When a simulation run is completed.

Syntax:

runFinished(t_sessionName x_runId x_runhsdb x_errorCode)

where,

t_sessionName is the name of the active session.

x_runId is the unique ID associated with the run.

x_runhsdb is the handle to the database of the run.

x_errorCode has not been implemented yet. It is always nil.

runFinishedConclusion

After all the simulations are run from the product UI.

An optimization simulation run might run a collection of various runs internally. For example, the High Yield Estimation runs various Monte Carlo simulations. After each Monte Carlo run, the runFinished signal is emitted. However, after all the required simulations are complete, the runFinishedConclusion signal is emitted.

Syntax:

runFinishedConclusion(t_sessionName x_runId x_runhsdb)

runFinishedPostPlot

After plotting the results of a simulation.

Syntax:

runFinishedPostPlot(t_sessionName x_runId x_runhsdb)

runFinishedPrePlot

Before plotting the results of a simulation.

Syntax:

runFinishedPrePlot(t_sessionName x_runId x_runhsdb)

runModeChanged

When the simulation run mode is changed.

Syntax:

runModeChanged(t_sessionName t_newRunMode)

runOptionsUpdated

When the run options are updated.

Syntax:

runOptionsUpdated(t_sessionName)

runPaused

When a simulation run is stopped.

Syntax:

runPaused(t_sessionName x_runId x_isPaused)

runProgress

When simulation for a design point is complete.

Syntax:

runProgress(t_sessionName x_runId x_numFinished x_numSubmitted)

runStartPreSDBCommit

Before checkpoint setup when a run is started.

Syntax:

runStartPreSDBCommit(t_sessionName x_hsdb)

runStarted

When a simulation run is started.

Syntax:

runStarted(t_sessionName x_runId x_runhsdb)

setSessionSetupDB

After the creation of a session.

Syntax:

setSessionSetupDB(t_sessionName x_hsdb)

If you want to perform a custom action after the ADE session and setup database is created, it is recommended to register a callback for postCreateSessionDB instead of setSessionSetupDB.

setupSaved

This trigger is called in the following cases:

  • When a maestro view is saved using the ADE session - Save menu command
  • When an adexl view is saved using the File - Save menu command
  • When a simulation run starts
  • When the setup is saved while exiting the maestro or adexl cellview
This trigger works only in the write mode.

Syntax:

setupSaved(t_sessionName)

startedNewManualTuningRun

When the manual tuning run is started.

Syntax:

startedNewManualTuningRun(t_sessionName x_runId x_runhsdb)

testComplete

When the simulations for all sweeps and corners for a test have completed.

Syntax:

testComplete(t_sessionName x_runId x_runhsdb t_testName)

testStatusUpdated

After a test is enabled or disabled.

Syntax:

testStatusUpdated(t_sessionName t_testName x_enabled)

updatedSetupStates

After the list of setup states is changed.

Syntax:

updatedSetupStates(t_sessionName)

updatedMAAnyResults

After the result for an output measured across any dimension is calculated.

Syntax:

updatedMAAnyResults(x_hsdb t_testName)

updatedMACResults

After the result for an output measured across corners is calculated.

Syntax:

updatedMACResults(x_hsdb t_testName)

updatedMASResults

After the result for an output measured across sweeps is calculated.

Syntax:

updatedMASResults(x_hsdb t_testName)

updatedTest

After any changes are made to the test. For example, a change in the test output, variable value, analysis, temperature, model file, or simulation file.

The event is not triggered when there is a change in the status of an analysis or design variable, or when the state or active setup is saved.

Syntax:

updatedTest(t_sessionName t_testName)

useIncrementalChanged

When the options for incremental simulation are modified

Syntax:

useIncrementalChanged()

variablesUpdated

When variable values are updated

Syntax:

variablesUpdated(t_sessionName)


Return to top
 ⠀
X