QCanSignalDescription 类

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复制。

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

通过从other移动创建一个信号描述。

[noexcept] QCanSignalDescription::~QCanSignalDescription()

销毁此信号描述。

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

为此信号添加一个新的复用信号。参数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()

删除此信号的复用信号。

另请参阅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（不是一个数字），表示不使用系数。

有关此参数的使用请参阅 值转换 部分。

另请参阅setFactor，offset 和 scaling。

bool QCanSignalDescription::isValid() const

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

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

• 有一个非空的 name()
• 如果 dataFormat() 是 Float，则 bitLength() 应等于 32
• 如果 dataFormat() 是 Double，则 bitLength() 应等于 64
• 如果 dataFormat() 是 AsciiString，则 bitLength() 必须是 8 的倍数
• bitLength() 必须大于 0 并小于或等于 64

另请参阅bitLength，dataFormat 和 name。

double QCanSignalDescription::maximum() const

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

默认情况下，函数返回 qQNaN，表示没有最大值。

另请参阅setRange 和 minimum。

double QCanSignalDescription::minimum() const

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

默认情况下，函数返回 qQNaN，表示没有最小值。

另请参阅setRange 和 maximum。

QCanSignalDescription::MultiplexSignalValues QCanSignalDescription::multiplexSignals() const

返回用于正确识别此信号的多路复用器信号及其期望值。

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

只有当哈希表中的所有信号都具有期望的值时，才能从负载中提取此信号值。

另请参阅multiplexState，clearMultiplexSignals，setMultiplexSignals 和 addMultiplexSignal。

QtCanBus::MultiplexState QCanSignalDescription::multiplexState() const

返回信号的复用状态。

有关复用信号更详细的信息，请参阅复用信号解释部分。

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

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

QString QCanSignalDescription::name() const

返回信号的名字。

另请参阅：setName() 和 isValid。

double QCanSignalDescription::offset() const

返回用于将信号值转换成实际物理值和反向转换的偏移。

默认情况下，该函数返回qQNaN()，表示不使用偏移。

有关此参数的使用请参阅 值转换 部分。

另请参阅：setOffset()，factor() 和 scaling。

QString QCanSignalDescription::physicalUnit() const

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

此参数仅用于额外描述。在信号处理过程中不使用。

另请参阅：setPhysicalUnit。

QString QCanSignalDescription::receiver() const

返回此信号的接收节点。

此参数仅用于额外描述。在信号处理过程中不使用。

另请参阅：setReceiver。

double QCanSignalDescription::scaling() const

返回用于将信号值转换成实际物理值和反向转换的缩放比例。

默认情况下，该函数返回qQNaN()，表示不使用缩放。

有关此参数的使用请参阅 值转换 部分。

另请参阅：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。

有关此参数的使用请参阅 值转换 部分。

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

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

将此信号的多路复用器信号设置为multiplexorSignals。

multiplexorSignals 哈希必须包含信号名称作为键和相关所需值范围作为值。

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

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

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

有关复用信号更详细的信息，请参阅复用信号解释部分。

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

void QCanSignalDescription::setName(const QString &name)

将信号名称设置为name。

信号名称必须在CAN消息内部唯一。

另请参阅name。

void QCanSignalDescription::setOffset(double offset)

设置将信号值转换为物理值并返回的偏移量为offset。

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

有关此参数的使用请参阅 值转换 部分。

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

void QCanSignalDescription::setPhysicalUnit(const QString &unit)

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

此参数仅用于额外描述。在信号处理过程中不使用。

另请参阅physicalUnit。

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

设置信号值的最小值和最大值。

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

另请参阅minimum() 和 maximum).

void QCanSignalDescription::setReceiver(const QString &receiver)

设置此信号的接收器节点。

此参数仅用于额外描述。在信号处理过程中不使用。

另请参阅receiver()).

void QCanSignalDescription::setScaling(double scaling)

设置用于将信号值转换为物理值并将值转换回 缩放 的缩放。

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

缩放不能为0。尝试设置零缩放相当于设置qQNaN()).

有关此参数的使用请参阅 值转换 部分。

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

void QCanSignalDescription::setStartBit(quint16 bit)

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

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

quint16 QCanSignalDescription::startBit() const

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

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

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

将 other 的值赋给此信号描述。

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

将 other 的值移动赋值给此信号描述。