Product Documentation
Virtuoso Visualization and Analysis XL SKILL Reference
Product Version IC23.1, November 2023

awvAppendExpression

awvAppendExpression(
w_windowID
t_expr
l_context
[ ?expr l_exprList ]
[ ?index l_waveIndexList ]
[ ?color l_colorList ]
[ ?lineType l_lineTypeList ]
[ ?lineStyle l_lineStyleList ]
[ ?lineThickness l_lineThicknessList ]
[ ?showSymbols l_showList ]
[ ?dataSymbol l_symbolList ]
[ ?barBase t_barBase ]
[ ?barWidth t_barWidth ]
[ ?barShift t_barShift ]
[ ?subwindow x_subwindow ]
)
=> t / nil

Description

Evaluates the t_expr expression and adds the resulting waveforms to a subwindow.

The new waveforms are plotted in the same strip and y axis as their corresponding curve from l_waveIndexList. Also, the new waveforms are assigned the next lowest unassigned numbers. If l_waveIndexList contains curves 1 and 2, the curves resulting from the expression evaluation are numbered 3, 4, and so on.

Arguments

w_windowID

Waveform window ID.

t_expr

String containing an expression that is evaluated when the command is issued and reevaluated at the completion of each simulation in auto-update mode.

l_context

Data context for a particular simulation. If evaluating the expressions requires data generated during a simulation, you must specify this argument. Otherwise, specify nil.

?expr l_exprList

List of waveform names to be displayed in the trace legend.

?index l_waveIndexList

List of integer identifiers for existing waveform curves that were plotted with one of the Waveform Window plot functions.

?color l_colorList

List of colors for the waveforms. Available colors are defined in your technology file. Valid values are from y1 through y66.

If you do not specify this argument, default colors are used.

?lineType l_lineTypeList

List specifying the type of line to be used for the waveforms.

Valid values are line, bar, scatterPlot, poleZero.

If you do not specify this argument, default value line is used.

?lineStyle l_lineStyleList

List specifying the line style to used for the waveforms.

Valid values are solid, dash, dot, dashDot, and dashDotDot.

If you do not specify this argument, default value solid is used.

?lineThickness l_lineThicknessList

List specifying the line thickness of the waveforms.

Valid values are fine, medium, thick, and extraThick.

If you do not specify this argument, default value fine is used.

?showSymbols l_showList

List of flags that specify whether to show the symbols on the waveforms. Valid values are t and nil.

The default value is nil, which means that symbols are not displayed on the waveforms.

The number of flags in the l_showList must match the number of symbols in the l_symbolList.

?dataSymbol l_symbolList

List of symbols to be displayed for data points on the waveforms.

To use a symbol, specify an integer or a single character corresponding to the symbol.

?barBase t_barBase

Base of the bar.

?barWidth t_barWidth

Width of the bar.

This argument takes integer values. The default value is 1.

?barShift t_barShift

Specifies whether to shift the bar ahead or backwards when the ?lineType argument is set to bar. This argument takes integer values.

Positive integer shifts the bar backwards and negative integer shifts the bar forward.

The default value is 0, which indicates that bar is not shifted.

?subwindow x_subwindow

Identification number of the subwindow, which is found in the top-right corner of the subwindow.

If you do not specify this argument, the current subwindow is used.

Value Returned

t

Expression t_expr is evaluated successfully and the resulting waveforms are added to Waveform window.

nil

Expression cannot be evaluated because of an error.

Examples

The following example creates a Waveform window and returns its window ID.

awvCreatePlotWindow()
=> window:3

The following example evaluates the expression sin(x) from x=-14.0 to x=17. The expression is evaluated at x=-14.0, -13.5, -13.0,...,16.0, 16.5, and 17.0. The resulting waveform is labeled sine in the Waveform window, and displayed in the y6 layer color.

awvAppendExpression(
     window(3)
     "expr(x sin(x) linRg(-14 17 0.5))"
     nil
     ?expr list("sine")
     ?color list("y6")
     ?lineType list("line")
     ?lineStyle list("solid")
     ?lineThickness list("thick")
     ?showSymbols list(t)
     ?dataSymbol list("x")
     )
=> t

Related Topics

Symbols for Data Points


Return to top
 ⠀
X