awvSetWaveNameList

awvSetWaveNameList(
l_traceNumbers
l_traceNames
)
=> t / nil

Description

Sets the names of the waveforms associated with the specified trace numbers.

You can use the awvGetWaveNameList function to return the name and numbers of the waveforms plotted in a subwindow of the specified Waveform window.

Arguments

l_traceNumbers	A list containing trace numbers of the waveforms whose names to be set. The number of items in the list l_traceNumbers must exactly match with those in the list l_traceNames.
l_traceNames	A list containing the waveform names to be set to the specified trace numbers. The number of items in the list l_traceNumbers must exactly match with those in the list l_traceNames.

Value Returned

t	A list containing numbers and names of the waveforms.
nil	Either none of the specified trace numbers exists or number of items in the lists l_traceNumbers and l_traceNames does not match.

Examples

The following example returns a list of trace numbers and names of the waveforms plotted in subwindow 4 of the current Waveform window.

awvGetWaveNameList(awvGetCurrentWindow() ?subwindow 4)

=>

((5 6 7) 

    ("net35" "jitter" "out")

)

Waveform net35, jitter, and out waveforms are identified with trace numbers 5, 6, and 7 respectively.

The following example sets the name of the waveforms jitter (trace number 6), net35 (trace number 5), and out (trace number 7) to wave6, wave5, and wave7.

awvSetWaveNameList(list(list(6 5 7) list("wave6" "wave5" "wave7")))

=> t

Return to top