VariableRecordingGroup¶
- class VariableRecordingGroup¶
- 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]
- 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]
- 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
- 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