SyncConfig¶
- class SyncConfig¶
- AssignAutosarTimeSynchronization(recordingGroup, masterGroup)¶
Assigns an AUTOSAR Time Synchronization that synchronizes recordingGroup with masterGroup. If there is already a synchronization assigned to recordingGroup it will be unassigned.
- Parameters:
- Returns:
Returns the newly created AUTOSAR Time Synchronization
- Return type:
- AssignCrossCorrelationSynchronization(recordingGroup, masterGroup)¶
Assigns a cross correlation synchronization that synchronizes recordingGroup with masterGroup. If there is already a synchronization assigned to recordingGroup it will be unassigned.
- Parameters:
- Returns:
Returns the newly created cross correlation synchronization
- Return type:
- AssignEqualnessMatchingSynchronization(recordingGroup, masterGroup)¶
Assigns an equalness matching synchronization that synchronizes recordingGroup with masterGroup. If there is already a synchronization assigned to recordingGroup it will be unassigned.
- Parameters:
- Returns:
Returns the newly created equalness matching synchronization
- Return type:
- AssignExpectationSynchronization(recordingGroup, masterGroup)¶
Assigns an expectation synchronization that synchronizes recordingGroup with masterGroup. If there is already a synchronization assigned to recordingGroup it will be unassigned.
- Parameters:
- Returns:
Returns the newly created expectation synchronization
- Return type:
- AssignLeastSquaresSynchronization(recordingGroup, masterGroup)¶
Assigns a least squares synchronization that synchronizes recordingGroup with masterGroup. If there is already a synchronization assigned to recordingGroup it will be unassigned.
- Parameters:
- Returns:
Returns the newly created least squares synchronization
- Return type:
- AssignOffsetSynchronization(recordingGroup, masterGroup)¶
Assigns an offset synchronization that synchronizes recordingGroup with masterGroup. If there is already a synchronization assigned to recordingGroup it will be unassigned.
- Parameters:
- Returns:
Returns the newly created offset synchronization
- Return type:
- AssignUtcTimestampSynchronization(recordingGroup, masterGroup)¶
Assigns a cross correlation synchronization that synchronizes recordingGroup with masterGroup. If there is already a synchronization assigned to recordingGroup it will be unassigned.
- Parameters:
- Returns:
Returns the newly created UtcTimestamp synchronization
- Return type:
- 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:
- GetAdjustTimeInTraceCopy()¶
Returns whether the trace files are copied to the report directory with time axes adjusted according to sync delta T determined by synchronization.
- Returns:
True if the synchronized copies of the trace files are generated, else False
- Return type:
boolean
- GetContinueOnError()¶
Returns whether the trace merge and trace analysis should continue after an error occurred during the synchronization.
- Returns:
True to continue after a synchronization error, else False
- Return type:
bool
- GetMaster()¶
Returns the master recording group.
- Returns:
The master recording group
- Return type:
- GetMasterName()¶
Returns the name of the master recording group.
- Returns:
The name of the master recording group
- Return type:
str
- GetSynchronization(recordingGroup)¶
Returns the assigned synchronization for the given recording group.
- Parameters:
- recordingGroup¶
The recording group
- Returns:
The assigned synchronization. Returns None if no synchronization is set.
- Return type:
- GetSynchronizations()¶
Returns the list synchronizations.
- Returns:
The list of synchronizations
- Return type:
list[
Synchronization]
- GetUseEndOfTestSnapshot()¶
Returns whether the variable and global constant values at the end of the test case will be used when evaluating the synchronization.
This setting defaults to False. So for each synchronization the values depend on the point of time at which the last recording of a group of recordings to synchronize is collected/created. This behavior is mostly important when using Start/StopTrace or AddTrace and the test case.
- Returns:
True, to use only the variable and global constant values at the end of the test case, else False
- Return type:
boolean
- IsActive()¶
Returns whether the synchronization is active. By default, for a newly created trace analysis the synchronization is not active.
- Returns:
True if the synchronization is active, else False
- Return type:
boolean
-
SetActive(active=
True)¶ Activates or deactivates the synchronization.
- Parameters:
- active : boolean¶
True will activate and False will deactivate the synchronization
- SetAdjustTimeInTraceCopy(value)¶
Sets whether the trace files should be copied to the report directory with time axes adjusted according to sync delta T determined by synchronization.
- Parameters:
- value : boolean¶
True if the synchronized copies of the trace files are generated, else False
- SetContinueOnError(value)¶
Sets whether the trace merge and trace analysis should continue after an error occurred during the synchronization. If so, all traces will be used unsynchronized.
- Parameters:
- value : bool¶
True to continue after a synchronization error, else False
- SetMaster(recordingGroup)¶
Sets the master recording group. If there is a synchronization assigned to the recording group it will be deleted.
- Parameters:
- recordingGroup¶
The master recording group
- SetUseEndOfTestSnapshot(value)¶
Sets whether the variable and global constant values at the end of the test case will be used when evaluating the synchronization.
This setting defaults to False. So for each synchronization the values depend on the point of time at which the last recording of a group of recordings to synchronize is collected/created. This behavior is mostly important when using Start/StopTrace or AddTrace and the test case.
- Parameters:
- value : boolean¶
True, to use only the variable and global constant values at the end of the test case, else False