SignalRecording¶
- class SignalRecording¶
Returned by
- AddGenericSignal(genSig)¶
Adds a generic signal to this signal recording.
- Parameters:
- genSig¶
A generic signal
- AddGenericSignalByName(name)¶
Adds a generic signal by name to this signal recording.
- Parameters:
- name : str¶
The name of the generic signal
- AppendTraceStep(traceStep)¶
Adds a trace step at the end of its children.
- Parameters:
- traceStep¶
Trace step 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:
-
EnableCompression(enable=
True)¶ Sets whether data should be compressed. Compression is only applied to MDF4 file format!
- Parameters:
- enable : boolean¶
True if data compression should be applied else False.
- GetCsvFormatDetailsString()¶
Returns the CSV format details string.
- Return type:
str
- Returns:
the FormatDetails
- GetDescription()¶
Returns the description of the trace analysis element.
- Returns:
The description
- Return type:
str
- GetFileExpression()¶
Returns the file expression of the trace file.
- Returns:
The path expression
- Return type:
str
- GetGenericSignalNames()¶
Returns the names of the generic signals that are registered for signal recording.
- Returns:
List of generic signal names
- Return type:
list[str]
- GetIndex()¶
Returns the zero based index in the parent.
- Returns:
Zero based index
- Return type:
int
- GetLineNo()¶
Returns the trace steps line number within its trace analysis.
- Returns:
Line number
- Return type:
int
- GetName()¶
Returns the name of the trace analysis element.
- Returns:
The name
- Return type:
str
- GetRecordAllSignals()¶
Returns whether all available signals are recorded.
- Returns:
recordAllSignals
- Return type:
boolean
- GetSignalNameType()¶
Returns which kind of name for the signal names is shown in the plot.
- Returns:
‘generic’, ‘mapping’, ‘mappingtarget’ or ‘file’
- Return type:
str
- GetStoreType()¶
Returns the type of the file format.
- Returns:
The type of the file format. ‘CSV’, ‘MDF3’, ‘MDF4’ or ‘ASTRACE’.
- Return type:
str
- GetTags()¶
Returns the tags set for this step.
- Returns:
A (sorted) list of tags
- Return type:
list[str]
-
GetTraceSteps(skipDisabledSteps=
False, recursive=False)¶ Returns either direct or all children of the trace step.
- GetType()¶
Returns the type (class name) of the trace step, e.g.
‘Episode’
‘AnalysisBlock’
‘TriggerBlock’
‘Calculation’
‘TemplateBasedTraceStep’
‘TraceAnalysisReference’
‘TraceAnalysisReferenceDeprecated’
- Returns:
Type (class name) of the trace step
- Return type:
str
- GetUuid()¶
Returns the UUID of the trace step.
- Returns:
UUID of the trace step
- Return type:
str
- IsCompressionEnabled()¶
Returns whether the data compression is enabled. Compression is only applied to MDF4 file format!
- Returns:
True if compression is enabled else False.
- Return type:
boolean
- IsContainer()¶
Checks whether this trace step can contain trace steps.
- Returns:
True if it can contain trace steps, else False
- Return type:
boolean
- IsEnabled()¶
Checks whether the trace step is enabled.
- Returns:
True if trace step is enabled, else False
- Return type:
boolean
- IsOk()¶
Returns the internal state of correctness of the trace step.
- Returns:
True if no problems were found, else False
- Return type:
boolean
- IsVisible()¶
Checks whether the trace step is visible. This depends on the trace step itself or a parent trace step being disabled.
- Returns:
True if trace step is visible, else False
- Return type:
boolean
- RemoveGenericSignal(genSig)¶
Removes a generic signal from the signal recording.
- Parameters:
- genSig¶
Generic signal to be removed
- Raises:
ApiError – When the given generic signal is not part of the signal recording
- RemoveGenericSignalByName(name)¶
Removes a generic signal by name from the signal recording.
- Parameters:
- name : str¶
Name of the generic signal to be removed
- Raises:
ApiError – When the given generic signal is not part of the signal recording
- RemoveTraceStep(traceStep)¶
Removes the given trace step from the trace analysis.
- Parameters:
- traceStep¶
Trace step to be removed
- SetCsvFormatDetailsString(formatDetails)¶
Sets the CSV format details.
The format details define which characters will be used for the column separator, the decimal separator, and the thousand separator.
The default csvFormatDetailsString is
"columnSeparator: ';', decimalSeparator: '.', thousandSeparator: ''".Info
Not all parameters must be contained in the string as the missing parameters are set to the defaults.
Info
This method ignores the entries “headLineNumber” and “timeColumn” if they exist in the csvFormatDetailsString.
- Parameters:
- formatDetails : str¶
the FormatDetails
- SetDescription(value)¶
Sets the description of the trace analysis element.
- Parameters:
- value : str¶
The new description
- SetEnabled(enable)¶
Enables or disables the trace step (this also affects child trace steps).
- Parameters:
- enable : boolean¶
If True, enables the trace step, if False, disables the trace step
- SetFileExpression(expression)¶
Sets the file expression of the trace file.
- Parameters:
- expression : str¶
The path expression
- SetGenericSignalNames(genericSignalNames)¶
Sets the names of the generic signals to be recorded in this signal recording.
- Parameters:
- genericSignalNames : list[str]¶
-
SetRecordAllSignals(recordAllSignals=
True)¶ Sets whether all available signals are recorded (default=True).
- Parameters:
- recordAllSignals : boolean¶
new value (default=True)
- SetSignalNameType(signalNameType)¶
Sets which kind of names for the signals are shown in the plot.
- Parameters:
- signalNameType : str¶
‘generic’, ‘mapping’, ‘mappingTarget’ or ‘file’ - ‘generic’: name of the generic signal - ‘mapping’: name of the signal in the mapping view - ‘mappingtarget’: name of mapping target of the signal - ‘file’: name of the signal in the recording file