PySide6.QtSerialBus.QCanMessageDescription¶

class QCanMessageDescription¶

QCanMessageDescription 类描述了处理CAN消息并将其表示为应用程序定义格式的规则。更多…

概要¶

方法¶

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()

注意

本文档可能包含从C++自动翻译到Python的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译问题，您也可以通过在我们的https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们。

详细描述¶

CAN消息基本上是一个QCanBusFrame。CAN消息的描述包括以下内容：

消息ID。

消息名称。

消息长度（以字节为单位）。

消息的来源（发送者）。

消息中信号的描述。

QCanMessageDescription 类提供了控制所有这些参数的方法。

消息ID¶

消息ID是一个唯一标识符，用于在解码传入的QCanBusFrame或基于提供的数据编码QCanBusFrame时选择正确的消息描述。

有关唯一标识符描述的更多详细信息，请参阅QCanUniqueIdDescription文档。

信号描述¶

信号描述由QCanSignalDescription类表示。QCanMessageDescription类仅提供属于消息的信号列表。

另请参阅

QCanSignalDescription QCanUniqueIdDescription

__init__()¶

创建一个空的消息描述。

__init__(other)

Parameters:: 其他 – QCanMessageDescription

创建一个消息描述，其值从other复制而来。

addSignalDescription(description)¶

Parameters:: 描述 – QCanSignalDescription

向此消息描述中添加一个新的信号描述 description。

如果消息描述已经有一个同名的信号描述，它将被覆盖。

另请参阅

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

clearSignalDescriptions()¶

清除此消息的所有信号描述。

另请参阅

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

comment()¶

Return type:: 字符串

返回消息的评论。

此参数仅用于额外描述。在消息编码或解码期间不使用。

另请参阅

setComment()

isValid()¶

Return type:: 布尔

当消息描述有效时返回true，否则返回false。

有效的消息描述必须包含至少一个信号描述。所有信号描述也必须是有效的。

另请参阅

signalDescriptions() isValid()

name()¶

Return type:: 字符串

返回CAN消息的名称。

此参数仅用于额外描述。在消息编码或解码过程中不使用。

另请参阅

setName()

setComment(text)¶

Parameters:: 文本 – str

设置消息的注释为 text。

此参数仅用于额外描述。在消息编码或解码期间不使用。

另请参阅

comment()

setName(name)¶

Parameters:: name – str

设置CAN消息的名称为name。

此参数仅用于额外描述。在消息编码或解码期间不使用。

另请参阅

name()

setSignalDescriptions(descriptions)¶

Parameters:: 描述 – .list of QCanSignalDescription

将属于此消息描述的信号描述设置为descriptions。

注意

消息描述必须包含具有唯一信号名称的信号描述，因此如果descriptions列表包含具有重复名称的条目，则只会添加最后一个条目。

另请参阅

signalDescriptions() signalDescriptionForName() addSignalDescription() clearSignalDescriptions()

setSize(size)¶

Parameters:: size – int

将CAN消息的大小设置为size字节。

另请参阅

size()

setTransmitter(transmitter)¶

Parameters:: transmitter – str

将消息的发送节点设置为 transmitter。

此参数仅用于额外描述。在消息编码或解码过程中不使用。

另请参阅

transmitter()

setUniqueId(id)¶

Parameters:: id – UniqueId

将CAN消息的唯一标识符设置为id。

请参阅Message ID部分以获取有关唯一标识符的更多信息。

另请参阅

uniqueId()

signalDescriptionForName(name)¶

Parameters:: name – str
Return type:: QCanSignalDescription

返回名称为name的信号的描述。

如果消息描述没有这样的信号描述，则返回一个默认构造的QCanSignalDescription对象。

另请参阅

signalDescriptions() addSignalDescription() setSignalDescriptions() clearSignalDescriptions()

signalDescriptions()¶

Return type:: QCanSignalDescription的列表

返回属于此消息描述的信号描述列表。

另请参阅

signalDescriptionForName() addSignalDescription() setSignalDescriptions() clearSignalDescriptions()

size()¶

Return type:: 整数

返回CAN消息的大小（以字节为单位）。

另请参阅

setSize()

swap(other)¶

Parameters:: 其他 – QCanMessageDescription

transmitter()¶

Return type:: 字符串

返回消息的发送节点。

此参数仅用于额外描述。在消息编码或解码过程中不使用。

另请参阅

setTransmitter()

uniqueId()¶

Return type:: UniqueId

返回CAN消息的唯一标识符。

请参阅Message ID部分以获取有关唯一标识符的更多信息。

另请参阅

setUniqueId()