BusSignalMappingItem¶

class BusSignalMappingItem¶

Returned by

• MappingApi.CreateBusSignalWithPduMappingItem

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:

BusSignalMappingItem

GetAccessType()¶

Returns a string identifying the mapping item’s type. (such as MODEL, BUS, MEASUREMENT, …)

Returns:

access type

Return type:

str

GetCategory()¶

Returns the category

Returns:

Category

Return type:

str

GetDescription()¶

Returns the description

Returns:

Description

Return type:

str

GetDisplayedType()¶

Returns a “nice” representation of the type as displayed in the “type” column of the mapping panel

Returns:

the displayed mapping type

Return type:

str

GetFrameName()¶

Returns the name of the frame containing the signal.

Returns:

Name of the frame containing the signal or empty string if no frame name is set

Return type:

str

GetNodeName()¶

Returns the name of the sending ECU.

Returns:

Name of the sending ECU or empty string if no node name is set

Return type:

str

GetPduName()¶

Returns the name of the PDU containing the signal.

Returns:

Name of the PDU containing the signal or empty string if no PDU name is set

Return type:

str

GetReferenceName()¶

Returns the reference name of the mapping.

Returns:

The reference name of the mapping

Return type:

str

GetSignalManipulationFrameCount()¶

Returns the manipulation parameters. Can only be used for bus signals!

Returns:

SignalManipulation. Possible values:

• 0: signal manipulation is permanent

• n>0: signal is manipulated for n frames

Return type:

int

GetSignalName()¶

Returns the name of the signal. :return: Name of the signal :rtype: str

GetSubMapping()¶

Returns contained Mapping or None if item does not support sub-mappings.

Returns:

Mapping with all submappings of the mapping item

Return type:

Mapping

GetSystemIdentifier()¶

Returns the system identifier providing the currently mapped test quantity

Returns:

system identifier

Return type:

str

GetTargetPath()¶

Returns the path this mapping item is currently pointing at

Returns:

complete path to the destination test quantity

Return type:

str

GetUseManipulationPortForSignalReadingRecording()¶

Returns the activation state to use the selected manipulation port for test step ‘Read’ and/or the recording of the bus signal. Can only be used for bus signals!

Returns:

usage of the manipulation port. Possible values:

• True: The manipulation port will be used to read or record the bus signal.

• False: The activation port will be used to read or record the bus signal.

Return type:

boolean

GetVariableType()¶

Returns the type of the target variable or None if target has no type.

Returns:

The type of the target variable. (e.g. VALUE, MATRIX, CURVE, …)

Return type:

str

IsAutogenerated()¶

Returns whether the mapping item is autogenerated.

Returns:

True, if autogenerated flag is set, else False

Return type:

boolean

SetAutogenerated(value=True)¶

Sets whether the mapping item is autogenerated.

Parameters:

value : boolean¶

The new state.

SetCategory(category)¶

Sets the category

Parameters:

category : str¶

The new category to be used

SetDescription(description)¶

Sets the description

Parameters:

description : str¶

The new description to be used

SetFrameName(frameName)¶

Sets the name of the frame containing the signal.

Parameters:

frameName : str¶

Name of the frame containing the signal

SetNodeName(nodeName)¶

Sets the name of the sending ECU.

Parameters:

nodeName : str¶

Name of the sending ECU

SetPduName(pduName)¶

Sets the name of the PDU containing the signal.

Parameters:

pduName : str¶

Name of the PDU containing the signal

SetReferenceName(name, updateTestSteps=False)¶

Sets the reference name of the mapping.

Parameters:

name : str¶

The reference name of the mapping

updateTestSteps : bool¶

update all usages of this mapping item. Throws an error if it is used in a global mapping or if it is not yet part of a mapping space.

SetSignalManipulationFrameCount(value=0)¶

Sets the manipulation parameters. Can only be used for bus signals!

Parameters:

value : int¶

The value to be used. Possible values:

• 0: permanent

• n>0: signal is manipulated for n frames

SetSignalName(signalName)¶

Sets the name of the signal. :param signalName: Name of the signal :type signalName: str

SetUseManipulationPortForSignalReadingRecording(value=False)¶

Sets the activation state to use the selected manipulation port for test step ‘Read’ and/or the recording of the bus signal. Can only be used for bus signals!

Parameters:

value : boolean¶

The value to be used. Possible values:

• True: The manipulation port will be used to read or record the bus signal.

• False: The activation port will be used to read or record the bus signal.

GetSignalManipulation()¶

Returns the manipulation parameters. Can only be used for bus signals!

Returns:

SignalManipulation. Possible values:

• None: signal manipulation is disabled for reading and recording

• 0: signal manipulation is permanent

• n>0: signal is manipulated for n frames

Return type:

int

Deprecated since version 2024.4: Use GetSignalManipulationFrameCount() and GetUseManipulationPortForSignalReadingRecording() instead

SetSignalManipulation(value=None)¶

Sets the manipulation parameters. Can only be used for bus signals!

Parameters:

value : int¶

The value to be used. Possible values:

• None: disable manipulation for reading and recording

• 0: permanent

• n>0: signal is manipulated for n frames

Deprecated since version 2024.4: Use SetSignalManipulationFrameCount() and SetUseManipulationPortForSignalReadingRecording() instead