GenericSignal¶

class GenericSignal¶

Returned by

TraceAnalysisApi.CreateGenericSignal

AssignMappingItem(mappingItemName)¶

Assigns the mapping item with the given name to the generic signal.

Note:

This method is only valid for analysis packages (type AnalysisPackage)!

Parameters:

mappingItemName : str¶: The name of a valid mapping item.

AssignRecordingSignal(recordingGroup, mappingItemName)¶

Assigns a signal of recording group to the generic signal by specifying a recording group and a valid mapping item name of the parent signal group.

Note:

This method is only valid for packages (type Package)!

Parameters:

recordingGroup¶: The recording group of the signal
mappingItemName : str¶: The name of signal to be assigned. It has to be a signal contained in the parent signal group of the recording group.

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:: GenericSignal

GetAssignedMappingItemName()¶

Returns the name of the mapping item of the recoding group signal assigned to the generic signal.

Returns:: Name of the assigned mapping item.
Return type:: str

GetAssignedRecordingGroupName()¶

Returns the name of the recording group the assigned recoding group signal belongs to, if there is any mapping item assigned to the generic signal.

Returns:: Name of the recording group the assigned recoding group signal belongs to.
Return type:: str

GetDefaultUnit()¶

Returns the string representation of the default unit that will be used if a trace step (e.g. a plot) uses this signal.

Note:: The default unit will not be used if the generic signal is calculated or it is not interpreted as number.
Returns:: The default unit (default: ‘don’t care’)
Return type:: str

GetName()¶

Returns the name of the generic signal.

Returns:: The name
Return type:: str

GetSignalType()¶

Returns the signal type to be read.

Returns:: The signal type. Possible values: “PHY”, “RAW”, “STR”
Return type:: string

IsCalculated()¶

Returns whether the generic signal is calculated during the trace analysis.

Returns:: True, if the signal is calculated
Return type:: bool

IsIncoming()¶

Returns whether the generic signal is configured as an incoming signal in the associated trace analysis.

Returns:: True if the signal is incoming, otherwise False.
Return type:: bool

IsOptional()¶

Returns whether this generic signals optional flag is set.

Note:: This flag will be used for trace steps that have no own option to mark a signal as optional. If this flag is set, it is valid that a signal is not found in a recording or the mapping path could not be resolved.
Returns:: The optional flag
Return type:: boolean

IsOutgoing()¶

Returns whether the generic signal is configured as an outgoing signal in the associated trace analysis.

Returns:: True if the signal is outgoing, otherwise False.
Return type:: bool

SetDefaultUnit(unit)¶

Set the default unit that will be used if a trace step (e.g. a plot) uses this signal, by the given string representation (e.g. ‘km/h’).

Note:

The default unit will not be used if the generic signal is calculated or it is not interpreted as number.

Parameters:

unit : str¶: The default unit (default: ‘don’t care’). Use None or ‘don’t care’ to set it to its default value.

SetName(name)¶

Sets the name of the generic signal.

Parameters:

name : str¶: The new name

SetOptional(optional)¶

Set the optional flag for the generic signal.

Note:

This flag will be used for trace steps that have no own option to mark a signal as optional. If this flag is set, it is valid that a signal is not found in a recording or the mapping path could not be resolved.

Parameters:

optional : boolean¶: The new value

SetSignalType(signalType)¶

Set the signal type to be read.

Parameters:

signalType : string¶: The signal type: possible values: “PHY”, “RAW”, “STR”