QCanSignalDescription Class

QCanSignalDescription signal1;
signal1.setDataEndian(QSysInfo::Endian::LittleEndian);
signal1.setStartBit(0);
signal1.setBitLength(12);
// other parameters for signal1

QCanSignalDescription signal2;
signal2.setDataEndian(QSysInfo::Endian::LittleEndian);
signal2.setStartBit(12);
signal2.setBitLength(12);
// other parameters for signal2

QCanSignalDescription signal1;
signal1.setDataEndian(QSysInfo::Endian::BigEndian);
signal1.setStartBit(7);
signal1.setBitLength(12);
// other parameters for signal1

QCanSignalDescription signal2;
signal2.setDataEndian(QSysInfo::Endian::BigEndian);
signal2.setStartBit(11);
signal2.setBitLength(12);
// other parameters for signal2

physicalValue = scaling * (signalValue * factor + offset);
signalValue = (physicalValue / scaling - offset) / factor;

成员函数文档

QCanSignalDescription::QCanSignalDescription()

创建一个空的信号描述。

QCanSignalDescription::QCanSignalDescription(const QCanSignalDescription &other)

创建一个信号描述，其中包含从other 复制的值。

[constexpr noexcept default] QCanSignalDescription::QCanSignalDescription(QCanSignalDescription &&other)

通过从other 中提取信息来创建一个信号描述。

[constexpr noexcept default] QCanSignalDescription::~QCanSignalDescription()

删除此信号描述。

void QCanSignalDescription::addMultiplexSignal(const QString &name, const QCanSignalDescription::MultiplexValues &ranges)

为该信号添加一个新的多路复用器multiplexor signal 。name 参数包含多路复用器信号的名称，ranges 参数包含所需的值范围。

如果该信号已为多路复用器信号name 设置了期望值范围，则这些范围将被覆盖。

另请参阅 multiplexState()、multiplexSignals()、clearMultiplexSignals() 以及setMultiplexSignals()。

void QCanSignalDescription::addMultiplexSignal(const QString &name, const QVariant &value)

这是一个便捷的重载，适用于预期多路复用器信号仅有一个特定值（而非一组值）的情况。

参数name 包含多路复用器信号的名称，参数value 包含所需值。

如果该信号（name ）已为多路复用器信号设置了期望值范围，则这些范围将被覆盖。

另请参阅 multiplexState()、multiplexSignals()、clearMultiplexSignals() 和setMultiplexSignals()。

quint16 QCanSignalDescription::bitLength() const

返回信号值的位长度。

另请参阅 setBitLength()、startBit() 和setStartBit()。

void QCanSignalDescription::clearMultiplexSignals()

删除该信号的所有multiplexor signals 。

另请参阅 multiplexSignals()、setMultiplexSignals() 和addMultiplexSignal()。

QString QCanSignalDescription::comment() const

返回该信号的注释。

引入此参数仅用于补充说明。在信号处理过程中不会使用它。

另请参阅 setComment()。

QSysInfo::Endian QCanSignalDescription::dataEndian() const

返回信号值的数据字节序。

默认情况下，使用BigEndian 。

另请参阅 setDataEndian() 和QSysInfo::Endian 。

QtCanBus::DataFormat QCanSignalDescription::dataFormat() const

返回信号值的数据格式。

默认使用SignedInteger 。

另请参阅 setDataFormat() 和QtCanBus::DataFormat 。

QtCanBus::DataSource QCanSignalDescription::dataSource() const

返回信号值的数据源。

默认情况下，使用Payload 。

另请参阅 setDataSource() 和QtCanBus::DataSource 。

double QCanSignalDescription::factor() const

返回用于将信号值转换为物理值并反向转换的因子。

默认情况下，该函数返回qQNaN()，这意味着未使用任何因子。

Value Conversions 部分解释了该参数的使用方法。

另请参阅 setFactor()、offset() 和scaling()。

bool QCanSignalDescription::isValid() const

当信号描述有效时，返回true ；否则返回false 。

有效的信号描述必须满足以下条件：

• name() 不能为空
• bitLength == 32 如果dataFormat() 为Float
• 若dataFormat() 为== 64 ，则bitLength() 必须为Double
• 若dataFormat() 为，则 bitLength() 必须是8 的倍数AsciiString
• 则当64() 时，bitLength()必须大于0 且小于或等于 。

另请参阅 bitLength()、dataFormat() 和name()。

double QCanSignalDescription::maximum() const

返回该信号支持的最大值。

默认情况下，该函数返回qQNaN()，这意味着没有最大值。

另请参阅 setRange() 和minimum()。

double QCanSignalDescription::minimum() const

返回该信号支持的最小值。

默认情况下，该函数返回qQNaN()，这表示不存在最小值。

另请参阅 setRange() 和maximum()。

QCanSignalDescription::MultiplexSignalValues QCanSignalDescription::multiplexSignals() const

返回用于正确标识该信号的multiplexor signals 及其期望值。

返回的哈希表包含信号名称作为键，以及相应的预期值范围作为值。

只有当哈希表中的所有信号都具有预期值时，才能从有效载荷中提取该信号的值。

另请参阅 multiplexState()、clearMultiplexSignals()、setMultiplexSignals() 和addMultiplexSignal()。

QtCanBus::MultiplexState QCanSignalDescription::multiplexState() const

返回信号的多路复用状态。

有关多路复用信号的更多详细信息，请参阅Multiplexed Signals Explained 部分。

默认情况下，此方法返回None 。

另请参阅 setMultiplexState() 和QtCanBus::MultiplexState 。

