Documentation Center

  • Trial Software
  • Product Updates

addWave

System object: dsp.LogicAnalyzer
Package: dsp

Add wave corresponding to specified input

Syntax

waveTag = addWave(H)
waveTag = addWave(H,'Name',Value)

Description

waveTag = addWave(H) adds in a wave corresponding to the specified input channel. A tag value is returned back, which can be used to modify and delete the wave.

waveTag = addWave(H,'Name',Value) adds in a wave with each specified property Name set to the specified value. You can specify NameValue arguments in any order.

Input Arguments

expand all

H — The Logic Analyzer object to which you want to add a wavedsp.LogicAnalyzer object

Example: 'addWave(H)' adds a wave with the default characteristics.

Example: 'H.addWave()' adds a wave with the default characteristics.

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (' '). You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'InputChannel',2,'Color','Blue' specifies that a wave should be added to input channel 1 and colored blue.

'Color' — Color of the wavestring enumeration

Specify as a string the color of the display from one of the following options:

  • 'Black'

  • 'Blue'

  • 'Cyan'

  • 'Default'

  • 'Green'

  • 'Magenta'

  • 'Red'

  • 'White'

  • 'Yellow'

When you choose 'Default', the value of the DisplayChannelColor property in the Logic Analyzer is used.

Example: 'Color','Blue'

Data Types: char

'DisplayChannel' — Channel on the display that shows this wavescalar numeric value in the range (1,NumInputPorts)

Specify as a scalar numeric value the display channel that shows this wave. By default, the wave is added to the end of the display.

Example: 'DisplayChannel',2

Data Types: double | single | uint8 | uint16 | uint32 | uint64 | int8 | int16 | int32 | int64

'FontSize' — Font size for values in the wavescalar nonnegative integer

Specify as a scalar nonnegative integer the font size in points. When you choose 0, the value of the DisplayChannelFontSize property in the Logic Analyzer is used.

Example: 'FontSize',8

Data Types: double

'Format' — Display format for the wavestring enumeration

Specify as a string the wave format from one of the following options:

  • 'Analog'

  • 'Default'

  • 'Digital'

When you choose 'Default', the value of the DisplayChannelFormat property in the Logic Analyzer is used.

Example: 'Format','Digital'

Data Types: char

'Height' — Height of the wavescalar integer

Specify as a scalar integer the height of the wave in the display in units of 16 pixels. When you choose 0, the value of the DisplayChannelHeight property in the Logic Analyzer is used.

Example: 'Height',2

Data Types: double

'InputChannel' — Input channel that corresponds to this wavescalar integer in the range (1,NumInputPorts)

This property specifies the input channel whose data is used for this wave. By default, it will connect the first input to this wave.

Example: 'InputChannel',2

Data Types: double | single | uint8 | uint16 | uint32 | uint64 | int8 | int16 | int32 | int64

'Name' — The name or label for the wavestring

Specify as a string the name that you would like to set for the new wave.

Example: 'Name','MyWave'

Data Types: char

'Radix' — Radix for the wavestring enumeration

Specify as a string the radix of the display from one of the following options:

  • 'Binary'

  • 'Default'

  • 'Hexadecimal'

  • 'Octal'

  • 'Signed decimal'

  • 'Unsigned decimal'

When the input signals are of class double, single, or logical, you should not set this property. When you choose 'Default', the value of the DisplayChannelRadix property in the Logic Analyzer is used.

Example: 'Radix','Hexadecimal'

Data Types: char

Was this topic helpful?