SignalGroupReference¶

class SignalGroupReference¶

A signal group reference of the AnalysisBindings between a stimulation package and its attached analysis packages containing manually assigned signals.

AppendSignal(mappingItem)¶

Assigns a signal to the signal group. The signal is defined by the given mapping item. Its name and target variable are adopted.

Mapping items can be created using the MappingApi.

Parameters:

mappingItem¶

The mapping item whose information is used to create and append the manually assigned signal.

AppendTraceFileSignal(referenceName, targetPath)¶

Convenience method that works like AppendSignal() without the necessity to create a mapping item first. Instead, referenceName and targetPath are passed directly to address a trace file signal.

Parameters:

referenceName : str¶

Name of the mapping item

targetPath : str¶

Path to the trace file signal to be accessed

Clear()¶

Removes all manually assigned signals from this signal group reference.

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:

SignalGroupReference

GetName()¶

Returns the name of the given signal group.

Returns:

Signal group name.

Return type:

str

GetSignals()¶

Returns all signals manually assigned to the given signal group reference.

Returns:

List of signals manually assigned to signal group reference.

Return type:

list[AssignedSignal]