RecordingGroup¶
- class RecordingGroup¶
Returned by
- RECORDING_MODE_AUTO¶
Returns the constant used to specify the recording mode ‘Auto-Start/Stop: complete test case’.
- Returns:
The constant
- Return type:
int
- RECORDING_MODE_AUTO_RESTRICTED¶
Returns the constant used to specify the recording mode ‘Auto-Start/Stop: without Pre-/Postcondition’.
- Returns:
The constant
- Return type:
int
- RECORDING_MODE_MANUAL¶
Returns the constant used to specify the recording mode ‘Manually’.
- Returns:
The constant
- Return type:
int
- RECORDING_MODE_TRIGGER¶
Returns the constant used to specify the recording mode ‘Trigger-Start/Stop’.
- Returns:
The constant
- Return type:
int
- AppendRecordingInfo(recordingInfo)¶
Adds a recording info to the recording group.
- Parameters:
- recordingInfo¶
The recording info 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:
- GetConditionalSignalNamesForTraceAnalyses()¶
Returns the list of signal names that can be optional or mandatory for running the trace analyses depending on the values of global constants.
- Returns:
The list of undetermined signal names.
- Return type:
list[str]
- GetErrorOnEmptyStart()¶
Returns whether starting this recording group will lead to an error if it has no signals to record. This option is set by default.
- Returns:
True if the start of the empty group will lead to an error, otherwise False.
- Return type:
bool
- GetErrorOnOnlyGenericSignals()¶
Returns whether starting this recording group will lead to an error if it consists of only generic signals. This option is set by default.
- Returns:
True if the start of group with mentioned characteristics will lead to an error, otherwise False.
- Return type:
bool
- GetErrorOnOnlyUndefinedSystemIdentifiers()¶
Returns whether starting this recording group will lead to an error if the mapping targets of all signals of the group refer to an undefined system identifier. This option is set by default.
- Returns:
True if the start of group with mentioned characteristics will lead to an error, otherwise False.
- Return type:
bool
- GetFilenameTemplate()¶
Returns the file name template of the recording group.
- Returns:
The file name template of the recording group.
- Return type:
str
- GetMandatorySignalNamesForTraceAnalyses()¶
Returns the list of signal names that are mandatory for running the trace analyses.
- Returns:
The list of mandatory signal names.
- Return type:
list[str]
- GetName()¶
Returns the name of a recording group.
- Returns:
the name
- Return type:
str
- GetOptionalSignalNamesForTraceAnalyses()¶
Returns the list of signal names that are optional for running the trace analyses.
- Returns:
The list of optional signal names.
- Return type:
list[str]
- GetPostStartTime()¶
Returns the configured post start time for the start trigger of the recording.
- Returns:
The post start time.
- Return type:
float
- GetPostStopTime()¶
Returns the configured post stop time for the stop trigger.
- Returns:
The post stop time.
- Return type:
float
- GetPreTriggerTime()¶
Returns the configured pre trigger time of the start trigger of the recording.
- Returns:
The pre trigger time.
- Return type:
float
- GetRecordingInfos()¶
Returns the recording infos of the recording group.
- Returns:
Recording infos
- Return type:
list[
RecordingInfo]
- GetRecordingMode()¶
Returns the recording mode of the recording group as one of the following constants:
- Returns:
The recording mode constant
- Return type:
int
- GetSignalGroup()¶
Returns the parent signal group.
- Returns:
The parent signal group
- Return type:
- GetStartTriggerCondition()¶
Returns the start trigger condition.
- Returns:
The start trigger condition
- Return type:
str
- GetStopTriggerCondition()¶
Returns the stop trigger condition.
- Returns:
The stop trigger condition
- Return type:
str
- RemoveRecordingInfo(recordingInfo)¶
Removes a recording info from the recording group.
- Parameters:
- recordingInfo¶
The recording info to be removed
- Raises:
ApiError: When recording info is not part of recording group
- SetErrorOnEmptyStart(value)¶
Sets whether starting this recording group will lead to an error if it has no signals to record.
- Parameters:
- value : bool¶
True if the start of the empty group shall lead to an error, otherwise False.
- SetErrorOnOnlyGenericSignals(value)¶
Sets whether starting this recording group will lead to an error if it consists of only generic signals.
- Parameters:
- value : bool¶
True if the start of group with mentioned characteristics shall lead to an error, otherwise False.
- SetErrorOnOnlyUndefinedSystemIdentifiers(value)¶
Sets whether starting this recording group will lead to an error if the mapping targets of all signals of the group refer to an undefined system identifier.
- Parameters:
- value : bool¶
True if the start of group with mentioned characteristics shall lead to an error, otherwise False.
- SetFilenameTemplate(template)¶
Sets the file name template of the recording group.
- Parameters:
- template : str¶
The new file name template of the recording group.
- SetPostStartTime(time)¶
Sets the post start time of the start trigger of the recording.
- Parameters:
- time : float¶
The post start time in seconds.
- SetPostStopTime(time)¶
Sets the post stop time of the stop trigger.
- Parameters:
- time : float¶
The post stop time in seconds.
- SetPreTriggerTime(time)¶
Sets the pre trigger time for the start trigger of the recording.
- Parameters:
- time : float¶
The pre trigger time in seconds.
- SetRecordingMode(value)¶
Sets the recording mode of the recording group to one of the following constants:
- Parameters:
- value : int¶
The recording mode constant