SignalGroup¶
- class SignalGroup¶
API to access signal groups. Signals of a signal group are represented by references to mapping items.
Returned by
- AppendMappingItem(mappingItem)¶
Adds a mapping item to the signal group.
- Parameters:
- mappingItem¶
The mapping item to be added
- AppendRecordingGroup(recordingGroup)¶
Adds a recording group to the signal group.
- Parameters:
- recordingGroup¶
The recording group to be added
- 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:
- GetDescription()¶
Returns the description of the signal group.
- Returns:
The description of the signal group.
- Return type:
str
- GetMappingItemNames()¶
Returns the names of all the mapping Items within the signal group.
- Returns:
List of all the mapping item names
- Return type:
list[str]
- GetMappingItems()¶
Returns a list of all resolved mapping items (representing the signals) within the signal group. Mapping items can be a part of the package’s mapping or of the global mapping if any is loaded.
- Returns:
List of all resolved mapping items.
- Return type:
list[
MappingItem]
- GetMeasurementListFile()¶
Returns the path to the measurement list file (.xam).
- Returns:
Returns the absolute path to the measurement list file.
- Return type:
str
- GetName()¶
Returns the name of the signal group.
- Returns:
The name
- Return type:
str
- GetRecordingGroupNames()¶
Returns the names of all the recording groups within the signal group.
- Returns:
List of all the recording group names
- Return type:
list[str]
- GetRecordingGroups()¶
Returns a list of all the signal recording groups within the signal group.
- Returns:
List of all the signal recording groups
- Return type:
list[
RecordingGroup]
- RemoveMappingItem(mappingItemName)¶
Removes a mapping item from the signal group.
- Parameters:
- mappingItemName : str¶
The mapping item name
- RemoveMeasurementListFile()¶
Removes the measurement list file (.xam) from the signal group.
- RemoveRecordingGroup(recordingGroup)¶
Removes a recording group from the signalGroup.
- Parameters:
- recordingGroup¶
The recording group to be removed
- SetDescription(description)¶
Sets the description of the signal group.
- Parameters:
- description : str¶
The new description of the signal group.
-
SetMeasurementListFile(path, namespace=
None)¶ Sets a measurement list file to the signal group.
- Parameters:
- path : str¶
The filepath to the measurement list file (.xam)
- namespace : str¶
Identifier of the workspace to which a relative filePath is resolved. If not present or None, the namespace is determined automatically. It is also possible to reference a library workspace using its namespace. A relative filePath is resolved relative to the parameters directory of the given namespace. For example, the namespace parameter ‘myLibrary’ results in ‘<libraries.myLibrary.parameters>/MyMapping.xam’.