SignalBinding¶

class SignalBinding¶

Clone()¶

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:

A copy of this object

Return type:

SignalBinding

GetGenericSignal()¶

Get the bound generic signal.

Returns:

The generic signal. Can be None.

Return type:

GenericSignal

GetUnit()¶

Returns the default unit that will be used if a trace step (e.g. a plot) uses this signal.

Returns:

The default unit (default: “don’t care”)

Return type:

str

IsOptional()¶

Checks whether the bound generic signal is optionally bound to a recording signal.

Note:

The value True for this flag is only valid if the trace step template signal is marked as optional.

Returns:

True if it is optional, else False

Return type:

boolean

SetGenericSignal(genericSignal)¶

Set a new generic signal to be bound.

Parameters:

genericSignal¶

The generic signal

SetOptional(optional)¶

Set whether the bound generic signal is optionally bound to a recording signal.

Note:

The value True for this flag is only valid if the trace step template signal is marked as optional.

Parameters:

optional : boolean¶

The new value

SetUnit(unit)¶

Set the default unit that will be used if a trace step (e.g. a plot) uses this signal.

Parameters:

unit : str¶

The default unit (default: “don’t care”). Use None or ‘don’t care’ to set it to its default value.