QString QCanSignalDescription::name() const

返回信号的名称。

另请参见 setName() 和isValid()。

double QCanSignalDescription::offset() const

返回用于将信号值转换为物理值以及反向转换的偏移量。

默认情况下，该函数返回qQNaN()，这意味着未使用偏移量。

Value Conversions 一节说明了该参数的使用方法。

另请参阅 setOffset()、factor() 和scaling()。

QString QCanSignalDescription::physicalUnit() const

返回信号值的物理单位（例如 km/h）；如果未设置单位，则返回空字符串。

此参数仅用于补充说明，在信号处理过程中不会被使用。

另请参阅 setPhysicalUnit()。

QString QCanSignalDescription::receiver() const

返回该信号的接收节点。

引入此参数仅用于补充说明。在信号处理过程中不会使用它。

另请参阅 setReceiver()。

double QCanSignalDescription::scaling() const

返回用于将信号值转换为物理值以及反向转换的缩放因子。

默认情况下，该函数返回qQNaN()，这意味着不使用缩放。

Value Conversions 章节解释了该参数的使用方法。

另请参阅 setScaling()、offset() 和factor()。

void QCanSignalDescription::setBitLength(quint16 length)

将信号值的位长度设置为length 。

另请参阅 bitLength()、startBit() 以及setStartBit()。

void QCanSignalDescription::setComment(const QString &text)

将该信号的注释设置为text 。

引入此参数仅用于补充说明。在信号处理过程中不会使用该参数。

另请参阅 comment()。

void QCanSignalDescription::setDataEndian(QSysInfo::Endian endian)

将信号值的数据字节序设置为endian 。

另请参阅 dataEndian() 和QSysInfo::Endian 。

void QCanSignalDescription::setDataFormat(QtCanBus::DataFormat format)

将信号值的数据格式设置为format 。

另请参阅 dataFormat()和QtCanBus::DataFormat 。

void QCanSignalDescription::setDataSource(QtCanBus::DataSource source)

将信号值的数据源设置为source 。

另请参阅 dataSource() 和QtCanBus::DataSource 。

void QCanSignalDescription::setFactor(double factor)

设置用于将信号值转换为物理值，以及将物理值转换回信号值的系数，该系数为factor 。

将qQNaN()传递给此方法，可在转换过程中跳过此参数。

该系数不能为 0。尝试设置为零系数等同于将其设置为 `qQNaN()`。

Value Conversions 部分解释了该参数的使用方法。

另请参阅 factor()、setOffset() 和setScaling()。

void QCanSignalDescription::setMultiplexSignals(const QCanSignalDescription::MultiplexSignalValues &multiplexorSignals)

将此信号的multiplexor signals 设置为multiplexorSignals 。

multiplexorSignals 哈希表中必须包含信号名称作为键，以及相应的期望值范围作为值。

另请参阅 multiplexState()、multiplexSignals()、clearMultiplexSignals() 和addMultiplexSignal()。

void QCanSignalDescription::setMultiplexState(QtCanBus::MultiplexState state)

将信号的多路复用状态设置为state 。

有关多路复用信号的更多详细信息，请参阅Multiplexed Signals Explained 部分。

另请参阅 multiplexState()和QtCanBus::MultiplexState 。

void QCanSignalDescription::setName(const QString &name)

将信号名称设置为name 。

该信号的名称在同一条 CAN 消息中必须是唯一的。

另请参阅 name()。

void QCanSignalDescription::setOffset(double offset)

设置用于将信号值转换为物理值，以及再转换回offset 的偏移量。

将qQNaN()传递给此方法，可在转换过程中跳过此参数。

Value Conversions 部分解释了该参数的使用方法。

另请参阅 offset()、setFactor() 和setScaling()。

void QCanSignalDescription::setPhysicalUnit(const QString &unit)

设置信号值的物理unit （例如 km/h）。

引入此参数仅用于补充说明，在信号处理过程中不会使用该参数。

另请参阅 physicalUnit()。

void QCanSignalDescription::setRange(double minimum, double maximum)

设置信号值的minimum 和maximum 。

将其中一个或两个参数均设置为qQNaN() 表示将不使用相应的限制。

另请参阅 minimum() 和maximum()。

void QCanSignalDescription::setReceiver(const QString &receiver)

设置此信号的receiver 节点。

引入此参数仅用于补充说明。在信号处理过程中不会使用该参数。

另请参阅 receiver()。

void QCanSignalDescription::setScaling(double scaling)

设置用于将信号值转换为物理值，以及再转换回scaling 的缩放因子。

将 `qQNaN()` 传递给此方法，可在转换过程中跳过此参数。

缩放因子不能为 0。尝试将缩放因子设置为零等同于将其设置为 `qQNaN()`。

Value Conversions 部分解释了该参数的使用方法。

另请参阅 scaling()、setOffset() 和setFactor()。

void QCanSignalDescription::setStartBit(quint16 bit)

将dataSource()中信号值的起始位设置为bit 。

另请参阅 startBit()、bitLength() 和setBitLength()。

quint16 QCanSignalDescription::startBit() const

返回dataSource()中该信号值的起始位。

另请参阅 setStartBit()、bitLength() 和setBitLength()。

[noexcept] QCanSignalDescription &QCanSignalDescription::operator=(QCanSignalDescription &&other)

将other 中的值通过移动赋值方式赋给此信号描述。

QCanSignalDescription &QCanSignalDescription::operator=(const QCanSignalDescription &other)

将other 中的值分配给此信号描述。