PySide6.QtSerialBus.QCanMessageDescription¶

class QCanMessageDescription¶

The QCanMessageDescription class describes the rules to process a CAN message and represent it in an application-defined format. More…

Synopsis¶

Methods¶

def __init__()
def addSignalDescription()
def clearSignalDescriptions()
def comment()
def isValid()
def name()
def setComment()
def setName()
def setSignalDescriptions()
def setSize()
def setTransmitter()
def setUniqueId()
def signalDescriptionForName()
def signalDescriptions()
def size()
def swap()
def transmitter()
def uniqueId()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

A CAN message is basically a QCanBusFrame . The description of a CAN message includes the following:

Message ID.

Message name.

Message length in bytes.

Source of the message (transmitter).

Description of signals in the message.

The QCanMessageDescription class provides methods to control all those parameters.

Message ID¶

The message ID is a unique identifier, which is used to select the proper message description when decoding the incoming QCanBusFrame or encoding a QCanBusFrame based on the provided data.

See QCanUniqueIdDescription documentation for more details on the unique identifier description.

Signal Description¶

The signal description is represented by the QCanSignalDescription class. The QCanMessageDescription class only provides a list of signals that belong to the message.

See also

QCanSignalDescription QCanUniqueIdDescription

__init__()¶

Creates an empty message description.

__init__(other)

Parameters:: other – QCanMessageDescription

Creates a message description with the values copied from other.

addSignalDescription(description)¶

Parameters:: description – QCanSignalDescription

Adds a new signal description description to this message description.

If the message description already has a signal description for a signal with the same name, it is overwritten.

See also

signalDescriptions() signalDescriptionForName() setSignalDescriptions() clearSignalDescriptions()

clearSignalDescriptions()¶

Clears all the signal descriptions of this message.

See also

signalDescriptions() signalDescriptionForName() addSignalDescription() setSignalDescriptions()

comment()¶

Return type:: str

Returns the comment for the message.

This parameter is introduced only for extra description. It’s not used during message encoding or decoding.

See also

setComment()

isValid()¶

Return type:: bool

Returns true when the message description is valid and false otherwise.

A valid message description must have at least one signal description. All signal descriptions must be valid as well.

See also

signalDescriptions() isValid()

name()¶

Return type:: str

Returns the name of the CAN message.

This parameter is introduced only for extra description. It’s not used during message encoding or decoding.

See also

setName()

setComment(text)¶

Parameters:: text – str

Sets the comment for the message to text.

This parameter is introduced only for extra description. It’s not used during message encoding or decoding.

See also

comment()

setName(name)¶

Parameters:: name – str

Sets the name of the CAN message to name.

This parameter is introduced only for extra description. It’s not used during message encoding or decoding.

See also

name()

setSignalDescriptions(descriptions)¶

Parameters:: descriptions – .list of QCanSignalDescription

Sets the descriptions of the signals belonging to this message description to descriptions.

Note

Message description must have signal descriptions with unique signal names, so if the descriptions list contains entries with duplicated names, only the last entry will be added.