AutoAssignSignalGroup¶
- class AutoAssignSignalGroup¶
API to access the auto assign signal group. Signals of a signal group are represented by references to mapping items. This signal group is available per default. Signals added to this group will be automatically assigned to matching existing signal groups during package execution.
- AppendMappingItem(mappingItem)¶
Adds a mapping item to the signal group.
- Parameters:
- mappingItem¶
The mapping item to be added
- 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]
- GetName()¶
Returns the name of the signal group.
- Returns:
The name
- Return type:
str
- GetRecordingGroup()¶
Returns the recording group of the auto assign signal group. This group is needed to bind signals to trace analyses.
- Returns:
The auto assign recording group
- Return type:
- RemoveMappingItem(mappingItemName)¶
Removes a mapping item from the signal group.
- Parameters:
- mappingItemName : str¶
The mapping item name
- SetDescription(description)¶
Sets the description of the signal group.
- Parameters:
- description : str¶
The new description of the signal group.