RecordingConfig¶
- class RecordingConfig¶
- TRACE_MERGE_MODE_DEPRECATED_MDF3¶
Returns the constant used to specify the trace merge mode to the deprecated legacy MDF3 trace merge.
- Returns:
The constant
- Return type:
int
- TRACE_MERGE_MODE_MDF4_FILE_BASED¶
Returns the constant used to specify the trace merge mode ‘signal-based in general, but file-based for MDF4 traces’.
- Returns:
The constant
- Return type:
int
- TRACE_MERGE_MODE_SIGNAL_BASED¶
Returns the constant used to specify the trace merge mode ‘signal based’.
- Returns:
The constant
- Return type:
int
-
AppendSignalGroup(signalGroup, defaultRecordingGroup=
None, allowNewName=False)¶ Adds a signal group to the package. If no default recording group is given, a new recording group will be created.
- Parameters:
- signalGroup¶
The signal group to be added
- defaultRecordingGroup=
None¶ The default recording group of the signal group
- allowNewName : boolean¶
If True, a new name will be generated for the signal group if there already exists a signal group with the same name in the package. Default value is False, so an error will be raised if the name already exists.
- 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:
- GetAutoAssignSignalGroup()¶
Returns the special auto assign signal group. This signal group is available per default. Signals added to this group will be automatically assigned to matching existing signal groups during package execution.
- Returns:
The auto assign signal group
- Return type:
- GetSignalGroups()¶
Returns a list of all the signal groups within the package. Signals and signal recording groups are attributed to their corresponding signal group.
- Returns:
List of all the signal groups
- Return type:
list[
SignalGroup]
- GetSyncConfig()¶
Returns the synchronization configuration.
- Returns:
The synchronization configuration
- Return type:
- Raises:
ApiError – when synchronization is done in trace analysis. Please migrate package with
MigrateSyncConfig().
- GetTraceMergeFilePathExpression()¶
Returns the path expression of the file where the traces are merged into.
- Returns:
The path expression
- Return type:
str
- GetTraceMergeMode()¶
Returns the mode used to merged traces.
- Returns:
The mode. One of
RecordingConfig.TRACE_MERGE_MODE_SIGNAL_BASED,RecordingConfig.TRACE_MERGE_MODE_MDF4_FILE_BASED,RecordingConfig.TRACE_MERGE_MODE_DEPRECATED_MDF3- Return type:
int
- GetVariableRecordingGroup()¶
Returns the recording group representing recorded variables.
It can be used for the generic signal binding and trace synchronization of trace analyses as well as the assignment of recordings containing test case variables for the offline analysis.
- Returns:
The variable recording group
- Return type:
- IsRecordAllTestQuantities()¶
Returns whether all test quantities shall be recorded.
For each test quantity there must be an existing signal group whose name matches the test quantity’s system under test or whose contained signals address the same system under test.
- Returns:
True if all test quantities are recorded, else False.
- Return type:
bool
- IsRecordAllTestQuantitiesRecursive()¶
Returns whether test quantities shall be collected recursively (including test quantities from sub packages) if the option to record all test quantities is set.
- Returns:
True if test quantities shall be collected recursively.
- Return type:
bool
- IsTraceMergeActive()¶
Returns whether the merging of traces is activated.
- Returns:
Activation status of trace merge
- Return type:
boolean
- MigrateSyncConfig()¶
Migrates synchronization and MDF3 merge configuration from trace analyses to the recording configuration.
The migration tries to be robust against differing settings for synchronizations, but if a conflict cannot be handled the migration will fail. In this case, use
MigrateSyncConfigUsing().MDF3 merge and the adjustment of time axes in copied trace files will be set if any trace analysis uses them.
- Raises:
ApiError – when migration is not possible.
- MigrateSyncConfigUsing(traceAnalysis)¶
Migrates synchronization and MDF3 merge configuration from a specific trace analysis to the recording configuration.
- Parameters:
- traceAnalysis¶
Use configuration from this trace analysis as new configuration.
- RemoveSignalGroup(signalGroup)¶
Removes a signal group from the package. All relations to recording groups of the signal group will be lost.
- Parameters:
- signalGroup¶
The signal group to be removed
- SetRecordAllTestQuantities(value)¶
Sets whether all test quantities shall be recorded.
For each test quantity there must be an existing signal group whose name matches the test quantity’s system under test or whose contained signals address the same system under test.
- Parameters:
- value : bool¶
True if all test quantities shall be recorded.
- SetRecordAllTestQuantitiesRecursive(value)¶
Sets whether test quantities shall be collected recursively (including test quantities from sub packages) if the option to record all test quantities is set.
- Parameters:
- value : bool¶
True if test quantities shall be collected recursively.
-
SetTraceMergeActive(active=
True)¶ Enables or disables the merging of traces.
- Parameters:
- active : boolean¶
If set to False, trace merge will be deactivated. Otherwise trace merge will be activated.
- SetTraceMergeFilePathExpression(expression)¶
Sets the path expression of the file where the traces are merged into.
- Parameters:
- expression : str¶
The path expression